Class: Aws::Lex::Types::GetSessionRequest

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

Overview

Note:

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

{
  bot_name: "BotName", # required
  bot_alias: "BotAlias", # required
  user_id: "UserId", # required
  checkpoint_label_filter: "IntentSummaryCheckpointLabel",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bot_aliasString

The alias in use for the bot that contains the session data.

Returns:

  • (String)


331
332
333
334
335
336
337
338
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 331

class GetSessionRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :checkpoint_label_filter)
  SENSITIVE = []
  include Aws::Structure
end

#bot_nameString

The name of the bot that contains the session data.

Returns:

  • (String)


331
332
333
334
335
336
337
338
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 331

class GetSessionRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :checkpoint_label_filter)
  SENSITIVE = []
  include Aws::Structure
end

#checkpoint_label_filterString

A string used to filter the intents returned in the recentIntentSummaryView structure.

When you specify a filter, only intents with their checkpointLabel field set to that string are returned.

Returns:

  • (String)


331
332
333
334
335
336
337
338
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 331

class GetSessionRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :checkpoint_label_filter)
  SENSITIVE = []
  include Aws::Structure
end

#user_idString

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Returns:

  • (String)


331
332
333
334
335
336
337
338
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 331

class GetSessionRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :checkpoint_label_filter)
  SENSITIVE = []
  include Aws::Structure
end