amazonka-comprehend-2.0: Amazon Comprehend SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Comprehend.ListDocumentClassificationJobs

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

Instances

Instances details
ToJSON ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

ToHeaders ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

ToPath ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

ToQuery ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

AWSPager ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

AWSRequest ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Generic ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Associated Types

type Rep ListDocumentClassificationJobs :: Type -> Type #

Read ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Show ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

NFData ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Eq ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Hashable ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

type AWSResponse ListDocumentClassificationJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

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.

Destructuring the Response

data ListDocumentClassificationJobsResponse Source #

Constructors

ListDocumentClassificationJobsResponse' 

Fields

Instances

Instances details
Generic ListDocumentClassificationJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Read ListDocumentClassificationJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Show ListDocumentClassificationJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

NFData ListDocumentClassificationJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

Eq ListDocumentClassificationJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListDocumentClassificationJobs

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 #

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