Connect / Client / start_contact_streaming

start_contact_streaming#

Connect.Client.start_contact_streaming(**kwargs)#

Initiates real-time message streaming for a new chat contact.

For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

For more information about chat, see the following topics in the Amazon Connect Administrator Guide:

See also: AWS API Documentation

Request Syntax

response = client.start_contact_streaming(
    InstanceId='string',
    ContactId='string',
    ChatStreamingConfiguration={
        'StreamingEndpointArn': 'string'
    },
    ClientToken='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ContactId (string) –

    [REQUIRED]

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • ChatStreamingConfiguration (dict) –

    [REQUIRED]

    The streaming configuration, such as the Amazon SNS streaming endpoint.

    • StreamingEndpointArn (string) – [REQUIRED]

      The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish real-time message streaming for chat conversations.

  • ClientToken (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'StreamingId': 'string'
}

Response Structure

  • (dict) –

    • StreamingId (string) –

      The identifier of the streaming configuration enabled.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.LimitExceededException