Class: Aws::LexRuntimeV2::Types::PutSessionRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bot_alias_id ⇒ String

The alias identifier of the bot that receives the session data.

Returns:

  • (String) 


930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 930

class PutSessionRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :messages,
  :session_state,
  :request_attributes,
  :response_content_type)
  SENSITIVE = []
  include Aws::Structure
end

#bot_id ⇒ String

The identifier of the bot that receives the session data.

Returns:

  • (String) 


930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 930

class PutSessionRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :messages,
  :session_state,
  :request_attributes,
  :response_content_type)
  SENSITIVE = []
  include Aws::Structure
end

#locale_id ⇒ String

The locale where the session is in use.

Returns:

  • (String) 


930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 930

class PutSessionRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :messages,
  :session_state,
  :request_attributes,
  :response_content_type)
  SENSITIVE = []
  include Aws::Structure
end

#messages ⇒ Array<Types::Message>

A list of messages to send to the user. Messages are sent in the order that they are defined in the list.

Returns:



930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 930

class PutSessionRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :messages,
  :session_state,
  :request_attributes,
  :response_content_type)
  SENSITIVE = []
  include Aws::Structure
end

#request_attributes ⇒ Hash<String,String>

Request-specific information passed between Amazon Lex V2 and the client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

Returns:

  • (Hash<String,String>) 


930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 930

class PutSessionRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :messages,
  :session_state,
  :request_attributes,
  :response_content_type)
  SENSITIVE = []
  include Aws::Structure
end

#response_content_type ⇒ String

The message that Amazon Lex V2 returns in the response can be either text or speech depending on the value of this parameter.

  • If the value is text/plain; charset=utf-8, Amazon Lex V2 returns text in the response.

^

Returns:

  • (String) 


930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 930

class PutSessionRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :messages,
  :session_state,
  :request_attributes,
  :response_content_type)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The identifier of the session that receives the session data.

Returns:

  • (String) 


930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 930

class PutSessionRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :messages,
  :session_state,
  :request_attributes,
  :response_content_type)
  SENSITIVE = []
  include Aws::Structure
end

#session_state ⇒ Types::SessionState

Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

Returns:



930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 930

class PutSessionRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :messages,
  :session_state,
  :request_attributes,
  :response_content_type)
  SENSITIVE = []
  include Aws::Structure
end