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.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 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. nextToken :: Maybe Text Identifies the next page of results to return.

Instances

Instances details

ToJSON ListEntityRecognizers Source #
Instance details Defined in Amazonka.Comprehend.ListEntityRecognizers Methods toJSON :: ListEntityRecognizers -> Value # toEncoding :: ListEntityRecognizers -> Encoding # toJSONList :: [ListEntityRecognizers] -> Value # toEncodingList :: [ListEntityRecognizers] -> Encoding #
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 #
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 :: (Service -> Service) -> ListEntityRecognizers -> Request ListEntityRecognizers # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListEntityRecognizers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListEntityRecognizers))) #
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 #
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 #
NFData ListEntityRecognizers Source #
Instance details Defined in Amazonka.Comprehend.ListEntityRecognizers Methods rnf :: ListEntityRecognizers -> () #
Eq ListEntityRecognizers Source #
Instance details Defined in Amazonka.Comprehend.ListEntityRecognizers Methods (==) :: ListEntityRecognizers -> ListEntityRecognizers -> Bool # (/=) :: ListEntityRecognizers -> ListEntityRecognizers -> Bool #
Hashable ListEntityRecognizers Source #
Instance details Defined in Amazonka.Comprehend.ListEntityRecognizers Methods hashWithSalt :: Int -> ListEntityRecognizers -> Int # hash :: ListEntityRecognizers -> Int #
type AWSResponse ListEntityRecognizers Source #
Instance details Defined in Amazonka.Comprehend.ListEntityRecognizers type AWSResponse ListEntityRecognizers = ListEntityRecognizersResponse
type Rep ListEntityRecognizers Source #
Instance details Defined in Amazonka.Comprehend.ListEntityRecognizers type Rep ListEntityRecognizers = D1 ('MetaData "ListEntityRecognizers" "Amazonka.Comprehend.ListEntityRecognizers" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "ListEntityRecognizers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityRecognizerFilter)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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

ListEntityRecognizers, listEntityRecognizers_nextToken - Identifies the next page of results to return.

Request Lenses

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.

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

Identifies the next page of results to return.

Destructuring the Response

data ListEntityRecognizersResponse Source #

See: newListEntityRecognizersResponse smart constructor.

Constructors

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

Instances

Instances details

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 #
Show ListEntityRecognizersResponse Source #
Instance details Defined in Amazonka.Comprehend.ListEntityRecognizers Methods showsPrec :: Int -> ListEntityRecognizersResponse -> ShowS # show :: ListEntityRecognizersResponse -> String # showList :: [ListEntityRecognizersResponse] -> ShowS #
NFData ListEntityRecognizersResponse Source #
Instance details Defined in Amazonka.Comprehend.ListEntityRecognizers Methods rnf :: ListEntityRecognizersResponse -> () #
Eq ListEntityRecognizersResponse Source #
Instance details Defined in Amazonka.Comprehend.ListEntityRecognizers Methods (==) :: ListEntityRecognizersResponse -> ListEntityRecognizersResponse -> Bool # (/=) :: ListEntityRecognizersResponse -> ListEntityRecognizersResponse -> Bool #
type Rep ListEntityRecognizersResponse Source #
Instance details Defined in Amazonka.Comprehend.ListEntityRecognizers type Rep ListEntityRecognizersResponse = D1 ('MetaData "ListEntityRecognizersResponse" "Amazonka.Comprehend.ListEntityRecognizers" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "ListEntityRecognizersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityRecognizerPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntityRecognizerProperties])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:entityRecognizerPropertiesList:ListEntityRecognizersResponse', listEntityRecognizersResponse_entityRecognizerPropertiesList - The list of properties of an entity recognizer.

ListEntityRecognizers, listEntityRecognizersResponse_nextToken - Identifies the next page of results to return.

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

Response Lenses

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

The list of properties of an entity recognizer.

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

Identifies the next page of results to return.

listEntityRecognizersResponse_httpStatus :: Lens' ListEntityRecognizersResponse Int Source #

The response's http status code.