GetVoiceConnectorProxyCommand

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

Example Syntax

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

import { ChimeSDKVoiceClient, GetVoiceConnectorProxyCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
// const { ChimeSDKVoiceClient, GetVoiceConnectorProxyCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
const client = new ChimeSDKVoiceClient(config);
const input = { // GetVoiceConnectorProxyRequest
  VoiceConnectorId: "STRING_VALUE", // required
};
const command = new GetVoiceConnectorProxyCommand(input);
const response = await client.send(command);
// { // GetVoiceConnectorProxyResponse
//   Proxy: { // Proxy
//     DefaultSessionExpiryMinutes: Number("int"),
//     Disabled: true || false,
//     FallBackPhoneNumber: "STRING_VALUE",
//     PhoneNumberCountries: [ // StringList
//       "STRING_VALUE",
//     ],
//   },
// };

GetVoiceConnectorProxyCommand Input

Parameter
Type
Description
VoiceConnectorId
Required
string | undefined

The Voice Connector ID.

GetVoiceConnectorProxyCommand Output

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

The proxy configuration details.

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.