:doc:`Connect <../../connect>` / Client / start_contact_streaming

***********************
start_contact_streaming
***********************



.. py:method:: 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 <https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html>`__ in the *Amazon Connect Administrator Guide*.

   

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

   

  
  * `Concepts\: Web and mobile messaging capabilities in Amazon Connect <https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html>`__
   
  * `Amazon Connect Chat security best practices <https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat>`__
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactStreaming>`_  


  **Request Syntax**
  ::

    response = client.start_contact_streaming(
        InstanceId='string',
        ContactId='string',
        ChatStreamingConfiguration={
            'StreamingEndpointArn': 'string'
        },
        ClientToken='string'
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

  
  :type ContactId: string
  :param ContactId: **[REQUIRED]** 

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

    

  
  :type ChatStreamingConfiguration: dict
  :param ChatStreamingConfiguration: **[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.

      

    
  
  :type ClientToken: string
  :param ClientToken: **[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 <https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/>`__.

    This field is autopopulated if not provided.

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'StreamingId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **StreamingId** *(string) --* 

        The identifier of the streaming configuration enabled.

        
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`Connect.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  
  *   :py:class:`Connect.Client.exceptions.LimitExceededException`

  