get_assistant

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',
        '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.

    • name (string) --

      The name.

    • serverSideEncryptionConfiguration (dict) --

      The KMS key used for encryption.

      • kmsKeyId (string) --

        The KMS key. For information about valid ID values, see Key identifiers (KeyId).

    • 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

• ConnectWisdomService.Client.exceptions.ValidationException
• ConnectWisdomService.Client.exceptions.AccessDeniedException
• ConnectWisdomService.Client.exceptions.ResourceNotFoundException