Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
Synopsis
- getBotAliases :: Text -> GetBotAliases
- data GetBotAliases
- gbaNameContains :: Lens' GetBotAliases (Maybe Text)
- gbaNextToken :: Lens' GetBotAliases (Maybe Text)
- gbaMaxResults :: Lens' GetBotAliases (Maybe Natural)
- gbaBotName :: Lens' GetBotAliases Text
- getBotAliasesResponse :: Int -> GetBotAliasesResponse
- data GetBotAliasesResponse
- gbarsNextToken :: Lens' GetBotAliasesResponse (Maybe Text)
- gbarsBotAliases :: Lens' GetBotAliasesResponse [BotAliasMetadata]
- gbarsResponseStatus :: Lens' GetBotAliasesResponse Int
Creating a Request
Creates a value of GetBotAliases
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gbaNameContains
- 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."gbaNextToken
- 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.gbaMaxResults
- The maximum number of aliases to return in the response. The default is 50. .gbaBotName
- The name of the bot.
data GetBotAliases Source #
See: getBotAliases
smart constructor.
Instances
Request Lenses
gbaNameContains :: 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."
gbaNextToken :: 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.
gbaMaxResults :: Lens' GetBotAliases (Maybe Natural) Source #
The maximum number of aliases to return in the response. The default is 50. .
gbaBotName :: Lens' GetBotAliases Text Source #
The name of the bot.
Destructuring the Response
getBotAliasesResponse Source #
Creates a value of GetBotAliasesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gbarsNextToken
- 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.gbarsBotAliases
- An array ofBotAliasMetadata
objects, each describing a bot alias.gbarsResponseStatus
- -- | The response status code.
data GetBotAliasesResponse Source #
See: getBotAliasesResponse
smart constructor.
Instances
Response Lenses
gbarsNextToken :: 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.
gbarsBotAliases :: Lens' GetBotAliasesResponse [BotAliasMetadata] Source #
An array of BotAliasMetadata
objects, each describing a bot alias.
gbarsResponseStatus :: Lens' GetBotAliasesResponse Int Source #
- - | The response status code.