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 information about the association between an Amazon Lex bot and a messaging platform.
This operation requires permissions for the lex:GetBotChannelAssociation
action.
Synopsis
- getBotChannelAssociation :: Text -> Text -> Text -> GetBotChannelAssociation
- data GetBotChannelAssociation
- gName :: Lens' GetBotChannelAssociation Text
- gBotName :: Lens' GetBotChannelAssociation Text
- gBotAlias :: Lens' GetBotChannelAssociation Text
- getBotChannelAssociationResponse :: Int -> GetBotChannelAssociationResponse
- data GetBotChannelAssociationResponse
- gbcarsFailureReason :: Lens' GetBotChannelAssociationResponse (Maybe Text)
- gbcarsStatus :: Lens' GetBotChannelAssociationResponse (Maybe ChannelStatus)
- gbcarsBotAlias :: Lens' GetBotChannelAssociationResponse (Maybe Text)
- gbcarsBotName :: Lens' GetBotChannelAssociationResponse (Maybe Text)
- gbcarsBotConfiguration :: Lens' GetBotChannelAssociationResponse (Maybe (HashMap Text Text))
- gbcarsCreatedDate :: Lens' GetBotChannelAssociationResponse (Maybe UTCTime)
- gbcarsName :: Lens' GetBotChannelAssociationResponse (Maybe Text)
- gbcarsType :: Lens' GetBotChannelAssociationResponse (Maybe ChannelType)
- gbcarsDescription :: Lens' GetBotChannelAssociationResponse (Maybe Text)
- gbcarsResponseStatus :: Lens' GetBotChannelAssociationResponse Int
Creating a Request
getBotChannelAssociation Source #
Creates a value of GetBotChannelAssociation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetBotChannelAssociation Source #
See: getBotChannelAssociation
smart constructor.
Instances
Request Lenses
gName :: Lens' GetBotChannelAssociation Text Source #
The name of the association between the bot and the channel. The name is case sensitive.
gBotAlias :: 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
getBotChannelAssociationResponse Source #
Creates a value of GetBotChannelAssociationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gbcarsFailureReason
- Ifstatus
isFAILED
, Amazon Lex provides the reason that it failed to create the association.gbcarsStatus
- 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.gbcarsBotAlias
- An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.gbcarsBotName
- The name of the Amazon Lex bot.gbcarsBotConfiguration
- Provides information that the messaging platform needs to communicate with the Amazon Lex bot.gbcarsCreatedDate
- The date that the association between the bot and the channel was created.gbcarsName
- The name of the association between the bot and the channel.gbcarsType
- The type of the messaging platform.gbcarsDescription
- A description of the association between the bot and the channel.gbcarsResponseStatus
- -- | The response status code.
data GetBotChannelAssociationResponse Source #
See: getBotChannelAssociationResponse
smart constructor.
Instances
Response Lenses
gbcarsFailureReason :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #
If status
is FAILED
, Amazon Lex provides the reason that it failed to create the association.
gbcarsStatus :: 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 the failureReason
field.
gbcarsBotAlias :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
gbcarsBotName :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #
The name of the Amazon Lex bot.
gbcarsBotConfiguration :: Lens' GetBotChannelAssociationResponse (Maybe (HashMap Text Text)) Source #
Provides information that the messaging platform needs to communicate with the Amazon Lex bot.
gbcarsCreatedDate :: Lens' GetBotChannelAssociationResponse (Maybe UTCTime) Source #
The date that the association between the bot and the channel was created.
gbcarsName :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #
The name of the association between the bot and the channel.
gbcarsType :: Lens' GetBotChannelAssociationResponse (Maybe ChannelType) Source #
The type of the messaging platform.
gbcarsDescription :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #
A description of the association between the bot and the channel.
gbcarsResponseStatus :: Lens' GetBotChannelAssociationResponse Int Source #
- - | The response status code.