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.GetBotChannelAssociation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- name :: Text
- botName :: Text
- botAlias :: Text
}
newGetBotChannelAssociation :: Text -> Text -> Text -> GetBotChannelAssociation
getBotChannelAssociation_name :: Lens' GetBotChannelAssociation Text
getBotChannelAssociation_botName :: Lens' GetBotChannelAssociation Text
getBotChannelAssociation_botAlias :: Lens' GetBotChannelAssociation Text
data GetBotChannelAssociationResponse = GetBotChannelAssociationResponse' {
- failureReason :: Maybe Text
- status :: Maybe ChannelStatus
- botAlias :: Maybe Text
- botName :: Maybe Text
- botConfiguration :: Maybe (Sensitive (HashMap Text Text))
- createdDate :: Maybe POSIX
- name :: Maybe Text
- type' :: Maybe ChannelType
- description :: Maybe Text
- httpStatus :: Int
}
newGetBotChannelAssociationResponse :: Int -> GetBotChannelAssociationResponse
getBotChannelAssociationResponse_failureReason :: Lens' GetBotChannelAssociationResponse (Maybe Text)
getBotChannelAssociationResponse_status :: Lens' GetBotChannelAssociationResponse (Maybe ChannelStatus)
getBotChannelAssociationResponse_botAlias :: Lens' GetBotChannelAssociationResponse (Maybe Text)
getBotChannelAssociationResponse_botName :: Lens' GetBotChannelAssociationResponse (Maybe Text)
getBotChannelAssociationResponse_botConfiguration :: Lens' GetBotChannelAssociationResponse (Maybe (HashMap Text Text))
getBotChannelAssociationResponse_createdDate :: Lens' GetBotChannelAssociationResponse (Maybe UTCTime)
getBotChannelAssociationResponse_name :: Lens' GetBotChannelAssociationResponse (Maybe Text)
getBotChannelAssociationResponse_type :: Lens' GetBotChannelAssociationResponse (Maybe ChannelType)
getBotChannelAssociationResponse_description :: Lens' GetBotChannelAssociationResponse (Maybe Text)
getBotChannelAssociationResponse_httpStatus :: Lens' GetBotChannelAssociationResponse Int

Creating a Request

data GetBotChannelAssociation Source #

See: newGetBotChannelAssociation smart constructor.

Constructors

GetBotChannelAssociation'
Fields name :: Text The name of the association between the bot and the channel. The name is case sensitive. botName :: Text The name of the Amazon Lex bot. botAlias :: Text An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

Instances

Instances details

Eq GetBotChannelAssociation Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Methods (==) :: GetBotChannelAssociation -> GetBotChannelAssociation -> Bool # (/=) :: GetBotChannelAssociation -> GetBotChannelAssociation -> Bool #
Read GetBotChannelAssociation Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Methods readsPrec :: Int -> ReadS GetBotChannelAssociation # readList :: ReadS [GetBotChannelAssociation] # readPrec :: ReadPrec GetBotChannelAssociation # readListPrec :: ReadPrec [GetBotChannelAssociation] #
Show GetBotChannelAssociation Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Methods showsPrec :: Int -> GetBotChannelAssociation -> ShowS # show :: GetBotChannelAssociation -> String # showList :: [GetBotChannelAssociation] -> ShowS #
Generic GetBotChannelAssociation Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Associated Types type Rep GetBotChannelAssociation :: Type -> Type # Methods from :: GetBotChannelAssociation -> Rep GetBotChannelAssociation x # to :: Rep GetBotChannelAssociation x -> GetBotChannelAssociation #
NFData GetBotChannelAssociation Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Methods rnf :: GetBotChannelAssociation -> () #
Hashable GetBotChannelAssociation Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Methods hashWithSalt :: Int -> GetBotChannelAssociation -> Int # hash :: GetBotChannelAssociation -> Int #
AWSRequest GetBotChannelAssociation Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Associated Types type AWSResponse GetBotChannelAssociation # Methods request :: GetBotChannelAssociation -> Request GetBotChannelAssociation # response :: MonadResource m => Logger -> Service -> Proxy GetBotChannelAssociation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBotChannelAssociation))) #
ToHeaders GetBotChannelAssociation Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Methods toHeaders :: GetBotChannelAssociation -> [Header] #
ToPath GetBotChannelAssociation Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Methods toPath :: GetBotChannelAssociation -> ByteString #
ToQuery GetBotChannelAssociation Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Methods toQuery :: GetBotChannelAssociation -> QueryString #
type Rep GetBotChannelAssociation Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation type Rep GetBotChannelAssociation = D1 ('MetaData "GetBotChannelAssociation" "Amazonka.LexModels.GetBotChannelAssociation" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "GetBotChannelAssociation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "botName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "botAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetBotChannelAssociation Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation type AWSResponse GetBotChannelAssociation = GetBotChannelAssociationResponse

newGetBotChannelAssociation Source #

Arguments

:: Text	`$sel:name:GetBotChannelAssociation'`
-> Text	`$sel:botName:GetBotChannelAssociation'`
-> Text	`$sel:botAlias:GetBotChannelAssociation'`
-> 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:

$sel:name:GetBotChannelAssociation', getBotChannelAssociation_name - The name of the association between the bot and the channel. The name is case sensitive.

$sel:botName:GetBotChannelAssociation', getBotChannelAssociation_botName - The name of the Amazon Lex bot.

$sel:botAlias: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.

Constructors

GetBotChannelAssociationResponse'

Fields

failureReason :: Maybe Text
If status is FAILED, Amazon Lex provides the reason that it failed to create the association.
status :: Maybe ChannelStatus
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.
botAlias :: Maybe Text
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
botName :: Maybe Text
The name of the Amazon Lex bot.
botConfiguration :: Maybe (Sensitive (HashMap Text Text))
Provides information that the messaging platform needs to communicate with the Amazon Lex bot.
createdDate :: Maybe POSIX
The date that the association between the bot and the channel was created.
name :: Maybe Text
The name of the association between the bot and the channel.
type' :: Maybe ChannelType
The type of the messaging platform.
description :: Maybe Text
A description of the association between the bot and the channel.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetBotChannelAssociationResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Methods (==) :: GetBotChannelAssociationResponse -> GetBotChannelAssociationResponse -> Bool # (/=) :: GetBotChannelAssociationResponse -> GetBotChannelAssociationResponse -> Bool #
Show GetBotChannelAssociationResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Methods showsPrec :: Int -> GetBotChannelAssociationResponse -> ShowS # show :: GetBotChannelAssociationResponse -> String # showList :: [GetBotChannelAssociationResponse] -> ShowS #
Generic GetBotChannelAssociationResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Associated Types type Rep GetBotChannelAssociationResponse :: Type -> Type # Methods from :: GetBotChannelAssociationResponse -> Rep GetBotChannelAssociationResponse x # to :: Rep GetBotChannelAssociationResponse x -> GetBotChannelAssociationResponse #
NFData GetBotChannelAssociationResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation Methods rnf :: GetBotChannelAssociationResponse -> () #
type Rep GetBotChannelAssociationResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotChannelAssociation type Rep GetBotChannelAssociationResponse = D1 ('MetaData "GetBotChannelAssociationResponse" "Amazonka.LexModels.GetBotChannelAssociation" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "GetBotChannelAssociationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelStatus))) :: (S1 ('MetaSel ('Just "botAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "botName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "botConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text))))))) :: ((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetBotChannelAssociationResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetBotChannelAssociationResponse'`
-> GetBotChannelAssociationResponse

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:

$sel:failureReason:GetBotChannelAssociationResponse', getBotChannelAssociationResponse_failureReason - If status is FAILED, Amazon Lex provides the reason that it failed to create the association.

$sel:status: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 the failureReason field.

$sel:botAlias:GetBotChannelAssociation', getBotChannelAssociationResponse_botAlias - An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

$sel:botName:GetBotChannelAssociation', getBotChannelAssociationResponse_botName - The name of the Amazon Lex bot.

$sel:botConfiguration:GetBotChannelAssociationResponse', getBotChannelAssociationResponse_botConfiguration - Provides information that the messaging platform needs to communicate with the Amazon Lex bot.

$sel:createdDate:GetBotChannelAssociationResponse', getBotChannelAssociationResponse_createdDate - The date that the association between the bot and the channel was created.

$sel:name:GetBotChannelAssociation', getBotChannelAssociationResponse_name - The name of the association between the bot and the channel.

$sel:type':GetBotChannelAssociationResponse', getBotChannelAssociationResponse_type - The type of the messaging platform.

$sel:description:GetBotChannelAssociationResponse', getBotChannelAssociationResponse_description - A description of the association between the bot and the channel.

$sel:httpStatus:GetBotChannelAssociationResponse', getBotChannelAssociationResponse_httpStatus - The response's http status code.

Response Lenses

getBotChannelAssociationResponse_failureReason :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #

If status is FAILED, Amazon Lex provides the reason that it failed to create the association.

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 the failureReason field.

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_botName :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #

The name of the Amazon Lex bot.

getBotChannelAssociationResponse_botConfiguration :: Lens' GetBotChannelAssociationResponse (Maybe (HashMap Text Text)) Source #

Provides information that the messaging platform needs to communicate with 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_name :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #

The name of the association between the bot and the channel.

getBotChannelAssociationResponse_type :: Lens' GetBotChannelAssociationResponse (Maybe ChannelType) Source #

The type of the messaging platform.

getBotChannelAssociationResponse_description :: Lens' GetBotChannelAssociationResponse (Maybe Text) Source #

A description of the association between the bot and the channel.

getBotChannelAssociationResponse_httpStatus :: Lens' GetBotChannelAssociationResponse Int Source #

The response's http status code.