ConnectWisdomService / Client / list_assistants

list_assistants#

ConnectWisdomService.Client.list_assistants(**kwargs)#

Lists information about assistants.

See also: AWS API Documentation

Request Syntax

response = client.list_assistants(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – The maximum number of results to return per page.

  • nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'assistantSummaries': [
        {
            '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'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • assistantSummaries (list) –

      Information about the assistants.

      • (dict) –

        Summary 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 of the assistant.

        • 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 of the assistant.

        • serverSideEncryptionConfiguration (dict) –

          The configuration information for the customer managed key used for encryption.

          This KMS key must have a policy that allows kms:CreateGrant and kms:DescribeKey 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 the assistant.

    • nextToken (string) –

      If there are additional results, this is the token for the next set of results.

Exceptions

  • ConnectWisdomService.Client.exceptions.ValidationException

  • ConnectWisdomService.Client.exceptions.AccessDeniedException