Class: Aws::QConnect::Types::CreateSessionRequest

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::CreateSessionRequest

Defined in:

gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #ai_agent_configuration ⇒ Hash<String,Types::AIAgentConfigurationData>

  The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

• #assistant_id ⇒ String

  The identifier of the Amazon Q in Connect assistant.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #contact_arn ⇒ String

  The Amazon Resource Name (ARN) of the email contact in Amazon Connect.

• #description ⇒ String

  The description.

• #name ⇒ String

  The name of the session.

• #orchestrator_configuration_list ⇒ Array<Types::OrchestratorConfigurationEntry>

  The list of orchestrator configurations for the session being created.

• #remove_orchestrator_configuration_list ⇒ Boolean

  The list of orchestrator configurations to remove from the session.

• #tag_filter ⇒ Types::TagFilter

  An object that can be used to specify Tag conditions.

• #tags ⇒ Hash<String,String>

  The tags used to organize, track, or control access for this resource.

Instance Attribute Details

#ai_agent_configuration ⇒ Hash<String,Types::AIAgentConfigurationData>

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

Returns:

• (Hash<String,Types::AIAgentConfigurationData>)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3340

class CreateSessionRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :description,
  :tags,
  :tag_filter,
  :ai_agent_configuration,
  :contact_arn,
  :orchestrator_configuration_list,
  :remove_orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#assistant_id ⇒ String

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3340

class CreateSessionRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :description,
  :tags,
  :tag_filter,
  :ai_agent_configuration,
  :contact_arn,
  :orchestrator_configuration_list,
  :remove_orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3340

class CreateSessionRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :description,
  :tags,
  :tag_filter,
  :ai_agent_configuration,
  :contact_arn,
  :orchestrator_configuration_list,
  :remove_orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#contact_arn ⇒ String

The Amazon Resource Name (ARN) of the email contact in Amazon Connect. Used to retrieve email content and establish session context for AI-powered email assistance.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3340

class CreateSessionRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :description,
  :tags,
  :tag_filter,
  :ai_agent_configuration,
  :contact_arn,
  :orchestrator_configuration_list,
  :remove_orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3340

class CreateSessionRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :description,
  :tags,
  :tag_filter,
  :ai_agent_configuration,
  :contact_arn,
  :orchestrator_configuration_list,
  :remove_orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the session.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3340

class CreateSessionRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :description,
  :tags,
  :tag_filter,
  :ai_agent_configuration,
  :contact_arn,
  :orchestrator_configuration_list,
  :remove_orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#orchestrator_configuration_list ⇒ Array<Types::OrchestratorConfigurationEntry>

The list of orchestrator configurations for the session being created.

Returns:

• (Array<Types::OrchestratorConfigurationEntry>)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3340

class CreateSessionRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :description,
  :tags,
  :tag_filter,
  :ai_agent_configuration,
  :contact_arn,
  :orchestrator_configuration_list,
  :remove_orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#remove_orchestrator_configuration_list ⇒ Boolean

The list of orchestrator configurations to remove from the session.

Returns:

• (Boolean)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3340

class CreateSessionRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :description,
  :tags,
  :tag_filter,
  :ai_agent_configuration,
  :contact_arn,
  :orchestrator_configuration_list,
  :remove_orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#tag_filter ⇒ Types::TagFilter

An object that can be used to specify Tag conditions.

Returns:

• (Types::TagFilter)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3340

class CreateSessionRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :description,
  :tags,
  :tag_filter,
  :ai_agent_configuration,
  :contact_arn,
  :orchestrator_configuration_list,
  :remove_orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3340

class CreateSessionRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :description,
  :tags,
  :tag_filter,
  :ai_agent_configuration,
  :contact_arn,
  :orchestrator_configuration_list,
  :remove_orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end