ChimeSDKMediaPipelines / Client / start_voice_tone_analysis_task

start_voice_tone_analysis_task#

ChimeSDKMediaPipelines.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 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 for the Amazon Chime SDK.

See also: AWS API Documentation

Request Syntax

response = client.start_voice_tone_analysis_task(
    Identifier='string',
    LanguageCode='en-US',
    KinesisVideoStreamSourceTaskConfiguration={
        'StreamArn': 'string',
        'ChannelId': 123,
        'FragmentNumber': 'string'
    },
    ClientRequestToken='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.

  • LanguageCode (string) –

    [REQUIRED]

    The language code.

  • KinesisVideoStreamSourceTaskConfiguration (dict) –

    The task configuration for the Kinesis video stream source of the media insights pipeline.

    • StreamArn (string) – [REQUIRED]

      The ARN of the stream.

    • ChannelId (integer) – [REQUIRED]

      The channel ID.

    • FragmentNumber (string) –

      The unique identifier of the fragment to begin processing.

  • ClientRequestToken (string) –

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

    This field is autopopulated if not provided.

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