ListVoiceProfilesCommand

Suggest an Edit

Lists the voice profiles in a voice profile domain.

Example Syntax

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

import { ChimeSDKVoiceClient, ListVoiceProfilesCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
// const { ChimeSDKVoiceClient, ListVoiceProfilesCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
const client = new ChimeSDKVoiceClient(config);
const input = { // ListVoiceProfilesRequest
  VoiceProfileDomainId: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListVoiceProfilesCommand(input);
const response = await client.send(command);
// { // ListVoiceProfilesResponse
//   VoiceProfiles: [ // VoiceProfileSummaryList
//     { // VoiceProfileSummary
//       VoiceProfileId: "STRING_VALUE",
//       VoiceProfileArn: "STRING_VALUE",
//       VoiceProfileDomainId: "STRING_VALUE",
//       CreatedTimestamp: new Date("TIMESTAMP"),
//       UpdatedTimestamp: new Date("TIMESTAMP"),
//       ExpirationTimestamp: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListVoiceProfilesCommand Input

See ListVoiceProfilesCommandInput for more details

Parameter
Type
Description
VoiceProfileDomainId
Required
string | undefined

The ID of the voice profile domain.

MaxResults
number | undefined

The maximum number of results in the request.

NextToken
string | undefined

The token used to retrieve the next page of results.

ListVoiceProfilesCommand Output

See ListVoiceProfilesCommandOutput for details

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

The token used to retrieve the next page of results.

VoiceProfiles
VoiceProfileSummary[] | undefined

The list of voice profiles.

Throws

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

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.