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.Comprehend.ListDocumentClassificationJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of the documentation classification jobs that you have submitted.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDocumentClassificationJobs Source #

See: newListDocumentClassificationJobs smart constructor.

Constructors

ListDocumentClassificationJobs'
Fields filter' :: Maybe DocumentClassificationJobFilter Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time. maxResults :: Maybe Natural The maximum number of results to return in each page. The default is 100. nextToken :: Maybe Text Identifies the next page of results to return.

Instances

Instances details

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

newListDocumentClassificationJobs :: ListDocumentClassificationJobs Source #

Create a value of ListDocumentClassificationJobs 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:filter':ListDocumentClassificationJobs', listDocumentClassificationJobs_filter - Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

$sel:maxResults:ListDocumentClassificationJobs', listDocumentClassificationJobs_maxResults - The maximum number of results to return in each page. The default is 100.

ListDocumentClassificationJobs, listDocumentClassificationJobs_nextToken - Identifies the next page of results to return.

Request Lenses

listDocumentClassificationJobs_filter :: Lens' ListDocumentClassificationJobs (Maybe DocumentClassificationJobFilter) Source #

Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

listDocumentClassificationJobs_maxResults :: Lens' ListDocumentClassificationJobs (Maybe Natural) Source #

The maximum number of results to return in each page. The default is 100.

listDocumentClassificationJobs_nextToken :: Lens' ListDocumentClassificationJobs (Maybe Text) Source #

Identifies the next page of results to return.

Destructuring the Response

data ListDocumentClassificationJobsResponse Source #

See: newListDocumentClassificationJobsResponse smart constructor.

Constructors

ListDocumentClassificationJobsResponse'
Fields documentClassificationJobPropertiesList :: Maybe [DocumentClassificationJobProperties] A list containing the properties of each job returned. nextToken :: Maybe Text Identifies the next page of results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListDocumentClassificationJobsResponse Source #

Arguments

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

Create a value of ListDocumentClassificationJobsResponse 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:documentClassificationJobPropertiesList:ListDocumentClassificationJobsResponse', listDocumentClassificationJobsResponse_documentClassificationJobPropertiesList - A list containing the properties of each job returned.

ListDocumentClassificationJobs, listDocumentClassificationJobsResponse_nextToken - Identifies the next page of results to return.

$sel:httpStatus:ListDocumentClassificationJobsResponse', listDocumentClassificationJobsResponse_httpStatus - The response's http status code.

Response Lenses

listDocumentClassificationJobsResponse_documentClassificationJobPropertiesList :: Lens' ListDocumentClassificationJobsResponse (Maybe [DocumentClassificationJobProperties]) Source #

A list containing the properties of each job returned.

listDocumentClassificationJobsResponse_nextToken :: Lens' ListDocumentClassificationJobsResponse (Maybe Text) Source #

Identifies the next page of results to return.

listDocumentClassificationJobsResponse_httpStatus :: Lens' ListDocumentClassificationJobsResponse Int Source #

The response's http status code.