GetVoiceToneAnalysisTaskCommand

Suggest an Edit

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 { ChimeSDKVoiceClient, GetVoiceToneAnalysisTaskCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
// const { ChimeSDKVoiceClient, GetVoiceToneAnalysisTaskCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
const client = new ChimeSDKVoiceClient(config);
const input = { // GetVoiceToneAnalysisTaskRequest
  VoiceConnectorId: "STRING_VALUE", // required
  VoiceToneAnalysisTaskId: "STRING_VALUE", // required
  IsCaller: true || false, // required
};
const command = new GetVoiceToneAnalysisTaskCommand(input);
const response = await client.send(command);
// { // GetVoiceToneAnalysisTaskResponse
//   VoiceToneAnalysisTask: { // VoiceToneAnalysisTask
//     VoiceToneAnalysisTaskId: "STRING_VALUE",
//     VoiceToneAnalysisTaskStatus: "STRING_VALUE",
//     CallDetails: { // CallDetails
//       VoiceConnectorId: "STRING_VALUE",
//       TransactionId: "STRING_VALUE",
//       IsCaller: true || false,
//     },
//     CreatedTimestamp: new Date("TIMESTAMP"),
//     UpdatedTimestamp: new Date("TIMESTAMP"),
//     StartedTimestamp: new Date("TIMESTAMP"),
//     StatusMessage: "STRING_VALUE",
//   },
// };

GetVoiceToneAnalysisTaskCommand Input

See GetVoiceToneAnalysisTaskCommandInput for more details

Parameter
Type
Description
IsCaller
Required
boolean | undefined

Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).

VoiceConnectorId
Required
string | undefined

The Voice Connector ID.

VoiceToneAnalysisTaskId
Required
string | undefined

The ID of the voice tone analysis task.

GetVoiceToneAnalysisTaskCommand Output

See GetVoiceToneAnalysisTaskCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
VoiceToneAnalysisTask
VoiceToneAnalysisTask | undefined

The details of the voice tone analysis task.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have the permissions needed to run this action.

BadRequestException
client

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

ConflictException
client

Multiple instances of the same request were made simultaneously.

ForbiddenException
client

The client is permanently forbidden from making the request.

NotFoundException
client

The requested resource couldn't be found.

ServiceFailureException
server

The service encountered an unexpected error.

ServiceUnavailableException
server

The service is currently unavailable.

ThrottledClientException
client

The number of customer requests exceeds the request rate limit.

UnauthorizedClientException
client

The client isn't authorized to request a resource.

ChimeSDKVoiceServiceException
Base exception class for all service exceptions from ChimeSDKVoice service.