ChimeSDKMediaPipelines / Client / get_voice_tone_analysis_task

get_voice_tone_analysis_task

ChimeSDKMediaPipelines.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(
    Identifier='string',
    VoiceToneAnalysisTaskId='string'
)

Parameters:

• Identifier (string) –

  [REQUIRED]

  The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

• VoiceToneAnalysisTaskId (string) –

  [REQUIRED]

  The ID of the voice tone analysis task.

Return type:

dict

Returns:

Response Syntax

{
    'VoiceToneAnalysisTask': {
        'VoiceToneAnalysisTaskId': 'string',
        'VoiceToneAnalysisTaskStatus': 'NotStarted'|'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

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.

    • 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.

Exceptions

• ChimeSDKMediaPipelines.Client.exceptions.BadRequestException

• ChimeSDKMediaPipelines.Client.exceptions.ForbiddenException

• ChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientException

• ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException

• ChimeSDKMediaPipelines.Client.exceptions.NotFoundException

• ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException

• ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException