:doc:`ChimeSDKVoice <../../chime-sdk-voice>` / Client / start_voice_tone_analysis_task

******************************
start_voice_tone_analysis_task
******************************



.. py:method:: ChimeSDKVoice.Client.start_voice_tone_analysis_task(**kwargs)

  

  Starts a voice tone analysis task. For more information about voice tone analysis, see `Using Amazon Chime SDK voice analytics <https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html>`__ in the *Amazon Chime SDK Developer Guide*.

   

  .. warning::

     

    Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the `AWS service terms <https://aws.amazon.com/service-terms/>`__ for the Amazon Chime SDK.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask>`_  


  **Request Syntax**
  ::

    response = client.start_voice_tone_analysis_task(
        VoiceConnectorId='string',
        TransactionId='string',
        LanguageCode='en-US',
        ClientRequestToken='string'
    )
    
  :type VoiceConnectorId: string
  :param VoiceConnectorId: **[REQUIRED]** 

    The Voice Connector ID.

    

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

    The transaction ID.

    

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

    The language code.

    

  
  :type ClientRequestToken: string
  :param ClientRequestToken: 

    The unique identifier for the client request. Use a different token for different voice tone analysis tasks.

    

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

    
    ::

      {
          'VoiceToneAnalysisTask': {
              'VoiceToneAnalysisTaskId': 'string',
              'VoiceToneAnalysisTaskStatus': 'string',
              'CallDetails': {
                  'VoiceConnectorId': 'string',
                  'TransactionId': 'string',
                  'IsCaller': True|False
              },
              'CreatedTimestamp': datetime(2015, 1, 1),
              'UpdatedTimestamp': datetime(2015, 1, 1),
              'StartedTimestamp': datetime(2015, 1, 1),
              'StatusMessage': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **VoiceToneAnalysisTask** *(dict) --* 

        The details of the voice tone analysis task.

        
        

        - **VoiceToneAnalysisTaskId** *(string) --* 

          The ID of the voice tone analysis task.

          
        

        - **VoiceToneAnalysisTaskStatus** *(string) --* 

          The status of a voice tone analysis task, ``IN_QUEUE``, ``IN_PROGRESS``, ``PARTIAL_SUCCESS``, ``SUCCEEDED``, ``FAILED``, or ``STOPPED``.

          
        

        - **CallDetails** *(dict) --* 

          The call details of a voice tone analysis task.

          
          

          - **VoiceConnectorId** *(string) --* 

            The Voice Connector ID.

            
          

          - **TransactionId** *(string) --* 

            The transaction ID of a Voice Connector call.

            
          

          - **IsCaller** *(boolean) --* 

            Identifies a person as the caller or the callee.

            
      
        

        - **CreatedTimestamp** *(datetime) --* 

          The time at which a voice tone analysis task was created.

          
        

        - **UpdatedTimestamp** *(datetime) --* 

          The time at which a voice tone analysis task was updated.

          
        

        - **StartedTimestamp** *(datetime) --* 

          The time at which a voice tone analysis task started.

          
        

        - **StatusMessage** *(string) --* 

          The status of a voice tone analysis task.

          
    
  
  **Exceptions**
  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.BadRequestException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.UnauthorizedClientException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ForbiddenException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.NotFoundException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ConflictException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.GoneException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.UnprocessableEntityException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ThrottledClientException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ServiceFailureException`

  