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.LexV2Models.ListIntents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get a list of intents that meet the specified criteria.

Synopsis

data ListIntents = ListIntents' {
- filters :: Maybe (NonEmpty IntentFilter)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe IntentSortBy
- botId :: Text
- botVersion :: Text
- localeId :: Text
}
newListIntents :: Text -> Text -> Text -> ListIntents
listIntents_filters :: Lens' ListIntents (Maybe (NonEmpty IntentFilter))
listIntents_maxResults :: Lens' ListIntents (Maybe Natural)
listIntents_nextToken :: Lens' ListIntents (Maybe Text)
listIntents_sortBy :: Lens' ListIntents (Maybe IntentSortBy)
listIntents_botId :: Lens' ListIntents Text
listIntents_botVersion :: Lens' ListIntents Text
listIntents_localeId :: Lens' ListIntents Text
data ListIntentsResponse = ListIntentsResponse' {
- botId :: Maybe Text
- botVersion :: Maybe Text
- intentSummaries :: Maybe [IntentSummary]
- localeId :: Maybe Text
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListIntentsResponse :: Int -> ListIntentsResponse
listIntentsResponse_botId :: Lens' ListIntentsResponse (Maybe Text)
listIntentsResponse_botVersion :: Lens' ListIntentsResponse (Maybe Text)
listIntentsResponse_intentSummaries :: Lens' ListIntentsResponse (Maybe [IntentSummary])
listIntentsResponse_localeId :: Lens' ListIntentsResponse (Maybe Text)
listIntentsResponse_nextToken :: Lens' ListIntentsResponse (Maybe Text)
listIntentsResponse_httpStatus :: Lens' ListIntentsResponse Int

Creating a Request

data ListIntents Source #

See: newListIntents smart constructor.

Constructors

ListIntents'

Fields

filters :: Maybe (NonEmpty IntentFilter)
Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
maxResults :: Maybe Natural
The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken :: Maybe Text
If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.
sortBy :: Maybe IntentSortBy
Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.
botId :: Text
The unique identifier of the bot that contains the intent.
botVersion :: Text
The version of the bot that contains the intent.
localeId :: Text
The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

Instances

Instances details

ToJSON ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods toJSON :: ListIntents -> Value # toEncoding :: ListIntents -> Encoding # toJSONList :: [ListIntents] -> Value # toEncodingList :: [ListIntents] -> Encoding #
ToHeaders ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods toHeaders :: ListIntents -> [Header] #
ToPath ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods toPath :: ListIntents -> ByteString #
ToQuery ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods toQuery :: ListIntents -> QueryString #
AWSRequest ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Associated Types type AWSResponse ListIntents # Methods request :: (Service -> Service) -> ListIntents -> Request ListIntents # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListIntents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListIntents))) #
Generic ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Associated Types type Rep ListIntents :: Type -> Type # Methods from :: ListIntents -> Rep ListIntents x # to :: Rep ListIntents x -> ListIntents #
Read ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods readsPrec :: Int -> ReadS ListIntents # readList :: ReadS [ListIntents] # readPrec :: ReadPrec ListIntents # readListPrec :: ReadPrec [ListIntents] #
Show ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods showsPrec :: Int -> ListIntents -> ShowS # show :: ListIntents -> String # showList :: [ListIntents] -> ShowS #
NFData ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods rnf :: ListIntents -> () #
Eq ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods (==) :: ListIntents -> ListIntents -> Bool # (/=) :: ListIntents -> ListIntents -> Bool #
Hashable ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods hashWithSalt :: Int -> ListIntents -> Int # hash :: ListIntents -> Int #
type AWSResponse ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents type AWSResponse ListIntents = ListIntentsResponse
type Rep ListIntents Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents type Rep ListIntents = D1 ('MetaData "ListIntents" "Amazonka.LexV2Models.ListIntents" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListIntents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty IntentFilter))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntentSortBy)) :: S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListIntents Source #

Arguments

:: Text	`ListIntents`
-> Text	`ListIntents`
-> Text	`ListIntents`
-> ListIntents

Create a value of ListIntents 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:filters:ListIntents', listIntents_filters - Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

$sel:maxResults:ListIntents', listIntents_maxResults - The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

ListIntents, listIntents_nextToken - If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.

$sel:sortBy:ListIntents', listIntents_sortBy - Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.

ListIntents, listIntents_botId - The unique identifier of the bot that contains the intent.

ListIntents, listIntents_botVersion - The version of the bot that contains the intent.

ListIntents, listIntents_localeId - The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

Request Lenses

listIntents_filters :: Lens' ListIntents (Maybe (NonEmpty IntentFilter)) Source #

Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

listIntents_maxResults :: Lens' ListIntents (Maybe Natural) Source #

The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

listIntents_nextToken :: Lens' ListIntents (Maybe Text) Source #

If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.

listIntents_sortBy :: Lens' ListIntents (Maybe IntentSortBy) Source #

Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.

listIntents_botId :: Lens' ListIntents Text Source #

The unique identifier of the bot that contains the intent.

listIntents_botVersion :: Lens' ListIntents Text Source #

The version of the bot that contains the intent.

listIntents_localeId :: Lens' ListIntents Text Source #

The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

Destructuring the Response

data ListIntentsResponse Source #

See: newListIntentsResponse smart constructor.

Constructors

ListIntentsResponse'

Fields

botId :: Maybe Text
The identifier of the bot that contains the intent.
botVersion :: Maybe Text
The version of the bot that contains the intent.
intentSummaries :: Maybe [IntentSummary]
Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
localeId :: Maybe Text
The language and locale of the intents in the list.
nextToken :: Maybe Text
A token that indicates whether there are more results to return in a response to the ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListIntentsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Associated Types type Rep ListIntentsResponse :: Type -> Type # Methods from :: ListIntentsResponse -> Rep ListIntentsResponse x # to :: Rep ListIntentsResponse x -> ListIntentsResponse #
Read ListIntentsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods readsPrec :: Int -> ReadS ListIntentsResponse # readList :: ReadS [ListIntentsResponse] # readPrec :: ReadPrec ListIntentsResponse # readListPrec :: ReadPrec [ListIntentsResponse] #
Show ListIntentsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods showsPrec :: Int -> ListIntentsResponse -> ShowS # show :: ListIntentsResponse -> String # showList :: [ListIntentsResponse] -> ShowS #
NFData ListIntentsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods rnf :: ListIntentsResponse -> () #
Eq ListIntentsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents Methods (==) :: ListIntentsResponse -> ListIntentsResponse -> Bool # (/=) :: ListIntentsResponse -> ListIntentsResponse -> Bool #
type Rep ListIntentsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListIntents type Rep ListIntentsResponse = D1 ('MetaData "ListIntentsResponse" "Amazonka.LexV2Models.ListIntents" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListIntentsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "intentSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IntentSummary])))) :: (S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newListIntentsResponse Source #

Arguments

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

Create a value of ListIntentsResponse 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:

ListIntents, listIntentsResponse_botId - The identifier of the bot that contains the intent.

ListIntents, listIntentsResponse_botVersion - The version of the bot that contains the intent.

$sel:intentSummaries:ListIntentsResponse', listIntentsResponse_intentSummaries - Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.

ListIntents, listIntentsResponse_localeId - The language and locale of the intents in the list.

ListIntents, listIntentsResponse_nextToken - A token that indicates whether there are more results to return in a response to the ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.

$sel:httpStatus:ListIntentsResponse', listIntentsResponse_httpStatus - The response's http status code.

Response Lenses

listIntentsResponse_botId :: Lens' ListIntentsResponse (Maybe Text) Source #

The identifier of the bot that contains the intent.

listIntentsResponse_botVersion :: Lens' ListIntentsResponse (Maybe Text) Source #

The version of the bot that contains the intent.

listIntentsResponse_intentSummaries :: Lens' ListIntentsResponse (Maybe [IntentSummary]) Source #

Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.

listIntentsResponse_localeId :: Lens' ListIntentsResponse (Maybe Text) Source #

The language and locale of the intents in the list.

listIntentsResponse_nextToken :: Lens' ListIntentsResponse (Maybe Text) Source #

A token that indicates whether there are more results to return in a response to the ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.

listIntentsResponse_httpStatus :: Lens' ListIntentsResponse Int Source #

The response's http status code.