You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#bot_aliasString

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

Returns:

  • (String)


116
117
118
119
120
121
122
123
124
125
126
127
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 116

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

#bot_configurationHash<String,String>

Provides information necessary to communicate with the messaging platform.

Returns:

  • (Hash<String,String>)


116
117
118
119
120
121
122
123
124
125
126
127
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 116

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

#bot_nameString

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)


116
117
118
119
120
121
122
123
124
125
126
127
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 116

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

#created_dateTime

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

Returns:

  • (Time)


116
117
118
119
120
121
122
123
124
125
126
127
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 116

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

#descriptionString

A text description of the association you are creating.

Returns:

  • (String)


116
117
118
119
120
121
122
123
124
125
126
127
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 116

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

#failure_reasonString

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

Returns:

  • (String)


116
117
118
119
120
121
122
123
124
125
126
127
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 116

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

#nameString

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

Returns:

  • (String)


116
117
118
119
120
121
122
123
124
125
126
127
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 116

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

#statusString

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)


116
117
118
119
120
121
122
123
124
125
126
127
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 116

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

#typeString

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)


116
117
118
119
120
121
122
123
124
125
126
127
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 116

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