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 |
Returns information about the association between an Amazon Lex bot and a messaging platform.
This operation requires permissions for the
lex:GetBotChannelAssociation
action.
Synopsis
- data GetBotChannelAssociation = GetBotChannelAssociation' {}
- newGetBotChannelAssociation :: Text -> Text -> Text -> GetBotChannelAssociation
- getBotChannelAssociation_name :: Lens' GetBotChannelAssociation Text
- getBotChannelAssociation_botName :: Lens' GetBotChannelAssociation Text
- getBotChannelAssociation_botAlias :: Lens' GetBotChannelAssociation Text
- data GetBotChannelAssociationResponse = GetBotChannelAssociationResponse' {
- botAlias :: Maybe Text
- botConfiguration :: Maybe (Sensitive (HashMap Text Text))
- botName :: Maybe Text
- createdDate :: Maybe POSIX
- description :: Maybe Text
- failureReason :: Maybe Text
- name :: Maybe Text
- status :: Maybe ChannelStatus
- type' :: Maybe ChannelType
- httpStatus :: Int
- newGetBotChannelAssociationResponse :: Int -> GetBotChannelAssociationResponse
- getBotChannelAssociationResponse_botAlias :: Lens' GetBotChannelAssociationResponse (Maybe Text)
- getBotChannelAssociationResponse_botConfiguration :: Lens' GetBotChannelAssociationResponse (Maybe (HashMap Text Text))
- getBotChannelAssociationResponse_botName :: Lens' GetBotChannelAssociationResponse (Maybe Text)
- getBotChannelAssociationResponse_createdDate :: Lens' GetBotChannelAssociationResponse (Maybe UTCTime)
- getBotChannelAssociationResponse_description :: Lens' GetBotChannelAssociationResponse (Maybe Text)
- getBotChannelAssociationResponse_failureReason :: Lens' GetBotChannelAssociationResponse (Maybe Text)
- getBotChannelAssociationResponse_name :: Lens' GetBotChannelAssociationResponse (Maybe Text)
- getBotChannelAssociationResponse_status :: Lens' GetBotChannelAssociationResponse (Maybe ChannelStatus)
- getBotChannelAssociationResponse_type :: Lens' GetBotChannelAssociationResponse (Maybe ChannelType)
- getBotChannelAssociationResponse_httpStatus :: Lens' GetBotChannelAssociationResponse Int
Creating a Request
data GetBotChannelAssociation Source #
See: newGetBotChannelAssociation
smart constructor.
Instances
newGetBotChannelAssociation Source #
:: Text | |
-> Text | |
-> Text | |
-> GetBotChannelAssociation |
Create a value of GetBotChannelAssociation
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:
GetBotChannelAssociation
, getBotChannelAssociation_name
- The name of the association between the bot and the channel. The name is
case sensitive.
GetBotChannelAssociation
, getBotChannelAssociation_botName
- The name of the Amazon Lex bot.
GetBotChannelAssociation
, getBotChannelAssociation_botAlias
- An alias pointing to the specific version of the Amazon Lex bot to which
this association is being made.
Request Lenses
getBotChannelAssociation_name :: Lens' GetBotChannelAssociation Text Source #
The name of the association between the bot and the channel. The name is case sensitive.
getBotChannelAssociation_botName :: Lens' GetBotChannelAssociation Text Source #
The name of the Amazon Lex bot.
getBotChannelAssociation_botAlias :: Lens' GetBotChannelAssociation 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 GetBotChannelAssociationResponse Source #
See: newGetBotChannelAssociationResponse
smart constructor.
GetBotChannelAssociationResponse' | |
|
Instances
newGetBotChannelAssociationResponse Source #
Create a value of GetBotChannelAssociationResponse
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:
GetBotChannelAssociation
, getBotChannelAssociationResponse_botAlias
- An alias pointing to the specific version of the Amazon Lex bot to which
this association is being made.
GetBotChannelAssociationResponse
, getBotChannelAssociationResponse_botConfiguration
- Provides information that the messaging platform needs to communicate
with the Amazon Lex bot.
GetBotChannelAssociation
, getBotChannelAssociationResponse_botName
- The name of the Amazon Lex bot.
GetBotChannelAssociationResponse
, getBotChannelAssociationResponse_createdDate
- The date that the association between the bot and the channel was
created.
GetBotChannelAssociationResponse
, getBotChannelAssociationResponse_description
- A description of the association between the bot and the channel.
GetBotChannelAssociationResponse
, getBotChannelAssociationResponse_failureReason
- If status
is FAILED
, Amazon Lex provides the reason that it failed
to create the association.
GetBotChannelAssociation
, getBotChannelAssociationResponse_name
- The name of the association between the bot and the channel.
GetBotChannelAssociationResponse
, getBotChannelAssociationResponse_status
- The status of the bot channel.
CREATED
- The channel has been created and is ready for use.IN_PROGRESS
- Channel creation is in progress.FAILED
- There was an error creating the channel. For information about the reason for the failure, see thefailureReason
field.
GetBotChannelAssociationResponse
, getBotChannelAssociationResponse_type
- The type of the messaging platform.
$sel:httpStatus:GetBotChannelAssociationResponse'
, getBotChannelAssociationResponse_httpStatus
- The response's http status code.
Response Lenses
getBotChannelAssociationResponse_botAlias :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
getBotChannelAssociationResponse_botConfiguration :: Lens' GetBotChannelAssociationResponse (Maybe (HashMap Text Text)) Source #
Provides information that the messaging platform needs to communicate with the Amazon Lex bot.
getBotChannelAssociationResponse_botName :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #
The name of the Amazon Lex bot.
getBotChannelAssociationResponse_createdDate :: Lens' GetBotChannelAssociationResponse (Maybe UTCTime) Source #
The date that the association between the bot and the channel was created.
getBotChannelAssociationResponse_description :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #
A description of the association between the bot and the channel.
getBotChannelAssociationResponse_failureReason :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #
If status
is FAILED
, Amazon Lex provides the reason that it failed
to create the association.
getBotChannelAssociationResponse_name :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #
The name of the association between the bot and the channel.
getBotChannelAssociationResponse_status :: Lens' GetBotChannelAssociationResponse (Maybe ChannelStatus) Source #
The status of the bot channel.
CREATED
- The channel has been created and is ready for use.IN_PROGRESS
- Channel creation is in progress.FAILED
- There was an error creating the channel. For information about the reason for the failure, see thefailureReason
field.
getBotChannelAssociationResponse_type :: Lens' GetBotChannelAssociationResponse (Maybe ChannelType) Source #
The type of the messaging platform.
getBotChannelAssociationResponse_httpStatus :: Lens' GetBotChannelAssociationResponse Int Source #
The response's http status code.