- 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.
ListVoiceConnectorsCommand
Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ChimeSDKVoiceClient, ListVoiceConnectorsCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
// const { ChimeSDKVoiceClient, ListVoiceConnectorsCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
const client = new ChimeSDKVoiceClient(config);
const input = { // ListVoiceConnectorsRequest
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new ListVoiceConnectorsCommand(input);
const response = await client.send(command);
// { // ListVoiceConnectorsResponse
// VoiceConnectors: [ // VoiceConnectorList
// { // VoiceConnector
// VoiceConnectorId: "STRING_VALUE",
// AwsRegion: "us-east-1" || "us-west-2" || "ca-central-1" || "eu-central-1" || "eu-west-1" || "eu-west-2" || "ap-northeast-2" || "ap-northeast-1" || "ap-southeast-1" || "ap-southeast-2",
// Name: "STRING_VALUE",
// OutboundHostName: "STRING_VALUE",
// RequireEncryption: true || false,
// CreatedTimestamp: new Date("TIMESTAMP"),
// UpdatedTimestamp: new Date("TIMESTAMP"),
// VoiceConnectorArn: "STRING_VALUE",
// IntegrationType: "CONNECT_CALL_TRANSFER_CONNECTOR" || "CONNECT_ANALYTICS_CONNECTOR",
// },
// ],
// NextToken: "STRING_VALUE",
// };
ListVoiceConnectorsCommand Input
See ListVoiceConnectorsCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
MaxResults | number | undefined | The maximum number of results to return in a single call. |
NextToken | string | undefined | The token used to return the next page of results. |
ListVoiceConnectorsCommand Output
See ListVoiceConnectorsCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
NextToken | string | undefined | The token used to return the next page of results. |
VoiceConnectors | VoiceConnector[] | undefined | The details of the Voice Connectors. |
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. |
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. |