StartSpeakerSearchTask
Starts a speaker search task.
Important
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
Request Syntax
POST /media-insights-pipelines/identifier/speaker-search-tasks?operation=start HTTP/1.1
Content-type: application/json
{
"ClientRequestToken": "string",
"KinesisVideoStreamSourceTaskConfiguration": {
"ChannelId": number,
"FragmentNumber": "string",
"StreamArn": "string"
},
"VoiceProfileDomainArn": "string"
}URI Request Parameters
The request uses the following URI parameters.
- identifier
-
The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
Length Constraints: Maximum length of 1024.
Pattern:
.*\S.*Required: Yes
Request Body
The request accepts the following data in JSON format.
- ClientRequestToken
-
The unique identifier for the client request. Use a different token for different speaker search tasks.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 64.
Pattern:
[-_a-zA-Z0-9]*Required: No
- KinesisVideoStreamSourceTaskConfiguration
-
The task configuration for the Kinesis video stream source of the media insights pipeline.
Type: KinesisVideoStreamSourceTaskConfiguration object
Required: No
- VoiceProfileDomainArn
-
The ARN of the voice profile domain that will store the voice profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^arn[\/\:\-\_\.a-zA-Z0-9]+$Required: Yes
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"SpeakerSearchTask": {
"CreatedTimestamp": "string",
"SpeakerSearchTaskId": "string",
"SpeakerSearchTaskStatus": "string",
"UpdatedTimestamp": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- SpeakerSearchTask
-
The details of the speaker search task.
Type: SpeakerSearchTask object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
- ConflictException
-
The request could not be processed because of conflict in the current state of the resource.
HTTP Status Code: 409
- ForbiddenException
-
The client is permanently forbidden from making the request.
HTTP Status Code: 403
- NotFoundException
-
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404
- ServiceFailureException
-
The service encountered an unexpected error.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is currently unavailable.
HTTP Status Code: 503
- ThrottledClientException
-
The client exceeded its request rate limit.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client is not currently authorized to make the request.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
