ChimeSDKMediaPipelines / Client / start_speaker_search_task

start_speaker_search_task#

ChimeSDKMediaPipelines.Client.start_speaker_search_task(**kwargs)#

Starts a speaker search task.

Warning

Before starting any speaker search 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_speaker_search_task(
    Identifier='string',
    VoiceProfileDomainArn='string',
    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.

  • VoiceProfileDomainArn (string) –

    [REQUIRED]

    The ARN of the voice profile domain that will store the voice profile.

  • 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 speaker search tasks.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'SpeakerSearchTask': {
        'SpeakerSearchTaskId': 'string',
        'SpeakerSearchTaskStatus': 'NotStarted'|'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • SpeakerSearchTask (dict) –

      The details of the speaker search task.

      • SpeakerSearchTaskId (string) –

        The speaker search task ID.

      • SpeakerSearchTaskStatus (string) –

        The status of the speaker search task.

      • CreatedTimestamp (datetime) –

        The time at which a speaker search task was created.

      • UpdatedTimestamp (datetime) –

        The time at which a speaker search task was updated.

Exceptions