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

Class: Aws::LexModelBuildingService::Types::GetBotChannelAssociationsRequest

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

Overview

Note:

When making an API call, you may pass GetBotChannelAssociationsRequest data as a hash:

{
  bot_name: "BotName", # required
  bot_alias: "AliasNameOrListAll", # required
  next_token: "NextToken",
  max_results: 1,
  name_contains: "BotChannelName",
}

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)


1183
1184
1185
1186
1187
1188
1189
1190
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 1183

class GetBotChannelAssociationsRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :next_token,
  :max_results,
  :name_contains)
  include Aws::Structure
end

#bot_nameString

The name of the Amazon Lex bot in the association.

Returns:

  • (String)


1183
1184
1185
1186
1187
1188
1189
1190
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 1183

class GetBotChannelAssociationsRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :next_token,
  :max_results,
  :name_contains)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of associations to return in the response. The default is 50.

Returns:

  • (Integer)


1183
1184
1185
1186
1187
1188
1189
1190
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 1183

class GetBotChannelAssociationsRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :next_token,
  :max_results,
  :name_contains)
  include Aws::Structure
end

#name_containsString

Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the nameContains parameter.

Returns:

  • (String)


1183
1184
1185
1186
1187
1188
1189
1190
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 1183

class GetBotChannelAssociationsRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :next_token,
  :max_results,
  :name_contains)
  include Aws::Structure
end

#next_tokenString

A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

Returns:

  • (String)


1183
1184
1185
1186
1187
1188
1189
1190
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 1183

class GetBotChannelAssociationsRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :next_token,
  :max_results,
  :name_contains)
  include Aws::Structure
end