StartVoiceToneAnalysisTask - Amazon Chime SDK


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.


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.

Request Syntax

POST /media-insights-pipelines/identifier/voice-tone-analysis-tasks?operation=start HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "KinesisVideoStreamSourceTaskConfiguration": { "ChannelId": number, "FragmentNumber": "string", "StreamArn": "string" }, "LanguageCode": "string" }

URI Request Parameters

The request uses the following URI parameters.


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.


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

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: No


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

Type: KinesisVideoStreamSourceTaskConfiguration object

Required: No


The language code.

Type: String

Valid Values: en-US

Required: Yes

Response Syntax

HTTP/1.1 201 Content-type: application/json { "VoiceToneAnalysisTask": { "CreatedTimestamp": "string", "UpdatedTimestamp": "string", "VoiceToneAnalysisTaskId": "string", "VoiceToneAnalysisTaskStatus": "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.


The details of the voice tone analysis task.

Type: VoiceToneAnalysisTask object


For information about the errors that are common to all actions, see Common Errors.


The input parameters don't match the service's restrictions.

HTTP Status Code: 400


The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409


The client is permanently forbidden from making the request.

HTTP Status Code: 403


One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The client exceeded its request rate limit.

HTTP Status Code: 429


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: