| Copyright | (c) 2013-2021 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 |
Amazonka.LexModels.GetBotChannelAssociations
Description
Returns a list of all of the channels associated with the specified bot.
The GetBotChannelAssociations operation requires permissions for the
lex:GetBotChannelAssociations action.
This operation returns paginated results.
Synopsis
- data GetBotChannelAssociations = GetBotChannelAssociations' {}
- newGetBotChannelAssociations :: Text -> Text -> GetBotChannelAssociations
- getBotChannelAssociations_nameContains :: Lens' GetBotChannelAssociations (Maybe Text)
- getBotChannelAssociations_nextToken :: Lens' GetBotChannelAssociations (Maybe Text)
- getBotChannelAssociations_maxResults :: Lens' GetBotChannelAssociations (Maybe Natural)
- getBotChannelAssociations_botName :: Lens' GetBotChannelAssociations Text
- getBotChannelAssociations_botAlias :: Lens' GetBotChannelAssociations Text
- data GetBotChannelAssociationsResponse = GetBotChannelAssociationsResponse' {}
- newGetBotChannelAssociationsResponse :: Int -> GetBotChannelAssociationsResponse
- getBotChannelAssociationsResponse_botChannelAssociations :: Lens' GetBotChannelAssociationsResponse (Maybe [BotChannelAssociation])
- getBotChannelAssociationsResponse_nextToken :: Lens' GetBotChannelAssociationsResponse (Maybe Text)
- getBotChannelAssociationsResponse_httpStatus :: Lens' GetBotChannelAssociationsResponse Int
Creating a Request
data GetBotChannelAssociations Source #
See: newGetBotChannelAssociations smart constructor.
Constructors
| GetBotChannelAssociations' | |
Fields
| |
Instances
newGetBotChannelAssociations Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetBotChannelAssociations |
Create a value of GetBotChannelAssociations 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:nameContains:GetBotChannelAssociations', getBotChannelAssociations_nameContains - Substring to match in channel association names. An association will be
returned if any part of its name matches the substring. For example,
"xyz" matches both "xyzabc" and "abcxyz." To return all bot
channel associations, use a hyphen ("-") as the nameContains
parameter.
$sel:nextToken:GetBotChannelAssociations', getBotChannelAssociations_nextToken - A pagination token for fetching the next page of associations. If the
response to this call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of associations, specify
the pagination token in the next request.
$sel:maxResults:GetBotChannelAssociations', getBotChannelAssociations_maxResults - The maximum number of associations to return in the response. The
default is 50.
$sel:botName:GetBotChannelAssociations', getBotChannelAssociations_botName - The name of the Amazon Lex bot in the association.
$sel:botAlias:GetBotChannelAssociations', getBotChannelAssociations_botAlias - An alias pointing to the specific version of the Amazon Lex bot to which
this association is being made.
Request Lenses
getBotChannelAssociations_nameContains :: Lens' GetBotChannelAssociations (Maybe Text) Source #
Substring to match in channel association names. An association will be
returned if any part of its name matches the substring. For example,
"xyz" matches both "xyzabc" and "abcxyz." To return all bot
channel associations, use a hyphen ("-") as the nameContains
parameter.
getBotChannelAssociations_nextToken :: Lens' GetBotChannelAssociations (Maybe Text) Source #
A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.
getBotChannelAssociations_maxResults :: Lens' GetBotChannelAssociations (Maybe Natural) Source #
The maximum number of associations to return in the response. The default is 50.
getBotChannelAssociations_botName :: Lens' GetBotChannelAssociations Text Source #
The name of the Amazon Lex bot in the association.
getBotChannelAssociations_botAlias :: Lens' GetBotChannelAssociations Text Source #
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
Destructuring the Response
data GetBotChannelAssociationsResponse Source #
See: newGetBotChannelAssociationsResponse smart constructor.
Constructors
| GetBotChannelAssociationsResponse' | |
Fields
| |
Instances
newGetBotChannelAssociationsResponse Source #
Arguments
| :: Int | |
| -> GetBotChannelAssociationsResponse |
Create a value of GetBotChannelAssociationsResponse 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:botChannelAssociations:GetBotChannelAssociationsResponse', getBotChannelAssociationsResponse_botChannelAssociations - An array of objects, one for each association, that provides information
about the Amazon Lex bot and its association with the channel.
$sel:nextToken:GetBotChannelAssociations', getBotChannelAssociationsResponse_nextToken - A pagination token that fetches the next page of associations. If the
response to this call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of associations, specify
the pagination token in the next request.
$sel:httpStatus:GetBotChannelAssociationsResponse', getBotChannelAssociationsResponse_httpStatus - The response's http status code.
Response Lenses
getBotChannelAssociationsResponse_botChannelAssociations :: Lens' GetBotChannelAssociationsResponse (Maybe [BotChannelAssociation]) Source #
An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel.
getBotChannelAssociationsResponse_nextToken :: Lens' GetBotChannelAssociationsResponse (Maybe Text) Source #
A pagination token that fetches the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.
getBotChannelAssociationsResponse_httpStatus :: Lens' GetBotChannelAssociationsResponse Int Source #
The response's http status code.