Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Comprehend.ListDocumentClassifiers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of the document classifiers that you have created.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDocumentClassifiers Source #

See: newListDocumentClassifiers smart constructor.

Constructors

ListDocumentClassifiers'
Fields nextToken :: Maybe Text Identifies the next page of results to return. filter' :: Maybe DocumentClassifierFilter Filters the jobs that are returned. You can filter jobs on their name, 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.

Instances

Instances details

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

newListDocumentClassifiers :: ListDocumentClassifiers Source #

Create a value of ListDocumentClassifiers 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:nextToken:ListDocumentClassifiers', listDocumentClassifiers_nextToken - Identifies the next page of results to return.

$sel:filter':ListDocumentClassifiers', listDocumentClassifiers_filter - Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

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

Request Lenses

listDocumentClassifiers_nextToken :: Lens' ListDocumentClassifiers (Maybe Text) Source #

Identifies the next page of results to return.

listDocumentClassifiers_filter :: Lens' ListDocumentClassifiers (Maybe DocumentClassifierFilter) Source #

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

listDocumentClassifiers_maxResults :: Lens' ListDocumentClassifiers (Maybe Natural) Source #

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

Destructuring the Response

data ListDocumentClassifiersResponse Source #

See: newListDocumentClassifiersResponse smart constructor.

Constructors

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

Instances

Instances details

Eq ListDocumentClassifiersResponse Source #
Instance details Defined in Amazonka.Comprehend.ListDocumentClassifiers Methods (==) :: ListDocumentClassifiersResponse -> ListDocumentClassifiersResponse -> Bool # (/=) :: ListDocumentClassifiersResponse -> ListDocumentClassifiersResponse -> Bool #
Show ListDocumentClassifiersResponse Source #
Instance details Defined in Amazonka.Comprehend.ListDocumentClassifiers Methods showsPrec :: Int -> ListDocumentClassifiersResponse -> ShowS # show :: ListDocumentClassifiersResponse -> String # showList :: [ListDocumentClassifiersResponse] -> ShowS #
Generic ListDocumentClassifiersResponse Source #
Instance details Defined in Amazonka.Comprehend.ListDocumentClassifiers Associated Types type Rep ListDocumentClassifiersResponse :: Type -> Type # Methods from :: ListDocumentClassifiersResponse -> Rep ListDocumentClassifiersResponse x # to :: Rep ListDocumentClassifiersResponse x -> ListDocumentClassifiersResponse #
NFData ListDocumentClassifiersResponse Source #
Instance details Defined in Amazonka.Comprehend.ListDocumentClassifiers Methods rnf :: ListDocumentClassifiersResponse -> () #
type Rep ListDocumentClassifiersResponse Source #
Instance details Defined in Amazonka.Comprehend.ListDocumentClassifiers type Rep ListDocumentClassifiersResponse = D1 ('MetaData "ListDocumentClassifiersResponse" "Amazonka.Comprehend.ListDocumentClassifiers" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListDocumentClassifiersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "documentClassifierPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentClassifierProperties])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDocumentClassifiersResponse Source #

Arguments

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

Create a value of ListDocumentClassifiersResponse 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:nextToken:ListDocumentClassifiers', listDocumentClassifiersResponse_nextToken - Identifies the next page of results to return.

$sel:documentClassifierPropertiesList:ListDocumentClassifiersResponse', listDocumentClassifiersResponse_documentClassifierPropertiesList - A list containing the properties of each job returned.

$sel:httpStatus:ListDocumentClassifiersResponse', listDocumentClassifiersResponse_httpStatus - The response's http status code.

Response Lenses

listDocumentClassifiersResponse_nextToken :: Lens' ListDocumentClassifiersResponse (Maybe Text) Source #

Identifies the next page of results to return.

listDocumentClassifiersResponse_documentClassifierPropertiesList :: Lens' ListDocumentClassifiersResponse (Maybe [DocumentClassifierProperties]) Source #

A list containing the properties of each job returned.

listDocumentClassifiersResponse_httpStatus :: Lens' ListDocumentClassifiersResponse Int Source #

The response's http status code.