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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of locales for the specified bot.

Synopsis

data ListBotLocales = ListBotLocales' {
- filters :: Maybe (NonEmpty BotLocaleFilter)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe BotLocaleSortBy
- botId :: Text
- botVersion :: Text
}
newListBotLocales :: Text -> Text -> ListBotLocales
listBotLocales_filters :: Lens' ListBotLocales (Maybe (NonEmpty BotLocaleFilter))
listBotLocales_maxResults :: Lens' ListBotLocales (Maybe Natural)
listBotLocales_nextToken :: Lens' ListBotLocales (Maybe Text)
listBotLocales_sortBy :: Lens' ListBotLocales (Maybe BotLocaleSortBy)
listBotLocales_botId :: Lens' ListBotLocales Text
listBotLocales_botVersion :: Lens' ListBotLocales Text
data ListBotLocalesResponse = ListBotLocalesResponse' {
- botId :: Maybe Text
- botLocaleSummaries :: Maybe [BotLocaleSummary]
- botVersion :: Maybe Text
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListBotLocalesResponse :: Int -> ListBotLocalesResponse
listBotLocalesResponse_botId :: Lens' ListBotLocalesResponse (Maybe Text)
listBotLocalesResponse_botLocaleSummaries :: Lens' ListBotLocalesResponse (Maybe [BotLocaleSummary])
listBotLocalesResponse_botVersion :: Lens' ListBotLocalesResponse (Maybe Text)
listBotLocalesResponse_nextToken :: Lens' ListBotLocalesResponse (Maybe Text)
listBotLocalesResponse_httpStatus :: Lens' ListBotLocalesResponse Int

Creating a Request

data ListBotLocales Source #

See: newListBotLocales smart constructor.

Constructors

ListBotLocales'

Fields

filters :: Maybe (NonEmpty BotLocaleFilter)
Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.
maxResults :: Maybe Natural
The maximum number of aliases 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 ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.
sortBy :: Maybe BotLocaleSortBy
Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.
botId :: Text
The identifier of the bot to list locales for.
botVersion :: Text
The version of the bot to list locales for.

Instances

Instances details

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

newListBotLocales Source #

Arguments

:: Text	`ListBotLocales`
-> Text	`ListBotLocales`
-> ListBotLocales

Create a value of ListBotLocales 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:ListBotLocales', listBotLocales_filters - Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.

$sel:maxResults:ListBotLocales', listBotLocales_maxResults - The maximum number of aliases 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.

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

$sel:sortBy:ListBotLocales', listBotLocales_sortBy - Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.

ListBotLocales, listBotLocales_botId - The identifier of the bot to list locales for.

ListBotLocales, listBotLocales_botVersion - The version of the bot to list locales for.

Request Lenses

listBotLocales_filters :: Lens' ListBotLocales (Maybe (NonEmpty BotLocaleFilter)) Source #

Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.

listBotLocales_maxResults :: Lens' ListBotLocales (Maybe Natural) Source #

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

listBotLocales_nextToken :: Lens' ListBotLocales (Maybe Text) Source #

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

listBotLocales_sortBy :: Lens' ListBotLocales (Maybe BotLocaleSortBy) Source #

Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.

listBotLocales_botId :: Lens' ListBotLocales Text Source #

The identifier of the bot to list locales for.

listBotLocales_botVersion :: Lens' ListBotLocales Text Source #

The version of the bot to list locales for.

Destructuring the Response

data ListBotLocalesResponse Source #

See: newListBotLocalesResponse smart constructor.

Constructors

ListBotLocalesResponse'

Fields

botId :: Maybe Text
The identifier of the bot to list locales for.
botLocaleSummaries :: Maybe [BotLocaleSummary]
Summary information for the locales 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 locales available, the nextToken field contains a token to get the next page of results.
botVersion :: Maybe Text
The version of the bot.
nextToken :: Maybe Text
A token that indicates whether there are more results to return in a response to the ListBotLocales operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotLocales operation request to get the next page of results.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListBotLocalesResponse Source #

Arguments

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

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

ListBotLocales, listBotLocalesResponse_botId - The identifier of the bot to list locales for.

$sel:botLocaleSummaries:ListBotLocalesResponse', listBotLocalesResponse_botLocaleSummaries - Summary information for the locales 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 locales available, the nextToken field contains a token to get the next page of results.

ListBotLocales, listBotLocalesResponse_botVersion - The version of the bot.

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

$sel:httpStatus:ListBotLocalesResponse', listBotLocalesResponse_httpStatus - The response's http status code.

Response Lenses

listBotLocalesResponse_botId :: Lens' ListBotLocalesResponse (Maybe Text) Source #

The identifier of the bot to list locales for.

listBotLocalesResponse_botLocaleSummaries :: Lens' ListBotLocalesResponse (Maybe [BotLocaleSummary]) Source #

Summary information for the locales 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 locales available, the nextToken field contains a token to get the next page of results.

listBotLocalesResponse_botVersion :: Lens' ListBotLocalesResponse (Maybe Text) Source #

The version of the bot.

listBotLocalesResponse_nextToken :: Lens' ListBotLocalesResponse (Maybe Text) Source #

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

listBotLocalesResponse_httpStatus :: Lens' ListBotLocalesResponse Int Source #

The response's http status code.