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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get a list of bot recommendations that meet the specified criteria.

Synopsis

data ListBotRecommendations = ListBotRecommendations' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- botId :: Text
- botVersion :: Text
- localeId :: Text
}
newListBotRecommendations :: Text -> Text -> Text -> ListBotRecommendations
listBotRecommendations_maxResults :: Lens' ListBotRecommendations (Maybe Natural)
listBotRecommendations_nextToken :: Lens' ListBotRecommendations (Maybe Text)
listBotRecommendations_botId :: Lens' ListBotRecommendations Text
listBotRecommendations_botVersion :: Lens' ListBotRecommendations Text
listBotRecommendations_localeId :: Lens' ListBotRecommendations Text
data ListBotRecommendationsResponse = ListBotRecommendationsResponse' {
- botId :: Maybe Text
- botRecommendationSummaries :: Maybe [BotRecommendationSummary]
- botVersion :: Maybe Text
- localeId :: Maybe Text
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListBotRecommendationsResponse :: Int -> ListBotRecommendationsResponse
listBotRecommendationsResponse_botId :: Lens' ListBotRecommendationsResponse (Maybe Text)
listBotRecommendationsResponse_botRecommendationSummaries :: Lens' ListBotRecommendationsResponse (Maybe [BotRecommendationSummary])
listBotRecommendationsResponse_botVersion :: Lens' ListBotRecommendationsResponse (Maybe Text)
listBotRecommendationsResponse_localeId :: Lens' ListBotRecommendationsResponse (Maybe Text)
listBotRecommendationsResponse_nextToken :: Lens' ListBotRecommendationsResponse (Maybe Text)
listBotRecommendationsResponse_httpStatus :: Lens' ListBotRecommendationsResponse Int

Creating a Request

data ListBotRecommendations Source #

See: newListBotRecommendations smart constructor.

Constructors

ListBotRecommendations'

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 ListBotRecommendation 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 that contains the bot recommendation list.
botVersion :: Text
The version of the bot that contains the bot recommendation list.
localeId :: Text
The identifier of the language and locale of the bot recommendation list.

Instances

Instances details

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

newListBotRecommendations Source #

Arguments

:: Text	`ListBotRecommendations`
-> Text	`ListBotRecommendations`
-> Text	`ListBotRecommendations`
-> ListBotRecommendations

Create a value of ListBotRecommendations 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:ListBotRecommendations', listBotRecommendations_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.

ListBotRecommendations, listBotRecommendations_nextToken - If the response from the ListBotRecommendation 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.

ListBotRecommendations, listBotRecommendations_botId - The unique identifier of the bot that contains the bot recommendation list.

ListBotRecommendations, listBotRecommendations_botVersion - The version of the bot that contains the bot recommendation list.

ListBotRecommendations, listBotRecommendations_localeId - The identifier of the language and locale of the bot recommendation list.

Request Lenses

listBotRecommendations_maxResults :: Lens' ListBotRecommendations (Maybe Natural) Source #

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.

listBotRecommendations_nextToken :: Lens' ListBotRecommendations (Maybe Text) Source #

If the response from the ListBotRecommendation 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.

listBotRecommendations_botId :: Lens' ListBotRecommendations Text Source #

The unique identifier of the bot that contains the bot recommendation list.

listBotRecommendations_botVersion :: Lens' ListBotRecommendations Text Source #

The version of the bot that contains the bot recommendation list.

listBotRecommendations_localeId :: Lens' ListBotRecommendations Text Source #

The identifier of the language and locale of the bot recommendation list.

Destructuring the Response

data ListBotRecommendationsResponse Source #

See: newListBotRecommendationsResponse smart constructor.

Constructors

ListBotRecommendationsResponse'

Fields

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

Instances

Instances details

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

newListBotRecommendationsResponse Source #

Arguments

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

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

ListBotRecommendations, listBotRecommendationsResponse_botId - The unique identifier of the bot that contains the bot recommendation list.

$sel:botRecommendationSummaries:ListBotRecommendationsResponse', listBotRecommendationsResponse_botRecommendationSummaries - Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.

ListBotRecommendations, listBotRecommendationsResponse_botVersion - The version of the bot that contains the bot recommendation list.

ListBotRecommendations, listBotRecommendationsResponse_localeId - The identifier of the language and locale of the bot recommendation list.

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

$sel:httpStatus:ListBotRecommendationsResponse', listBotRecommendationsResponse_httpStatus - The response's http status code.

Response Lenses

listBotRecommendationsResponse_botId :: Lens' ListBotRecommendationsResponse (Maybe Text) Source #

The unique identifier of the bot that contains the bot recommendation list.

listBotRecommendationsResponse_botRecommendationSummaries :: Lens' ListBotRecommendationsResponse (Maybe [BotRecommendationSummary]) Source #

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

listBotRecommendationsResponse_botVersion :: Lens' ListBotRecommendationsResponse (Maybe Text) Source #

The version of the bot that contains the bot recommendation list.

listBotRecommendationsResponse_localeId :: Lens' ListBotRecommendationsResponse (Maybe Text) Source #

The identifier of the language and locale of the bot recommendation list.

listBotRecommendationsResponse_nextToken :: Lens' ListBotRecommendationsResponse (Maybe Text) Source #

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

listBotRecommendationsResponse_httpStatus :: Lens' ListBotRecommendationsResponse Int Source #

The response's http status code.