ChimeSDKVoice / Client / get_voice_tone_analysis_task

get_voice_tone_analysis_task#

ChimeSDKVoice.Client.get_voice_tone_analysis_task(**kwargs)#

Retrieves the details of a voice tone analysis task.

See also: AWS API Documentation

Request Syntax

response = client.get_voice_tone_analysis_task(
    VoiceConnectorId='string',
    VoiceToneAnalysisTaskId='string',
    IsCaller=True|False
)
Parameters:

  • VoiceConnectorId (string) –

    [REQUIRED]

    The Voice Connector ID.

  • VoiceToneAnalysisTaskId (string) –

    [REQUIRED]

    The ID of the voice tone analysis task.

  • IsCaller (boolean) –

    [REQUIRED]

    Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).

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

      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