ConnectWisdomService / Client / get_assistant

get_assistant#

ConnectWisdomService.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 Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type:

dict

Returns:

Response Syntax

{
    'assistant': {
        'assistantArn': 'string',
        'assistantId': 'string',
        'description': 'string',
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'name': 'string',
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string'
        },
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'tags': {
            'string': 'string'
        },
        'type': 'AGENT'
    }
}

Response Structure

  • (dict) –

    • assistant (dict) –

      Information about the assistant.

      • assistantArn (string) –

        The Amazon Resource Name (ARN) of the Wisdom assistant.

      • assistantId (string) –

        The identifier of the Wisdom assistant.

      • description (string) –

        The description.

      • integrationConfiguration (dict) –

        The configuration information for the Wisdom assistant integration.

        • topicIntegrationArn (string) –

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

      • name (string) –

        The name.

      • 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, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom for your instance.

      • status (string) –

        The status of the assistant.

      • tags (dict) –

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

        • (string) –

          • (string) –

      • type (string) –

        The type of assistant.

Exceptions