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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.

The results of this list are not in any particular order. Please get the list and sort locally if needed.

This operation returns paginated results.

Synopsis

Creating a Request

data ListEntityRecognizers Source #

See: newListEntityRecognizers smart constructor.

Constructors

ListEntityRecognizers'
Fields nextToken :: Maybe Text Identifies the next page of results to return. filter' :: Maybe EntityRecognizerFilter Filters the list of entities returned. You can filter on `Status`, `SubmitTimeBefore`, or `SubmitTimeAfter`. You can only set one filter at a time. maxResults :: Maybe Natural The maximum number of results to return on each page. The default is 100.

Instances

Instances details

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

newListEntityRecognizers :: ListEntityRecognizers Source #

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

$sel:filter':ListEntityRecognizers', listEntityRecognizers_filter - Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.

$sel:maxResults:ListEntityRecognizers', listEntityRecognizers_maxResults - The maximum number of results to return on each page. The default is 100.

Request Lenses

listEntityRecognizers_nextToken :: Lens' ListEntityRecognizers (Maybe Text) Source #

Identifies the next page of results to return.

listEntityRecognizers_filter :: Lens' ListEntityRecognizers (Maybe EntityRecognizerFilter) Source #

Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.

listEntityRecognizers_maxResults :: Lens' ListEntityRecognizers (Maybe Natural) Source #

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

Destructuring the Response

data ListEntityRecognizersResponse Source #

See: newListEntityRecognizersResponse smart constructor.

Constructors

ListEntityRecognizersResponse'
Fields nextToken :: Maybe Text Identifies the next page of results to return. entityRecognizerPropertiesList :: Maybe [EntityRecognizerProperties] The list of properties of an entity recognizer. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListEntityRecognizersResponse Source #

Arguments

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

Create a value of ListEntityRecognizersResponse 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:ListEntityRecognizers', listEntityRecognizersResponse_nextToken - Identifies the next page of results to return.

$sel:entityRecognizerPropertiesList:ListEntityRecognizersResponse', listEntityRecognizersResponse_entityRecognizerPropertiesList - The list of properties of an entity recognizer.

$sel:httpStatus:ListEntityRecognizersResponse', listEntityRecognizersResponse_httpStatus - The response's http status code.

Response Lenses

listEntityRecognizersResponse_nextToken :: Lens' ListEntityRecognizersResponse (Maybe Text) Source #

Identifies the next page of results to return.

listEntityRecognizersResponse_entityRecognizerPropertiesList :: Lens' ListEntityRecognizersResponse (Maybe [EntityRecognizerProperties]) Source #

The list of properties of an entity recognizer.

listEntityRecognizersResponse_httpStatus :: Lens' ListEntityRecognizersResponse Int Source #

The response's http status code.