Method: Aws::ChimeSDKMediaPipelines::Client#start_speaker_search_task

Defined in:

lib/aws-sdk-chimesdkmediapipelines/client.rb

#start_speaker_search_task(params = {}) ⇒ Types::StartSpeakerSearchTaskResponse

Starts a speaker search task.

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.

[1]: aws.amazon.com/service-terms/

Examples:

Request syntax with placeholder values

resp = client.start_speaker_search_task({
  identifier: "NonEmptyString", # required
  voice_profile_domain_arn: "Arn", # required
  kinesis_video_stream_source_task_configuration: {
    stream_arn: "KinesisVideoStreamArn", # required
    channel_id: 1, # required
    fragment_number: "FragmentNumberString",
  },
  client_request_token: "ClientRequestToken",
})

Response structure

resp.speaker_search_task.speaker_search_task_id #=> String
resp.speaker_search_task.speaker_search_task_status #=> String, one of "NotStarted", "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
resp.speaker_search_task.created_timestamp #=> Time
resp.speaker_search_task.updated_timestamp #=> Time

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :identifier (required, String) —

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

• :voice_profile_domain_arn (required, String) —

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

• :kinesis_video_stream_source_task_configuration (Types::KinesisVideoStreamSourceTaskConfiguration) —

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

• :client_request_token (String) —

  The unique identifier for the client request. Use a different token for different speaker search tasks.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

• (Types::StartSpeakerSearchTaskResponse) —

  Returns a response object which responds to the following methods:

  • #speaker_search_task => Types::SpeakerSearchTask

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2160

def start_speaker_search_task(params = {}, options = {})
  req = build_request(:start_speaker_search_task, params)
  req.send_request(options)
end