Amazonka.Comprehend.ListDocumentClassifiers

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

This operation returns paginated results.

Creating a Request

data ListDocumentClassifiers

See: newListDocumentClassifiers smart constructor.

Constructors

ListDocumentClassifiers'

Fields

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

• nextToken :: Maybe Text

  Identifies the next page of results to return.

Instances

ToJSON ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

toJSON :: ListDocumentClassifiers -> Value

toEncoding :: ListDocumentClassifiers -> Encoding

toJSONList :: [ListDocumentClassifiers] -> Value

toEncodingList :: [ListDocumentClassifiers] -> Encoding

ToHeaders ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

toHeaders :: ListDocumentClassifiers -> [Header]

ToPath ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

toPath :: ListDocumentClassifiers -> ByteString

ToQuery ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

toQuery :: ListDocumentClassifiers -> QueryString

AWSPager ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

page :: ListDocumentClassifiers -> AWSResponse ListDocumentClassifiers -> Maybe ListDocumentClassifiers

AWSRequest ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Associated Types

type AWSResponse ListDocumentClassifiers

Methods

request :: (Service -> Service) -> ListDocumentClassifiers -> Request ListDocumentClassifiers

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDocumentClassifiers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDocumentClassifiers)))

Generic ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Associated Types

type Rep ListDocumentClassifiers :: Type -> Type

Methods

from :: ListDocumentClassifiers -> Rep ListDocumentClassifiers x

to :: Rep ListDocumentClassifiers x -> ListDocumentClassifiers

Read ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

readsPrec :: Int -> ReadS ListDocumentClassifiers

readList :: ReadS [ListDocumentClassifiers]

readPrec :: ReadPrec ListDocumentClassifiers

readListPrec :: ReadPrec [ListDocumentClassifiers]

Show ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

showsPrec :: Int -> ListDocumentClassifiers -> ShowS

show :: ListDocumentClassifiers -> String

showList :: [ListDocumentClassifiers] -> ShowS

NFData ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

rnf :: ListDocumentClassifiers -> ()

Eq ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

(==) :: ListDocumentClassifiers -> ListDocumentClassifiers -> Bool

(/=) :: ListDocumentClassifiers -> ListDocumentClassifiers -> Bool

Hashable ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

hashWithSalt :: Int -> ListDocumentClassifiers -> Int

hash :: ListDocumentClassifiers -> Int

type AWSResponse ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

type AWSResponse ListDocumentClassifiers = ListDocumentClassifiersResponse

type Rep ListDocumentClassifiers

Defined in Amazonka.Comprehend.ListDocumentClassifiers

type Rep ListDocumentClassifiers = D1 ('MetaData "ListDocumentClassifiers" "Amazonka.Comprehend.ListDocumentClassifiers" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "ListDocumentClassifiers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierFilter)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListDocumentClassifiers :: ListDocumentClassifiers

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

ListDocumentClassifiers, listDocumentClassifiers_nextToken - Identifies the next page of results to return.

Request Lenses

listDocumentClassifiers_filter :: Lens' ListDocumentClassifiers (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.

listDocumentClassifiers_maxResults :: Lens' ListDocumentClassifiers (Maybe Natural)

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

listDocumentClassifiers_nextToken :: Lens' ListDocumentClassifiers (Maybe Text)

Identifies the next page of results to return.

Destructuring the Response

data ListDocumentClassifiersResponse

See: newListDocumentClassifiersResponse smart constructor.

Constructors

ListDocumentClassifiersResponse'

Fields

• documentClassifierPropertiesList :: Maybe [DocumentClassifierProperties]

  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

Generic ListDocumentClassifiersResponse

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Associated Types

type Rep ListDocumentClassifiersResponse :: Type -> Type

Methods

from :: ListDocumentClassifiersResponse -> Rep ListDocumentClassifiersResponse x

to :: Rep ListDocumentClassifiersResponse x -> ListDocumentClassifiersResponse

Show ListDocumentClassifiersResponse

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

showsPrec :: Int -> ListDocumentClassifiersResponse -> ShowS

show :: ListDocumentClassifiersResponse -> String

showList :: [ListDocumentClassifiersResponse] -> ShowS

NFData ListDocumentClassifiersResponse

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

rnf :: ListDocumentClassifiersResponse -> ()

Eq ListDocumentClassifiersResponse

Defined in Amazonka.Comprehend.ListDocumentClassifiers

Methods

(==) :: ListDocumentClassifiersResponse -> ListDocumentClassifiersResponse -> Bool

(/=) :: ListDocumentClassifiersResponse -> ListDocumentClassifiersResponse -> Bool

type Rep ListDocumentClassifiersResponse

Defined in Amazonka.Comprehend.ListDocumentClassifiers

type Rep ListDocumentClassifiersResponse = D1 ('MetaData "ListDocumentClassifiersResponse" "Amazonka.Comprehend.ListDocumentClassifiers" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "ListDocumentClassifiersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentClassifierPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentClassifierProperties])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDocumentClassifiersResponse

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:documentClassifierPropertiesList:ListDocumentClassifiersResponse', listDocumentClassifiersResponse_documentClassifierPropertiesList - A list containing the properties of each job returned.

ListDocumentClassifiers, listDocumentClassifiersResponse_nextToken - Identifies the next page of results to return.

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

Response Lenses

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

A list containing the properties of each job returned.

listDocumentClassifiersResponse_nextToken :: Lens' ListDocumentClassifiersResponse (Maybe Text)

Identifies the next page of results to return.

listDocumentClassifiersResponse_httpStatus :: Lens' ListDocumentClassifiersResponse Int

The response's http status code.