Class: Aws::LexModelBuildingService::Types::BotChannelAssociation

Inherits:

Struct

• Object
• Struct
• Aws::LexModelBuildingService::Types::BotChannelAssociation

Defined in:

(unknown)

Overview

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

See Also:

• AWS API Documentation

Instance Attribute Summary

• #bot_alias ⇒ String

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

• #bot_configuration ⇒ Hash<String,String>

  Provides information necessary to communicate with the messaging platform.

• #bot_name ⇒ String

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

• #created_date ⇒ Time

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

• #description ⇒ String

  A text description of the association you are creating.

• #failure_reason ⇒ String

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

• #name ⇒ String

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

• #status ⇒ String

  The status of the bot channel.

• #type ⇒ String

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

Instance Attribute Details

#bot_alias ⇒ String

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

Returns:

• (String) —

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

#bot_configuration ⇒ Hash<String,String>

Provides information necessary to communicate with the messaging platform.

Returns:

• (Hash<String,String>) —

  Provides information necessary to communicate with the messaging platform.

#bot_name ⇒ String

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.

Returns:

• (String) —

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

#created_date ⇒ Time

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

Returns:

• (Time) —

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

#description ⇒ String

A text description of the association you are creating.

Returns:

• (String) —

  A text description of the association you are creating.

#failure_reason ⇒ String

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

Returns:

• (String) —

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

#name ⇒ String

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

Returns:

• (String) —

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

#status ⇒ String

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.

  Possible values:

  • IN_PROGRESS
  • CREATED
  • FAILED

Returns:

• (String) —

  The status of the bot channel.

#type ⇒ String

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

Possible values:

• Facebook
• Slack
• Twilio-Sms
• Kik

Returns:

• (String) —

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