- 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.
ListAvailableVoiceConnectorRegionsCommand
Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ChimeSDKVoiceClient, ListAvailableVoiceConnectorRegionsCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
// const { ChimeSDKVoiceClient, ListAvailableVoiceConnectorRegionsCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
const client = new ChimeSDKVoiceClient(config);
const input = {};
const command = new ListAvailableVoiceConnectorRegionsCommand(input);
const response = await client.send(command);
// { // ListAvailableVoiceConnectorRegionsResponse
// VoiceConnectorRegions: [ // VoiceConnectorAwsRegionList
// "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",
// ],
// };
ListAvailableVoiceConnectorRegionsCommand Input
See ListAvailableVoiceConnectorRegionsCommandInput for more details
ListAvailableVoiceConnectorRegionsCommandInput ListAvailableVoiceConnectorRegionsCommand Output
See ListAvailableVoiceConnectorRegionsCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
VoiceConnectorRegions | VoiceConnectorAwsRegion[] | undefined | The list of AWS Regions. |
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. |