Skip to content

AssistantSummary

Source code in docs_src/capo_qconnect/types/assistant_summary.py
class AssistantSummary(TypedDict, closed=True):
    assistant_id: "capo_qconnect.types.uuid.Uuid"
    """<p>The identifier of the Amazon Q in Connect assistant.</p>"""
    assistant_arn: "capo_qconnect.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>"""
    name: "capo_qconnect.types.name.Name"
    """<p>The name of the assistant.</p>"""
    type: "capo_qconnect.types.assistant_type.AssistantType"
    """<p>The type of the assistant.</p>"""
    status: "capo_qconnect.types.assistant_status.AssistantStatus"
    """<p>The status of the assistant.</p>"""
    description: NotRequired["capo_qconnect.types.description.Description"]
    """<p>The description of the assistant.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""
    server_side_encryption_configuration: NotRequired[
        "capo_qconnect.types.server_side_encryption_configuration.ServerSideEncryptionConfiguration"
    ]
    """<p>The configuration information for the customer managed key used for encryption. </p> <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>, <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and <code>kms:GenerateDataKey*</code> 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 <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service principal. </p> <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.</p>"""
    integration_configuration: NotRequired[
        "capo_qconnect.types.assistant_integration_configuration.AssistantIntegrationConfiguration"
    ]
    """<p>The configuration information for the Amazon Q in Connect assistant integration.</p>"""
    capability_configuration: NotRequired[
        "capo_qconnect.types.assistant_capability_configuration.AssistantCapabilityConfiguration"
    ]
    """<p>The configuration information for the Amazon Q in Connect assistant capability. </p>"""
    ai_agent_configuration: NotRequired[
        "capo_qconnect.types.ai_agent_configuration_map.AIAgentConfigurationMap"
    ]
    """<p>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.</p>"""
    orchestrator_configuration_list: NotRequired[
        "capo_qconnect.types.orchestrator_configuration_list.OrchestratorConfigurationList"
    ]
    """<p>The list of orchestrator configurations for the assistant.</p>"""

ai_agent_configuration instance-attribute

ai_agent_configuration: NotRequired[AIAgentConfigurationMap]

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.

assistant_arn instance-attribute

assistant_arn: Arn

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

assistant_id instance-attribute

assistant_id: Uuid

The identifier of the Amazon Q in Connect assistant.

capability_configuration instance-attribute

capability_configuration: NotRequired[AssistantCapabilityConfiguration]

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

description instance-attribute

description: NotRequired[Description]

The description of the assistant.

integration_configuration instance-attribute

integration_configuration: NotRequired[AssistantIntegrationConfiguration]

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

name instance-attribute

name: Name

The name of the assistant.

orchestrator_configuration_list instance-attribute

orchestrator_configuration_list: NotRequired[OrchestratorConfigurationList]

The list of orchestrator configurations for the assistant.

server_side_encryption_configuration instance-attribute

server_side_encryption_configuration: NotRequired[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.

status instance-attribute

The status of the assistant.

tags instance-attribute

tags: NotRequired[Tags]

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

type instance-attribute

The type of the assistant.