- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetVoiceToneAnalysisTaskCommand
Retrieves the details of a voice tone analysis task.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ChimeSDKMediaPipelinesClient, GetVoiceToneAnalysisTaskCommand } from "@aws-sdk/client-chime-sdk-media-pipelines"; // ES Modules import
// const { ChimeSDKMediaPipelinesClient, GetVoiceToneAnalysisTaskCommand } = require("@aws-sdk/client-chime-sdk-media-pipelines"); // CommonJS import
const client = new ChimeSDKMediaPipelinesClient(config);
const input = { // GetVoiceToneAnalysisTaskRequest
Identifier: "STRING_VALUE", // required
VoiceToneAnalysisTaskId: "STRING_VALUE", // required
};
const command = new GetVoiceToneAnalysisTaskCommand(input);
const response = await client.send(command);
// { // GetVoiceToneAnalysisTaskResponse
// VoiceToneAnalysisTask: { // VoiceToneAnalysisTask
// VoiceToneAnalysisTaskId: "STRING_VALUE",
// VoiceToneAnalysisTaskStatus: "NotStarted" || "Initializing" || "InProgress" || "Failed" || "Stopping" || "Stopped",
// CreatedTimestamp: new Date("TIMESTAMP"),
// UpdatedTimestamp: new Date("TIMESTAMP"),
// },
// };
GetVoiceToneAnalysisTaskCommand Input
See GetVoiceToneAnalysisTaskCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
IdentifierRequired | string | undefined | The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline. |
VoiceToneAnalysisTaskIdRequired | string | undefined | The ID of the voice tone analysis task. |
GetVoiceToneAnalysisTaskCommand Output
See GetVoiceToneAnalysisTaskCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
VoiceToneAnalysisTask | VoiceToneAnalysisTask | undefined | The details of the voice tone analysis task. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| BadRequestException | client | The input parameters don't match the service's restrictions. |
| ForbiddenException | client | The client is permanently forbidden from making the request. |
| NotFoundException | client | One or more of the resources in the request does not exist in the system. |
| ServiceFailureException | server | The service encountered an unexpected error. |
| ServiceUnavailableException | server | The service is currently unavailable. |
| ThrottledClientException | client | The client exceeded its request rate limit. |
| UnauthorizedClientException | client | The client is not currently authorized to make the request. |
| ChimeSDKMediaPipelinesServiceException | Base exception class for all service exceptions from ChimeSDKMediaPipelines service. |