Amazonka.LexModels.Types.BotChannelAssociation

Documentation

data BotChannelAssociation

Represents an association between an Amazon Lex bot and an external messaging platform.

See: newBotChannelAssociation smart constructor.

Constructors

BotChannelAssociation'

Fields

• botAlias :: Maybe Text

  An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

• botConfiguration :: Maybe (Sensitive (HashMap Text Text))

  Provides information necessary to communicate with the messaging platform.

• botName :: Maybe Text

  The name of the Amazon Lex bot to which this association is being made.

  Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.

• createdDate :: Maybe POSIX

  The date that the association between the Amazon Lex bot and the channel was created.

• description :: Maybe Text

  A text description of the association you are creating.

• failureReason :: Maybe Text

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

• name :: Maybe Text

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

• 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.
• type' :: Maybe ChannelType

  Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.

Instances

FromJSON BotChannelAssociation

Defined in Amazonka.LexModels.Types.BotChannelAssociation

Methods

parseJSON :: Value -> Parser BotChannelAssociation

parseJSONList :: Value -> Parser [BotChannelAssociation]

Generic BotChannelAssociation

Defined in Amazonka.LexModels.Types.BotChannelAssociation

Associated Types

type Rep BotChannelAssociation :: Type -> Type

Methods

from :: BotChannelAssociation -> Rep BotChannelAssociation x

to :: Rep BotChannelAssociation x -> BotChannelAssociation

Show BotChannelAssociation

Defined in Amazonka.LexModels.Types.BotChannelAssociation

Methods

showsPrec :: Int -> BotChannelAssociation -> ShowS

show :: BotChannelAssociation -> String

showList :: [BotChannelAssociation] -> ShowS

NFData BotChannelAssociation

Defined in Amazonka.LexModels.Types.BotChannelAssociation

Methods

rnf :: BotChannelAssociation -> ()

Eq BotChannelAssociation

Defined in Amazonka.LexModels.Types.BotChannelAssociation

Methods

(==) :: BotChannelAssociation -> BotChannelAssociation -> Bool

(/=) :: BotChannelAssociation -> BotChannelAssociation -> Bool

Hashable BotChannelAssociation

Defined in Amazonka.LexModels.Types.BotChannelAssociation

Methods

hashWithSalt :: Int -> BotChannelAssociation -> Int

hash :: BotChannelAssociation -> Int

type Rep BotChannelAssociation

Defined in Amazonka.LexModels.Types.BotChannelAssociation

type Rep BotChannelAssociation = D1 ('MetaData "BotChannelAssociation" "Amazonka.LexModels.Types.BotChannelAssociation" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "BotChannelAssociation'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "botAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "botConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text))))) :*: (S1 ('MetaSel ('Just "botName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelStatus)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType)))))))

newBotChannelAssociation :: BotChannelAssociation

Create a value of BotChannelAssociation 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:botAlias:BotChannelAssociation', botChannelAssociation_botAlias - An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

$sel:botConfiguration:BotChannelAssociation', botChannelAssociation_botConfiguration - Provides information necessary to communicate with the messaging platform.

$sel:botName:BotChannelAssociation', botChannelAssociation_botName - The name of the Amazon Lex bot to which this association is being made.

Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.

$sel:createdDate:BotChannelAssociation', botChannelAssociation_createdDate - The date that the association between the Amazon Lex bot and the channel was created.

$sel:description:BotChannelAssociation', botChannelAssociation_description - A text description of the association you are creating.

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

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

$sel:status:BotChannelAssociation', botChannelAssociation_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:type':BotChannelAssociation', botChannelAssociation_type - Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.

botChannelAssociation_botAlias :: Lens' BotChannelAssociation (Maybe Text)

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

botChannelAssociation_botConfiguration :: Lens' BotChannelAssociation (Maybe (HashMap Text Text))

Provides information necessary to communicate with the messaging platform.

botChannelAssociation_botName :: Lens' BotChannelAssociation (Maybe Text)

The name of the Amazon Lex bot to which this association is being made.

Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.

botChannelAssociation_createdDate :: Lens' BotChannelAssociation (Maybe UTCTime)

The date that the association between the Amazon Lex bot and the channel was created.

botChannelAssociation_description :: Lens' BotChannelAssociation (Maybe Text)

A text description of the association you are creating.

botChannelAssociation_failureReason :: Lens' BotChannelAssociation (Maybe Text)

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

botChannelAssociation_name :: Lens' BotChannelAssociation (Maybe Text)

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

botChannelAssociation_status :: Lens' BotChannelAssociation (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.

botChannelAssociation_type :: Lens' BotChannelAssociation (Maybe ChannelType)

Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.