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:



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#assistant_arn ⇒ String

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

Returns:

  • (String) 


1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#assistant_global_resiliency_status ⇒ String

Whether Amazon Connect Global Resiliency replicates the Connect instance this assistant is associated with, and so whether resources created under this assistant must satisfy the replication group's model parity constraint. Answered from the ACGR side per request rather than stored, so it reflects the customer's replication state now.

Absent means "not applicable or not known" - never read an absent field as DISABLED. It is absent on the operations that return an assistant which is not yet associated with a Connect instance, because replication cannot be established until it is.

Returns:

  • (String) 


1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#assistant_id ⇒ String

The identifier of the Amazon Q in Connect assistant.

Returns:

  • (String) 


1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#capability_configuration ⇒ Types::AssistantCapabilityConfiguration

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

Returns:



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description.

Returns:

  • (String) 


1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#integration_configuration ⇒ Types::AssistantIntegrationConfiguration

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

Returns:



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_region ⇒ String

The Amazon Web Services Region where the assistant was last modified.

Returns:

  • (String) 


1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

The timestamp when the assistant was last modified.

Returns:

  • (Time) 


1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name.

Returns:

  • (String) 


1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#orchestrator_configuration_list ⇒ Array<Types::OrchestratorConfigurationEntry>

The list of orchestrator configurations for the assistant.

Returns:



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  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:



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the assistant.

Returns:

  • (String) 


1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  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>) 


1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of assistant.

Returns:

  • (String) 


1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1505

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,
  :last_modified_time,
  :last_modified_region,
  :assistant_global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end