Class: Aws::QConnect::Types::AssistantData

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

Overview

The assistant data.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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 is set on the Amazon Q in Connect Assistant.

Returns:



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1396

class AssistantData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :name,
  :type,
  :status,
  :description,
  :tags,
  :server_side_encryption_configuration,
  :integration_configuration,
  :capability_configuration,
  :ai_agent_configuration,
  :orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#assistant_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

Returns:

  • (String) 


1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1396

class AssistantData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :name,
  :type,
  :status,
  :description,
  :tags,
  :server_side_encryption_configuration,
  :integration_configuration,
  :capability_configuration,
  :ai_agent_configuration,
  :orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#assistant_id ⇒ String

The identifier of the Amazon Q in Connect assistant.

Returns:

  • (String) 


1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1396

class AssistantData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :name,
  :type,
  :status,
  :description,
  :tags,
  :server_side_encryption_configuration,
  :integration_configuration,
  :capability_configuration,
  :ai_agent_configuration,
  :orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#capability_configuration ⇒ Types::AssistantCapabilityConfiguration

The configuration information for the Amazon Q in Connect assistant capability.

Returns:



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1396

class AssistantData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :name,
  :type,
  :status,
  :description,
  :tags,
  :server_side_encryption_configuration,
  :integration_configuration,
  :capability_configuration,
  :ai_agent_configuration,
  :orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description.

Returns:

  • (String) 


1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1396

class AssistantData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :name,
  :type,
  :status,
  :description,
  :tags,
  :server_side_encryption_configuration,
  :integration_configuration,
  :capability_configuration,
  :ai_agent_configuration,
  :orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#integration_configuration ⇒ Types::AssistantIntegrationConfiguration

The configuration information for the Amazon Q in Connect assistant integration.

Returns:



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1396

class AssistantData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :name,
  :type,
  :status,
  :description,
  :tags,
  :server_side_encryption_configuration,
  :integration_configuration,
  :capability_configuration,
  :ai_agent_configuration,
  :orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name.

Returns:

  • (String) 


1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1396

class AssistantData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :name,
  :type,
  :status,
  :description,
  :tags,
  :server_side_encryption_configuration,
  :integration_configuration,
  :capability_configuration,
  :ai_agent_configuration,
  :orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#orchestrator_configuration_list ⇒ Array<Types::OrchestratorConfigurationEntry>

The list of orchestrator configurations for the assistant.

Returns:



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1396

class AssistantData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :name,
  :type,
  :status,
  :description,
  :tags,
  :server_side_encryption_configuration,
  :integration_configuration,
  :capability_configuration,
  :ai_agent_configuration,
  :orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

Returns:



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1396

class AssistantData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :name,
  :type,
  :status,
  :description,
  :tags,
  :server_side_encryption_configuration,
  :integration_configuration,
  :capability_configuration,
  :ai_agent_configuration,
  :orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the assistant.

Returns:

  • (String) 


1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1396

class AssistantData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :name,
  :type,
  :status,
  :description,
  :tags,
  :server_side_encryption_configuration,
  :integration_configuration,
  :capability_configuration,
  :ai_agent_configuration,
  :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>) 


1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1396

class AssistantData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :name,
  :type,
  :status,
  :description,
  :tags,
  :server_side_encryption_configuration,
  :integration_configuration,
  :capability_configuration,
  :ai_agent_configuration,
  :orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of assistant.

Returns:

  • (String) 


1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1396

class AssistantData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :name,
  :type,
  :status,
  :description,
  :tags,
  :server_side_encryption_configuration,
  :integration_configuration,
  :capability_configuration,
  :ai_agent_configuration,
  :orchestrator_configuration_list)
  SENSITIVE = []
  include Aws::Structure
end