ListSpeakersCommand

Suggest an Edit

Lists all speakers in a specified domain.

Example Syntax

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

import { VoiceIDClient, ListSpeakersCommand } from "@aws-sdk/client-voice-id"; // ES Modules import
// const { VoiceIDClient, ListSpeakersCommand } = require("@aws-sdk/client-voice-id"); // CommonJS import
const client = new VoiceIDClient(config);
const input = { // ListSpeakersRequest
  DomainId: "STRING_VALUE", // required
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListSpeakersCommand(input);
const response = await client.send(command);
// { // ListSpeakersResponse
//   SpeakerSummaries: [ // SpeakerSummaries
//     { // SpeakerSummary
//       DomainId: "STRING_VALUE",
//       CustomerSpeakerId: "STRING_VALUE",
//       GeneratedSpeakerId: "STRING_VALUE",
//       Status: "STRING_VALUE",
//       CreatedAt: new Date("TIMESTAMP"),
//       UpdatedAt: new Date("TIMESTAMP"),
//       LastAccessedAt: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListSpeakersCommand Input

See ListSpeakersCommandInput for more details

Parameter
Type
Description
DomainId
Required
string | undefined

The identifier of the domain.

MaxResults
number | undefined

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

NextToken
string | undefined

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

ListSpeakersCommand Output

See ListSpeakersCommandOutput for details

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

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

SpeakerSummaries
SpeakerSummary[] | undefined

A list containing details about each speaker in the Amazon Web Services account.

Throws

Name
Fault
Details
AccessDeniedException
client

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

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.