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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.

Synopsis

data ListRecommendedIntents = ListRecommendedIntents' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- botId :: Text
- botVersion :: Text
- localeId :: Text
- botRecommendationId :: Text
}
newListRecommendedIntents :: Text -> Text -> Text -> Text -> ListRecommendedIntents
listRecommendedIntents_maxResults :: Lens' ListRecommendedIntents (Maybe Natural)
listRecommendedIntents_nextToken :: Lens' ListRecommendedIntents (Maybe Text)
listRecommendedIntents_botId :: Lens' ListRecommendedIntents Text
listRecommendedIntents_botVersion :: Lens' ListRecommendedIntents Text
listRecommendedIntents_localeId :: Lens' ListRecommendedIntents Text
listRecommendedIntents_botRecommendationId :: Lens' ListRecommendedIntents Text
data ListRecommendedIntentsResponse = ListRecommendedIntentsResponse' {
- botId :: Maybe Text
- botRecommendationId :: Maybe Text
- botVersion :: Maybe Text
- localeId :: Maybe Text
- nextToken :: Maybe Text
- summaryList :: Maybe [RecommendedIntentSummary]
- httpStatus :: Int
}
newListRecommendedIntentsResponse :: Int -> ListRecommendedIntentsResponse
listRecommendedIntentsResponse_botId :: Lens' ListRecommendedIntentsResponse (Maybe Text)
listRecommendedIntentsResponse_botRecommendationId :: Lens' ListRecommendedIntentsResponse (Maybe Text)
listRecommendedIntentsResponse_botVersion :: Lens' ListRecommendedIntentsResponse (Maybe Text)
listRecommendedIntentsResponse_localeId :: Lens' ListRecommendedIntentsResponse (Maybe Text)
listRecommendedIntentsResponse_nextToken :: Lens' ListRecommendedIntentsResponse (Maybe Text)
listRecommendedIntentsResponse_summaryList :: Lens' ListRecommendedIntentsResponse (Maybe [RecommendedIntentSummary])
listRecommendedIntentsResponse_httpStatus :: Lens' ListRecommendedIntentsResponse Int

Creating a Request

data ListRecommendedIntents Source #

See: newListRecommendedIntents smart constructor.

Constructors

ListRecommendedIntents'

Fields

maxResults :: Maybe Natural
The maximum number of bot recommendations 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 ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
botId :: Text
The unique identifier of the bot associated with the recommended intents.
botVersion :: Text
The version of the bot that contains the recommended intents.
localeId :: Text
The identifier of the language and locale of the recommended intents.
botRecommendationId :: Text
The identifier of the bot recommendation that contains the recommended intents.

Instances

Instances details

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

newListRecommendedIntents Source #

Arguments

:: Text	`ListRecommendedIntents`
-> Text	`ListRecommendedIntents`
-> Text	`ListRecommendedIntents`
-> Text	`ListRecommendedIntents`
-> ListRecommendedIntents

Create a value of ListRecommendedIntents 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:maxResults:ListRecommendedIntents', listRecommendedIntents_maxResults - The maximum number of bot recommendations 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.

ListRecommendedIntents, listRecommendedIntents_nextToken - If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

ListRecommendedIntents, listRecommendedIntents_botId - The unique identifier of the bot associated with the recommended intents.

ListRecommendedIntents, listRecommendedIntents_botVersion - The version of the bot that contains the recommended intents.

ListRecommendedIntents, listRecommendedIntents_localeId - The identifier of the language and locale of the recommended intents.

ListRecommendedIntents, listRecommendedIntents_botRecommendationId - The identifier of the bot recommendation that contains the recommended intents.

Request Lenses

The maximum number of bot recommendations 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.

If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

The unique identifier of the bot associated with the recommended intents.

The version of the bot that contains the recommended intents.

The identifier of the language and locale of the recommended intents.

The identifier of the bot recommendation that contains the recommended intents.

Destructuring the Response

See: newListRecommendedIntentsResponse smart constructor.

Constructors

ListRecommendedIntentsResponse'

Fields

botId :: Maybe Text
The unique identifier of the bot associated with the recommended intent.
botRecommendationId :: Maybe Text
The identifier of the bot recommendation that contains the recommended intent.
botVersion :: Maybe Text
The version of the bot that contains the intent.
localeId :: Maybe 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.
nextToken :: Maybe Text
A token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.
summaryList :: Maybe [RecommendedIntentSummary]
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

Arguments

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

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

ListRecommendedIntents, listRecommendedIntentsResponse_botId - The unique identifier of the bot associated with the recommended intent.

ListRecommendedIntents, listRecommendedIntentsResponse_botRecommendationId - The identifier of the bot recommendation that contains the recommended intent.

ListRecommendedIntents, listRecommendedIntentsResponse_botVersion - The version of the bot that contains the intent.

ListRecommendedIntents, listRecommendedIntentsResponse_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.

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

$sel:summaryList:ListRecommendedIntentsResponse', listRecommendedIntentsResponse_summaryList - 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.

$sel:httpStatus:ListRecommendedIntentsResponse', listRecommendedIntentsResponse_httpStatus - The response's http status code.

Response Lenses

The unique identifier of the bot associated with the recommended intent.

The identifier of the bot recommendation that contains the recommended intent.

The version of the bot that contains the intent.

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.

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

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.

The response's http status code.