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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of aliases for the specified bot.

Synopsis

data ListBotAliases = ListBotAliases' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- botId :: Text
}
newListBotAliases :: Text -> ListBotAliases
listBotAliases_maxResults :: Lens' ListBotAliases (Maybe Natural)
listBotAliases_nextToken :: Lens' ListBotAliases (Maybe Text)
listBotAliases_botId :: Lens' ListBotAliases Text
data ListBotAliasesResponse = ListBotAliasesResponse' {
- botAliasSummaries :: Maybe [BotAliasSummary]
- botId :: Maybe Text
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListBotAliasesResponse :: Int -> ListBotAliasesResponse
listBotAliasesResponse_botAliasSummaries :: Lens' ListBotAliasesResponse (Maybe [BotAliasSummary])
listBotAliasesResponse_botId :: Lens' ListBotAliasesResponse (Maybe Text)
listBotAliasesResponse_nextToken :: Lens' ListBotAliasesResponse (Maybe Text)
listBotAliasesResponse_httpStatus :: Lens' ListBotAliasesResponse Int

Creating a Request

data ListBotAliases Source #

See: newListBotAliases smart constructor.

Constructors

ListBotAliases'

Fields

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 ListBotAliases 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 identifier of the bot to list aliases for.

Instances

Instances details

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

newListBotAliases Source #

Arguments

:: Text	`ListBotAliases`
-> ListBotAliases

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

ListBotAliases, listBotAliases_nextToken - If the response from the ListBotAliases 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.

ListBotAliases, listBotAliases_botId - The identifier of the bot to list aliases for.

Request Lenses

listBotAliases_maxResults :: Lens' ListBotAliases (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.

listBotAliases_nextToken :: Lens' ListBotAliases (Maybe Text) Source #

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

listBotAliases_botId :: Lens' ListBotAliases Text Source #

The identifier of the bot to list aliases for.

Destructuring the Response

data ListBotAliasesResponse Source #

See: newListBotAliasesResponse smart constructor.

Constructors

ListBotAliasesResponse'

Fields

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

Instances

Instances details

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

newListBotAliasesResponse Source #

Arguments

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

Create a value of ListBotAliasesResponse 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:botAliasSummaries:ListBotAliasesResponse', listBotAliasesResponse_botAliasSummaries - Summary information for the bot aliases 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 aliases available, the nextToken field contains a token to get the next page of results.

ListBotAliases, listBotAliasesResponse_botId - The identifier of the bot associated with the aliases.

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

$sel:httpStatus:ListBotAliasesResponse', listBotAliasesResponse_httpStatus - The response's http status code.

Response Lenses

listBotAliasesResponse_botAliasSummaries :: Lens' ListBotAliasesResponse (Maybe [BotAliasSummary]) Source #

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

listBotAliasesResponse_botId :: Lens' ListBotAliasesResponse (Maybe Text) Source #

The identifier of the bot associated with the aliases.

listBotAliasesResponse_nextToken :: Lens' ListBotAliasesResponse (Maybe Text) Source #

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

listBotAliasesResponse_httpStatus :: Lens' ListBotAliasesResponse Int Source #

The response's http status code.