QConnect / Client / create_assistant

create_assistant#

QConnect.Client.create_assistant(**kwargs)#

Creates an Amazon Q in Connect assistant.

See also: AWS API Documentation

Request Syntax

response = client.create_assistant(
    clientToken='string',
    description='string',
    name='string',
    serverSideEncryptionConfiguration={
        'kmsKeyId': 'string'
    },
    tags={
        'string': 'string'
    },
    type='AGENT'
)
Parameters:

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    This field is autopopulated if not provided.

  • description (string) – The description of the assistant.

  • name (string) –

    [REQUIRED]

    The name of the assistant.

  • serverSideEncryptionConfiguration (dict) –

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

    The customer managed 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. To use Amazon Q 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, see Enable Amazon Q in Connect for your instance.

  • tags (dict) –

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

    • (string) –

      • (string) –

  • type (string) –

    [REQUIRED]

    The type of assistant.

Return type:

dict

Returns:

Response Syntax

{
    'assistant': {
        'assistantArn': 'string',
        'assistantId': 'string',
        'capabilityConfiguration': {
            'type': 'V1'|'V2'
        },
        '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 Amazon Q assistant.

      • assistantId (string) –

        The identifier of the Amazon Q assistant.

      • capabilityConfiguration (dict) –

        The configuration information for the Amazon Q assistant capability.

        • type (string) –

          The type of Amazon Q assistant capability.

      • description (string) –

        The description.

      • integrationConfiguration (dict) –

        The configuration information for the Amazon Q 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, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q. To use Amazon Q 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, see Enable Amazon Q in Connect 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

  • QConnect.Client.exceptions.ConflictException

  • QConnect.Client.exceptions.ValidationException

  • QConnect.Client.exceptions.ServiceQuotaExceededException

  • QConnect.Client.exceptions.AccessDeniedException