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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[:bot_configuration]

Instance Attribute Summary collapse

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) 


153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 153

class BotChannelAssociation < Struct.new(
  :name,
  :description,
  :bot_alias,
  :bot_name,
  :created_date,
  :type,
  :bot_configuration,
  :status,
  :failure_reason)
  SENSITIVE = [:bot_configuration]
  include Aws::Structure
end

#bot_configuration ⇒ Hash<String,String>

Provides information necessary to communicate with the messaging platform.

Returns:

  • (Hash<String,String>) 


153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 153

class BotChannelAssociation < Struct.new(
  :name,
  :description,
  :bot_alias,
  :bot_name,
  :created_date,
  :type,
  :bot_configuration,
  :status,
  :failure_reason)
  SENSITIVE = [:bot_configuration]
  include Aws::Structure
end

#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) 


153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 153

class BotChannelAssociation < Struct.new(
  :name,
  :description,
  :bot_alias,
  :bot_name,
  :created_date,
  :type,
  :bot_configuration,
  :status,
  :failure_reason)
  SENSITIVE = [:bot_configuration]
  include Aws::Structure
end

#created_date ⇒ Time

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

Returns:

  • (Time) 


153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 153

class BotChannelAssociation < Struct.new(
  :name,
  :description,
  :bot_alias,
  :bot_name,
  :created_date,
  :type,
  :bot_configuration,
  :status,
  :failure_reason)
  SENSITIVE = [:bot_configuration]
  include Aws::Structure
end

#description ⇒ String

A text description of the association you are creating.

Returns:

  • (String) 


153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 153

class BotChannelAssociation < Struct.new(
  :name,
  :description,
  :bot_alias,
  :bot_name,
  :created_date,
  :type,
  :bot_configuration,
  :status,
  :failure_reason)
  SENSITIVE = [:bot_configuration]
  include Aws::Structure
end

#failure_reason ⇒ String

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

Returns:

  • (String) 


153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 153

class BotChannelAssociation < Struct.new(
  :name,
  :description,
  :bot_alias,
  :bot_name,
  :created_date,
  :type,
  :bot_configuration,
  :status,
  :failure_reason)
  SENSITIVE = [:bot_configuration]
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 


153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 153

class BotChannelAssociation < Struct.new(
  :name,
  :description,
  :bot_alias,
  :bot_name,
  :created_date,
  :type,
  :bot_configuration,
  :status,
  :failure_reason)
  SENSITIVE = [:bot_configuration]
  include Aws::Structure
end

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

Returns:

  • (String) 


153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 153

class BotChannelAssociation < Struct.new(
  :name,
  :description,
  :bot_alias,
  :bot_name,
  :created_date,
  :type,
  :bot_configuration,
  :status,
  :failure_reason)
  SENSITIVE = [:bot_configuration]
  include Aws::Structure
end

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

Returns:

  • (String) 


153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 153

class BotChannelAssociation < Struct.new(
  :name,
  :description,
  :bot_alias,
  :bot_name,
  :created_date,
  :type,
  :bot_configuration,
  :status,
  :failure_reason)
  SENSITIVE = [:bot_configuration]
  include Aws::Structure
end