| 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
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.
Synopsis
- data GetBotAliases = GetBotAliases' {}
- newGetBotAliases :: Text -> GetBotAliases
- getBotAliases_maxResults :: Lens' GetBotAliases (Maybe Natural)
- getBotAliases_nameContains :: Lens' GetBotAliases (Maybe Text)
- getBotAliases_nextToken :: Lens' GetBotAliases (Maybe Text)
- getBotAliases_botName :: Lens' GetBotAliases Text
- data GetBotAliasesResponse = GetBotAliasesResponse' {
- botAliases :: Maybe [BotAliasMetadata]
- nextToken :: Maybe Text
- httpStatus :: Int
- newGetBotAliasesResponse :: Int -> GetBotAliasesResponse
- getBotAliasesResponse_botAliases :: Lens' GetBotAliasesResponse (Maybe [BotAliasMetadata])
- getBotAliasesResponse_nextToken :: Lens' GetBotAliasesResponse (Maybe Text)
- getBotAliasesResponse_httpStatus :: Lens' GetBotAliasesResponse Int
Creating a Request
data GetBotAliases Source #
See: newGetBotAliases smart constructor.
Constructors
| GetBotAliases' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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
| |
Instances
newGetBotAliasesResponse Source #
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.