Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.ListProcessingJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists processing jobs that satisfy various filters.

This operation returns paginated results.

Synopsis

data ListProcessingJobs = ListProcessingJobs' {
- creationTimeAfter :: Maybe POSIX
- creationTimeBefore :: Maybe POSIX
- lastModifiedTimeAfter :: Maybe POSIX
- lastModifiedTimeBefore :: Maybe POSIX
- maxResults :: Maybe Natural
- nameContains :: Maybe Text
- nextToken :: Maybe Text
- sortBy :: Maybe SortBy
- sortOrder :: Maybe SortOrder
- statusEquals :: Maybe ProcessingJobStatus
}
newListProcessingJobs :: ListProcessingJobs
listProcessingJobs_creationTimeAfter :: Lens' ListProcessingJobs (Maybe UTCTime)
listProcessingJobs_creationTimeBefore :: Lens' ListProcessingJobs (Maybe UTCTime)
listProcessingJobs_lastModifiedTimeAfter :: Lens' ListProcessingJobs (Maybe UTCTime)
listProcessingJobs_lastModifiedTimeBefore :: Lens' ListProcessingJobs (Maybe UTCTime)
listProcessingJobs_maxResults :: Lens' ListProcessingJobs (Maybe Natural)
listProcessingJobs_nameContains :: Lens' ListProcessingJobs (Maybe Text)
listProcessingJobs_nextToken :: Lens' ListProcessingJobs (Maybe Text)
listProcessingJobs_sortBy :: Lens' ListProcessingJobs (Maybe SortBy)
listProcessingJobs_sortOrder :: Lens' ListProcessingJobs (Maybe SortOrder)
listProcessingJobs_statusEquals :: Lens' ListProcessingJobs (Maybe ProcessingJobStatus)
data ListProcessingJobsResponse = ListProcessingJobsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- processingJobSummaries :: [ProcessingJobSummary]
}
newListProcessingJobsResponse :: Int -> ListProcessingJobsResponse
listProcessingJobsResponse_nextToken :: Lens' ListProcessingJobsResponse (Maybe Text)
listProcessingJobsResponse_httpStatus :: Lens' ListProcessingJobsResponse Int
listProcessingJobsResponse_processingJobSummaries :: Lens' ListProcessingJobsResponse [ProcessingJobSummary]

Creating a Request

data ListProcessingJobs Source #

See: newListProcessingJobs smart constructor.

Constructors

ListProcessingJobs'

Fields

creationTimeAfter :: Maybe POSIX
A filter that returns only processing jobs created after the specified time.
creationTimeBefore :: Maybe POSIX
A filter that returns only processing jobs created after the specified time.
lastModifiedTimeAfter :: Maybe POSIX
A filter that returns only processing jobs modified after the specified time.
lastModifiedTimeBefore :: Maybe POSIX
A filter that returns only processing jobs modified before the specified time.
maxResults :: Maybe Natural
The maximum number of processing jobs to return in the response.
nameContains :: Maybe Text
A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.
nextToken :: Maybe Text
If the result of the previous ListProcessingJobs request was truncated, the response includes a NextToken. To retrieve the next set of processing jobs, use the token in the next request.
sortBy :: Maybe SortBy
The field to sort results by. The default is CreationTime.
sortOrder :: Maybe SortOrder
The sort order for results. The default is Ascending.
statusEquals :: Maybe ProcessingJobStatus
A filter that retrieves only processing jobs with a specific status.

Instances

Instances details

ToJSON ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods toJSON :: ListProcessingJobs -> Value # toEncoding :: ListProcessingJobs -> Encoding # toJSONList :: [ListProcessingJobs] -> Value # toEncodingList :: [ListProcessingJobs] -> Encoding #
ToHeaders ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods toHeaders :: ListProcessingJobs -> [Header] #
ToPath ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods toPath :: ListProcessingJobs -> ByteString #
ToQuery ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods toQuery :: ListProcessingJobs -> QueryString #
AWSPager ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods page :: ListProcessingJobs -> AWSResponse ListProcessingJobs -> Maybe ListProcessingJobs #
AWSRequest ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Associated Types type AWSResponse ListProcessingJobs # Methods request :: (Service -> Service) -> ListProcessingJobs -> Request ListProcessingJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListProcessingJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListProcessingJobs))) #
Generic ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Associated Types type Rep ListProcessingJobs :: Type -> Type # Methods from :: ListProcessingJobs -> Rep ListProcessingJobs x # to :: Rep ListProcessingJobs x -> ListProcessingJobs #
Read ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods readsPrec :: Int -> ReadS ListProcessingJobs # readList :: ReadS [ListProcessingJobs] # readPrec :: ReadPrec ListProcessingJobs # readListPrec :: ReadPrec [ListProcessingJobs] #
Show ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods showsPrec :: Int -> ListProcessingJobs -> ShowS # show :: ListProcessingJobs -> String # showList :: [ListProcessingJobs] -> ShowS #
NFData ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods rnf :: ListProcessingJobs -> () #
Eq ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods (==) :: ListProcessingJobs -> ListProcessingJobs -> Bool # (/=) :: ListProcessingJobs -> ListProcessingJobs -> Bool #
Hashable ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods hashWithSalt :: Int -> ListProcessingJobs -> Int # hash :: ListProcessingJobs -> Int #
type AWSResponse ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs type AWSResponse ListProcessingJobs = ListProcessingJobsResponse
type Rep ListProcessingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs type Rep ListProcessingJobs = D1 ('MetaData "ListProcessingJobs" "Amazonka.SageMaker.ListProcessingJobs" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListProcessingJobs'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "creationTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "lastModifiedTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "lastModifiedTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: ((S1 ('MetaSel ('Just "nameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortBy)) :: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :*: S1 ('MetaSel ('Just "statusEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingJobStatus)))))))

newListProcessingJobs :: ListProcessingJobs Source #

Create a value of ListProcessingJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTimeAfter:ListProcessingJobs', listProcessingJobs_creationTimeAfter - A filter that returns only processing jobs created after the specified time.

$sel:creationTimeBefore:ListProcessingJobs', listProcessingJobs_creationTimeBefore - A filter that returns only processing jobs created after the specified time.

$sel:lastModifiedTimeAfter:ListProcessingJobs', listProcessingJobs_lastModifiedTimeAfter - A filter that returns only processing jobs modified after the specified time.

$sel:lastModifiedTimeBefore:ListProcessingJobs', listProcessingJobs_lastModifiedTimeBefore - A filter that returns only processing jobs modified before the specified time.

$sel:maxResults:ListProcessingJobs', listProcessingJobs_maxResults - The maximum number of processing jobs to return in the response.

$sel:nameContains:ListProcessingJobs', listProcessingJobs_nameContains - A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.

ListProcessingJobs, listProcessingJobs_nextToken - If the result of the previous ListProcessingJobs request was truncated, the response includes a NextToken. To retrieve the next set of processing jobs, use the token in the next request.

$sel:sortBy:ListProcessingJobs', listProcessingJobs_sortBy - The field to sort results by. The default is CreationTime.

$sel:sortOrder:ListProcessingJobs', listProcessingJobs_sortOrder - The sort order for results. The default is Ascending.

$sel:statusEquals:ListProcessingJobs', listProcessingJobs_statusEquals - A filter that retrieves only processing jobs with a specific status.

Request Lenses

listProcessingJobs_creationTimeAfter :: Lens' ListProcessingJobs (Maybe UTCTime) Source #

A filter that returns only processing jobs created after the specified time.

listProcessingJobs_creationTimeBefore :: Lens' ListProcessingJobs (Maybe UTCTime) Source #

A filter that returns only processing jobs created after the specified time.

listProcessingJobs_lastModifiedTimeAfter :: Lens' ListProcessingJobs (Maybe UTCTime) Source #

A filter that returns only processing jobs modified after the specified time.

listProcessingJobs_lastModifiedTimeBefore :: Lens' ListProcessingJobs (Maybe UTCTime) Source #

A filter that returns only processing jobs modified before the specified time.

listProcessingJobs_maxResults :: Lens' ListProcessingJobs (Maybe Natural) Source #

The maximum number of processing jobs to return in the response.

listProcessingJobs_nameContains :: Lens' ListProcessingJobs (Maybe Text) Source #

A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.

listProcessingJobs_nextToken :: Lens' ListProcessingJobs (Maybe Text) Source #

If the result of the previous ListProcessingJobs request was truncated, the response includes a NextToken. To retrieve the next set of processing jobs, use the token in the next request.

listProcessingJobs_sortBy :: Lens' ListProcessingJobs (Maybe SortBy) Source #

The field to sort results by. The default is CreationTime.

listProcessingJobs_sortOrder :: Lens' ListProcessingJobs (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listProcessingJobs_statusEquals :: Lens' ListProcessingJobs (Maybe ProcessingJobStatus) Source #

A filter that retrieves only processing jobs with a specific status.

Destructuring the Response

data ListProcessingJobsResponse Source #

See: newListProcessingJobsResponse smart constructor.

Constructors

ListProcessingJobsResponse'
Fields nextToken :: Maybe Text If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request. httpStatus :: Int The response's http status code. processingJobSummaries :: [ProcessingJobSummary] An array of `ProcessingJobSummary` objects, each listing a processing job.

Instances

Instances details

Generic ListProcessingJobsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Associated Types type Rep ListProcessingJobsResponse :: Type -> Type # Methods from :: ListProcessingJobsResponse -> Rep ListProcessingJobsResponse x # to :: Rep ListProcessingJobsResponse x -> ListProcessingJobsResponse #
Read ListProcessingJobsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods readsPrec :: Int -> ReadS ListProcessingJobsResponse # readList :: ReadS [ListProcessingJobsResponse] # readPrec :: ReadPrec ListProcessingJobsResponse # readListPrec :: ReadPrec [ListProcessingJobsResponse] #
Show ListProcessingJobsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods showsPrec :: Int -> ListProcessingJobsResponse -> ShowS # show :: ListProcessingJobsResponse -> String # showList :: [ListProcessingJobsResponse] -> ShowS #
NFData ListProcessingJobsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods rnf :: ListProcessingJobsResponse -> () #
Eq ListProcessingJobsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs Methods (==) :: ListProcessingJobsResponse -> ListProcessingJobsResponse -> Bool # (/=) :: ListProcessingJobsResponse -> ListProcessingJobsResponse -> Bool #
type Rep ListProcessingJobsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListProcessingJobs type Rep ListProcessingJobsResponse = D1 ('MetaData "ListProcessingJobsResponse" "Amazonka.SageMaker.ListProcessingJobs" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListProcessingJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "processingJobSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ProcessingJobSummary]))))

newListProcessingJobsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListProcessingJobsResponse'`
-> ListProcessingJobsResponse

Create a value of ListProcessingJobsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListProcessingJobs, listProcessingJobsResponse_nextToken - If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.

$sel:httpStatus:ListProcessingJobsResponse', listProcessingJobsResponse_httpStatus - The response's http status code.

$sel:processingJobSummaries:ListProcessingJobsResponse', listProcessingJobsResponse_processingJobSummaries - An array of ProcessingJobSummary objects, each listing a processing job.

Response Lenses

listProcessingJobsResponse_nextToken :: Lens' ListProcessingJobsResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.

listProcessingJobsResponse_httpStatus :: Lens' ListProcessingJobsResponse Int Source #

The response's http status code.

listProcessingJobsResponse_processingJobSummaries :: Lens' ListProcessingJobsResponse [ProcessingJobSummary] Source #

An array of ProcessingJobSummary objects, each listing a processing job.