QConnect / Client / get_assistant

get_assistant

QConnect.Client.get_assistant(**kwargs)

Retrieves information about an assistant.

See also: AWS API Documentation

Request Syntax

response = client.get_assistant(
    assistantId='string'
)
Parameters:

assistantId (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'assistant': {
        'assistantId': 'string',
        'assistantArn': 'string',
        'name': 'string',
        'type': 'AGENT',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'description': 'string',
        'tags': {
            'string': 'string'
        },
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string',
            'replicaKmsKeys': [
                {
                    'arn': 'string'
                },
            ]
        },
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'capabilityConfiguration': {
            'type': 'V1'|'V2'
        },
        'aiAgentConfiguration': {
            'string': {
                'aiAgentId': 'string',
                'enabled': True|False
            }
        },
        'orchestratorConfigurationList': [
            {
                'aiAgentId': 'string',
                'orchestratorUseCase': 'string'
            },
        ],
        'lastModifiedTime': datetime(2015, 1, 1),
        'lastModifiedRegion': 'string',
        'assistantGlobalResiliencyStatus': 'ENABLED'|'DISABLED'
    }
}

Response Structure

  • (dict) –

    • assistant (dict) –

      Information about the assistant.

      • assistantId (string) –

        The identifier of the Amazon Q in Connect assistant.

      • assistantArn (string) –

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

      • name (string) –

        The name.

      • type (string) –

        The type of assistant.

      • status (string) –

        The status of the assistant.

      • description (string) –

        The description.

      • tags (dict) –

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

        • (string) –

          • (string) –

      • serverSideEncryptionConfiguration (dict) –

        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.

        • kmsKeyId (string) –

          The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).

        • replicaKmsKeys (list) –

          The list of KMS keys used to encrypt data for this resource’s replicas in other Amazon Web Services Regions. Each entry corresponds to a Region where a replica is configured.

          • (dict) –

            Contains information about the KMS key used to encrypt data in a replica Amazon Web Services Region, including its Amazon Resource Name (ARN).

            • arn (string) –

              The Amazon Resource Name (ARN) of the KMS key in the replica Region.

      • integrationConfiguration (dict) –

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

        • topicIntegrationArn (string) –

          The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

      • capabilityConfiguration (dict) –

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

        • type (string) –

          The type of Amazon Q in Connect assistant capability.

      • aiAgentConfiguration (dict) –

        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.

        • (string) –

          • (dict) –

            A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.

            • aiAgentId (string) –

              The ID of the AI Agent to be configured.

            • enabled (boolean) –

              Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.

      • orchestratorConfigurationList (list) –

        The list of orchestrator configurations for the assistant.

        • (dict) –

          An entry in the orchestrator configuration list.

          • aiAgentId (string) –

            The identifier of the AI Agent in the orchestrator configuration.

          • orchestratorUseCase (string) –

            The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)

      • lastModifiedTime (datetime) –

        The timestamp when the assistant was last modified.

      • lastModifiedRegion (string) –

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

      • assistantGlobalResiliencyStatus (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.

Exceptions