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.LexModels.GetBotAliases

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of aliases for a specified Amazon Lex bot.

This operation requires permissions for the lex:GetBotAliases action.

This operation returns paginated results.

Creating a Request

data GetBotAliases Source #

See: newGetBotAliases smart constructor.

Constructors

GetBotAliases'

Fields

maxResults :: Maybe Natural
The maximum number of aliases to return in the response. The default is 50. .
nameContains :: Maybe Text
Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
nextToken :: Maybe Text
A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.
botName :: Text
The name of the bot.

Instances

Instances details

ToHeaders GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods toHeaders :: GetBotAliases -> [Header] #
ToPath GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods toPath :: GetBotAliases -> ByteString #
ToQuery GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods toQuery :: GetBotAliases -> QueryString #
AWSPager GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods page :: GetBotAliases -> AWSResponse GetBotAliases -> Maybe GetBotAliases #
AWSRequest GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Associated Types type AWSResponse GetBotAliases # Methods request :: (Service -> Service) -> GetBotAliases -> Request GetBotAliases # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBotAliases -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBotAliases))) #
Generic GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Associated Types type Rep GetBotAliases :: Type -> Type # Methods from :: GetBotAliases -> Rep GetBotAliases x # to :: Rep GetBotAliases x -> GetBotAliases #
Read GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods readsPrec :: Int -> ReadS GetBotAliases # readList :: ReadS [GetBotAliases] # readPrec :: ReadPrec GetBotAliases # readListPrec :: ReadPrec [GetBotAliases] #
Show GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods showsPrec :: Int -> GetBotAliases -> ShowS # show :: GetBotAliases -> String # showList :: [GetBotAliases] -> ShowS #
NFData GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods rnf :: GetBotAliases -> () #
Eq GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods (==) :: GetBotAliases -> GetBotAliases -> Bool # (/=) :: GetBotAliases -> GetBotAliases -> Bool #
Hashable GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods hashWithSalt :: Int -> GetBotAliases -> Int # hash :: GetBotAliases -> Int #
type AWSResponse GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases type AWSResponse GetBotAliases = GetBotAliasesResponse
type Rep GetBotAliases Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases type Rep GetBotAliases = D1 ('MetaData "GetBotAliases" "Amazonka.LexModels.GetBotAliases" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetBotAliases'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "botName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetBotAliases Source #

Arguments

:: Text	`GetBotAliases`
-> GetBotAliases

Create a value of GetBotAliases 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:GetBotAliases', getBotAliases_maxResults - The maximum number of aliases to return in the response. The default is 50. .

$sel:nameContains:GetBotAliases', getBotAliases_nameContains - Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

GetBotAliases, getBotAliases_nextToken - A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

GetBotAliases, getBotAliases_botName - The name of the bot.

Request Lenses

getBotAliases_maxResults :: Lens' GetBotAliases (Maybe Natural) Source #

The maximum number of aliases to return in the response. The default is 50. .

getBotAliases_nameContains :: Lens' GetBotAliases (Maybe Text) Source #

Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

getBotAliases_nextToken :: Lens' GetBotAliases (Maybe Text) Source #

A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

getBotAliases_botName :: Lens' GetBotAliases Text Source #

The name of the bot.

Destructuring the Response

data GetBotAliasesResponse Source #

See: newGetBotAliasesResponse smart constructor.

Constructors

GetBotAliasesResponse'

Fields

botAliases :: Maybe [BotAliasMetadata]
An array of BotAliasMetadata objects, each describing a bot alias.
nextToken :: Maybe Text
A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetBotAliasesResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Associated Types type Rep GetBotAliasesResponse :: Type -> Type # Methods from :: GetBotAliasesResponse -> Rep GetBotAliasesResponse x # to :: Rep GetBotAliasesResponse x -> GetBotAliasesResponse #
Read GetBotAliasesResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods readsPrec :: Int -> ReadS GetBotAliasesResponse # readList :: ReadS [GetBotAliasesResponse] # readPrec :: ReadPrec GetBotAliasesResponse # readListPrec :: ReadPrec [GetBotAliasesResponse] #
Show GetBotAliasesResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods showsPrec :: Int -> GetBotAliasesResponse -> ShowS # show :: GetBotAliasesResponse -> String # showList :: [GetBotAliasesResponse] -> ShowS #
NFData GetBotAliasesResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods rnf :: GetBotAliasesResponse -> () #
Eq GetBotAliasesResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases Methods (==) :: GetBotAliasesResponse -> GetBotAliasesResponse -> Bool # (/=) :: GetBotAliasesResponse -> GetBotAliasesResponse -> Bool #
type Rep GetBotAliasesResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotAliases type Rep GetBotAliasesResponse = D1 ('MetaData "GetBotAliasesResponse" "Amazonka.LexModels.GetBotAliases" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetBotAliasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "botAliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BotAliasMetadata])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBotAliasesResponse Source #

Arguments

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

Create a value of GetBotAliasesResponse 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:botAliases:GetBotAliasesResponse', getBotAliasesResponse_botAliases - An array of BotAliasMetadata objects, each describing a bot alias.

GetBotAliases, getBotAliasesResponse_nextToken - A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

$sel:httpStatus:GetBotAliasesResponse', getBotAliasesResponse_httpStatus - The response's http status code.

Response Lenses

getBotAliasesResponse_botAliases :: Lens' GetBotAliasesResponse (Maybe [BotAliasMetadata]) Source #

An array of BotAliasMetadata objects, each describing a bot alias.

getBotAliasesResponse_nextToken :: Lens' GetBotAliasesResponse (Maybe Text) Source #

A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

getBotAliasesResponse_httpStatus :: Lens' GetBotAliasesResponse Int Source #

The response's http status code.