ChimeSDKVoice / Client / start_voice_tone_analysis_task

start_voice_tone_analysis_task#

ChimeSDKVoice.Client.start_voice_tone_analysis_task(**kwargs)#

See also: AWS API Documentation

Request Syntax

response = client.start_voice_tone_analysis_task(
    VoiceConnectorId='string',
    TransactionId='string',
    LanguageCode='en-US',
    ClientRequestToken='string'
)
Parameters:

  • VoiceConnectorId (string) – [REQUIRED]

  • TransactionId (string) – [REQUIRED]

  • LanguageCode (string) – [REQUIRED]

  • ClientRequestToken (string) –

Return type:

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) –

      • VoiceToneAnalysisTaskId (string) –

      • VoiceToneAnalysisTaskStatus (string) –

      • CallDetails (dict) –

        • VoiceConnectorId (string) –

        • TransactionId (string) –

        • IsCaller (boolean) –

      • CreatedTimestamp (datetime) –

      • UpdatedTimestamp (datetime) –

      • StartedTimestamp (datetime) –

      • StatusMessage (string) –

Exceptions

  • ChimeSDKVoice.Client.exceptions.BadRequestException

  • ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException

  • ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

  • ChimeSDKVoice.Client.exceptions.ForbiddenException

  • ChimeSDKVoice.Client.exceptions.AccessDeniedException

  • ChimeSDKVoice.Client.exceptions.NotFoundException

  • ChimeSDKVoice.Client.exceptions.ConflictException

  • ChimeSDKVoice.Client.exceptions.GoneException

  • ChimeSDKVoice.Client.exceptions.UnprocessableEntityException

  • ChimeSDKVoice.Client.exceptions.ThrottledClientException

  • ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

  • ChimeSDKVoice.Client.exceptions.ServiceFailureException