DeleteSpeakerCommand

Suggest an Edit

Deletes the specified speaker from Voice ID.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { VoiceIDClient, DeleteSpeakerCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
// const { VoiceIDClient, DeleteSpeakerCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
const client = new VoiceIDClient(config);
const input = { // DeleteSpeakerRequest
  DomainId: "STRING_VALUE", // required
  SpeakerId: "STRING_VALUE", // required
};
const command = new DeleteSpeakerCommand(input);
const response = await client.send(command);
// {};

DeleteSpeakerCommand Input

See DeleteSpeakerCommandInput for more details

Parameter
Type
Description
DomainId
Required
string | undefined

The identifier of the domain that contains the speaker.

SpeakerId
Required
string | undefined

The identifier of the speaker you want to delete.

DeleteSpeakerCommand Output

See DeleteSpeakerCommandOutput for details

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

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient permissions to perform this action. Check the error message and try again.

ConflictException
client

The request failed due to a conflict. Check the ConflictType and error message for more details.

InternalServerException
server

The request failed due to an unknown error on the server side.

ResourceNotFoundException
client

The specified resource cannot be found. Check the ResourceType and error message for more details.

ThrottlingException
client

The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas   and try your request again.

ValidationException
client

The request failed one or more validations; check the error message for more details.

VoiceIDServiceException
Base exception class for all service exceptions from VoiceID service.