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.ListLabelingJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of labeling jobs.

This operation returns paginated results.

Synopsis

data ListLabelingJobs = ListLabelingJobs' {
- 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 LabelingJobStatus
}
newListLabelingJobs :: ListLabelingJobs
listLabelingJobs_creationTimeAfter :: Lens' ListLabelingJobs (Maybe UTCTime)
listLabelingJobs_creationTimeBefore :: Lens' ListLabelingJobs (Maybe UTCTime)
listLabelingJobs_lastModifiedTimeAfter :: Lens' ListLabelingJobs (Maybe UTCTime)
listLabelingJobs_lastModifiedTimeBefore :: Lens' ListLabelingJobs (Maybe UTCTime)
listLabelingJobs_maxResults :: Lens' ListLabelingJobs (Maybe Natural)
listLabelingJobs_nameContains :: Lens' ListLabelingJobs (Maybe Text)
listLabelingJobs_nextToken :: Lens' ListLabelingJobs (Maybe Text)
listLabelingJobs_sortBy :: Lens' ListLabelingJobs (Maybe SortBy)
listLabelingJobs_sortOrder :: Lens' ListLabelingJobs (Maybe SortOrder)
listLabelingJobs_statusEquals :: Lens' ListLabelingJobs (Maybe LabelingJobStatus)
data ListLabelingJobsResponse = ListLabelingJobsResponse' {
- labelingJobSummaryList :: Maybe [LabelingJobSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListLabelingJobsResponse :: Int -> ListLabelingJobsResponse
listLabelingJobsResponse_labelingJobSummaryList :: Lens' ListLabelingJobsResponse (Maybe [LabelingJobSummary])
listLabelingJobsResponse_nextToken :: Lens' ListLabelingJobsResponse (Maybe Text)
listLabelingJobsResponse_httpStatus :: Lens' ListLabelingJobsResponse Int

Creating a Request

data ListLabelingJobs Source #

See: newListLabelingJobs smart constructor.

Constructors

ListLabelingJobs'

Fields

creationTimeAfter :: Maybe POSIX
A filter that returns only labeling jobs created after the specified time (timestamp).
creationTimeBefore :: Maybe POSIX
A filter that returns only labeling jobs created before the specified time (timestamp).
lastModifiedTimeAfter :: Maybe POSIX
A filter that returns only labeling jobs modified after the specified time (timestamp).
lastModifiedTimeBefore :: Maybe POSIX
A filter that returns only labeling jobs modified before the specified time (timestamp).
maxResults :: Maybe Natural
The maximum number of labeling jobs to return in each page of the response.
nameContains :: Maybe Text
A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.
nextToken :: Maybe Text
If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling 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 LabelingJobStatus
A filter that retrieves only labeling jobs with a specific status.

Instances

Instances details

ToJSON ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs Methods toJSON :: ListLabelingJobs -> Value # toEncoding :: ListLabelingJobs -> Encoding # toJSONList :: [ListLabelingJobs] -> Value # toEncodingList :: [ListLabelingJobs] -> Encoding #
ToHeaders ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs Methods toHeaders :: ListLabelingJobs -> [Header] #
ToPath ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs Methods toPath :: ListLabelingJobs -> ByteString #
ToQuery ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs Methods toQuery :: ListLabelingJobs -> QueryString #
AWSPager ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs Methods page :: ListLabelingJobs -> AWSResponse ListLabelingJobs -> Maybe ListLabelingJobs #
AWSRequest ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs Associated Types type AWSResponse ListLabelingJobs # Methods request :: (Service -> Service) -> ListLabelingJobs -> Request ListLabelingJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListLabelingJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListLabelingJobs))) #
Generic ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs Associated Types type Rep ListLabelingJobs :: Type -> Type # Methods from :: ListLabelingJobs -> Rep ListLabelingJobs x # to :: Rep ListLabelingJobs x -> ListLabelingJobs #
Read ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs Methods readsPrec :: Int -> ReadS ListLabelingJobs # readList :: ReadS [ListLabelingJobs] # readPrec :: ReadPrec ListLabelingJobs # readListPrec :: ReadPrec [ListLabelingJobs] #
Show ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs Methods showsPrec :: Int -> ListLabelingJobs -> ShowS # show :: ListLabelingJobs -> String # showList :: [ListLabelingJobs] -> ShowS #
NFData ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs Methods rnf :: ListLabelingJobs -> () #
Eq ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs Methods (==) :: ListLabelingJobs -> ListLabelingJobs -> Bool # (/=) :: ListLabelingJobs -> ListLabelingJobs -> Bool #
Hashable ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs Methods hashWithSalt :: Int -> ListLabelingJobs -> Int # hash :: ListLabelingJobs -> Int #
type AWSResponse ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs type AWSResponse ListLabelingJobs = ListLabelingJobsResponse
type Rep ListLabelingJobs Source #
Instance details Defined in Amazonka.SageMaker.ListLabelingJobs type Rep ListLabelingJobs = D1 ('MetaData "ListLabelingJobs" "Amazonka.SageMaker.ListLabelingJobs" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListLabelingJobs'" '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 LabelingJobStatus)))))))

newListLabelingJobs :: ListLabelingJobs Source #

Create a value of ListLabelingJobs 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:ListLabelingJobs', listLabelingJobs_creationTimeAfter - A filter that returns only labeling jobs created after the specified time (timestamp).

$sel:creationTimeBefore:ListLabelingJobs', listLabelingJobs_creationTimeBefore - A filter that returns only labeling jobs created before the specified time (timestamp).

$sel:lastModifiedTimeAfter:ListLabelingJobs', listLabelingJobs_lastModifiedTimeAfter - A filter that returns only labeling jobs modified after the specified time (timestamp).

$sel:lastModifiedTimeBefore:ListLabelingJobs', listLabelingJobs_lastModifiedTimeBefore - A filter that returns only labeling jobs modified before the specified time (timestamp).

$sel:maxResults:ListLabelingJobs', listLabelingJobs_maxResults - The maximum number of labeling jobs to return in each page of the response.

$sel:nameContains:ListLabelingJobs', listLabelingJobs_nameContains - A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

ListLabelingJobs, listLabelingJobs_nextToken - If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

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

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

$sel:statusEquals:ListLabelingJobs', listLabelingJobs_statusEquals - A filter that retrieves only labeling jobs with a specific status.

Request Lenses

listLabelingJobs_creationTimeAfter :: Lens' ListLabelingJobs (Maybe UTCTime) Source #

A filter that returns only labeling jobs created after the specified time (timestamp).

listLabelingJobs_creationTimeBefore :: Lens' ListLabelingJobs (Maybe UTCTime) Source #

A filter that returns only labeling jobs created before the specified time (timestamp).

listLabelingJobs_lastModifiedTimeAfter :: Lens' ListLabelingJobs (Maybe UTCTime) Source #

A filter that returns only labeling jobs modified after the specified time (timestamp).

listLabelingJobs_lastModifiedTimeBefore :: Lens' ListLabelingJobs (Maybe UTCTime) Source #

A filter that returns only labeling jobs modified before the specified time (timestamp).

listLabelingJobs_maxResults :: Lens' ListLabelingJobs (Maybe Natural) Source #

The maximum number of labeling jobs to return in each page of the response.

listLabelingJobs_nameContains :: Lens' ListLabelingJobs (Maybe Text) Source #

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

listLabelingJobs_nextToken :: Lens' ListLabelingJobs (Maybe Text) Source #

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

listLabelingJobs_sortBy :: Lens' ListLabelingJobs (Maybe SortBy) Source #

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

listLabelingJobs_sortOrder :: Lens' ListLabelingJobs (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listLabelingJobs_statusEquals :: Lens' ListLabelingJobs (Maybe LabelingJobStatus) Source #

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

Destructuring the Response

data ListLabelingJobsResponse Source #

See: newListLabelingJobsResponse smart constructor.

Constructors

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

Instances

Instances details

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

newListLabelingJobsResponse Source #

Arguments

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

Create a value of ListLabelingJobsResponse 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:labelingJobSummaryList:ListLabelingJobsResponse', listLabelingJobsResponse_labelingJobSummaryList - An array of LabelingJobSummary objects, each describing a labeling job.

ListLabelingJobs, listLabelingJobsResponse_nextToken - If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

$sel:httpStatus:ListLabelingJobsResponse', listLabelingJobsResponse_httpStatus - The response's http status code.

Response Lenses

listLabelingJobsResponse_labelingJobSummaryList :: Lens' ListLabelingJobsResponse (Maybe [LabelingJobSummary]) Source #

An array of LabelingJobSummary objects, each describing a labeling job.

listLabelingJobsResponse_nextToken :: Lens' ListLabelingJobsResponse (Maybe Text) Source #

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

listLabelingJobsResponse_httpStatus :: Lens' ListLabelingJobsResponse Int Source #

The response's http status code.