Amazon Connect Wisdom Service

2023/07/25 - Amazon Connect Wisdom Service - 5 updated api methods

Changes  This release added two new data types: AssistantIntegrationConfiguration, and SessionIntegrationConfiguration to support Wisdom integration with Amazon Connect Chat

CreateAssistant (updated) Link ¶
Changes (response) 
{'assistant': {'integrationConfiguration': {'topicIntegrationArn': 'string'}}}

Creates an Amazon Connect Wisdom assistant.

See also: AWS API Documentation

Request Syntax

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

string

param clientToken

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.

type description

string

param description

The description of the assistant.

type name

string

param name

[REQUIRED]

The name of the assistant.

type serverSideEncryptionConfiguration

dict

param serverSideEncryptionConfiguration

The KMS key used for encryption.

type tags

dict

param tags

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

  • (string) --

    • (string) --

type type

string

param type

[REQUIRED]

The type of assistant.

rtype

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 KMS key used for encryption.

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

CreateSession (updated) Link ¶
Changes (response) 
{'session': {'integrationConfiguration': {'topicIntegrationArn': 'string'}}}

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.

See also: AWS API Documentation

Request Syntax

client.create_session(
    assistantId='string',
    clientToken='string',
    description='string',
    name='string',
    tags={
        'string': 'string'
    }
)
type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type clientToken

string

param clientToken

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.

type description

string

param description

The description.

type name

string

param name

[REQUIRED]

The name of the session.

type tags

dict

param tags

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

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'session': {
        'description': 'string',
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'name': 'string',
        'sessionArn': 'string',
        'sessionId': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • session (dict) --

      The session.

      • description (string) --

        The description of the session.

      • integrationConfiguration (dict) --

        The configuration information for the session 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 session.

      • sessionArn (string) --

        The Amazon Resource Name (ARN) of the session.

      • sessionId (string) --

        The identifier of the session.

      • tags (dict) --

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

        • (string) --

          • (string) --

GetAssistant (updated) Link ¶
Changes (response) 
{'assistant': {'integrationConfiguration': {'topicIntegrationArn': 'string'}}}

Retrieves information about an assistant.

See also: AWS API Documentation

Request Syntax

client.get_assistant(
    assistantId='string'
)
type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

rtype

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 KMS key used for encryption.

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

GetSession (updated) Link ¶
Changes (response) 
{'session': {'integrationConfiguration': {'topicIntegrationArn': 'string'}}}

Retrieves information for a specified session.

See also: AWS API Documentation

Request Syntax

client.get_session(
    assistantId='string',
    sessionId='string'
)
type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type sessionId

string

param sessionId

[REQUIRED]

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

rtype

dict

returns

Response Syntax

{
    'session': {
        'description': 'string',
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'name': 'string',
        'sessionArn': 'string',
        'sessionId': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • session (dict) --

      The session.

      • description (string) --

        The description of the session.

      • integrationConfiguration (dict) --

        The configuration information for the session 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 session.

      • sessionArn (string) --

        The Amazon Resource Name (ARN) of the session.

      • sessionId (string) --

        The identifier of the session.

      • tags (dict) --

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

        • (string) --

          • (string) --

ListAssistants (updated) Link ¶
Changes (response) 
{'assistantSummaries': {'integrationConfiguration': {'topicIntegrationArn': 'string'}}}

Lists information about assistants.

See also: AWS API Documentation

Request Syntax

client.list_assistants(
    maxResults=123,
    nextToken='string'
)
type maxResults

integer

param maxResults

The maximum number of results to return per page.

type nextToken

string

param nextToken

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.

rtype

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 KMS key used for encryption.

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