GetProxySessionCommand

Suggest an Edit

Retrieves the specified proxy session 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, GetProxySessionCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
// const { ChimeSDKVoiceClient, GetProxySessionCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
const client = new ChimeSDKVoiceClient(config);
const input = { // GetProxySessionRequest
  VoiceConnectorId: "STRING_VALUE", // required
  ProxySessionId: "STRING_VALUE", // required
};
const command = new GetProxySessionCommand(input);
const response = await client.send(command);
// { // GetProxySessionResponse
//   ProxySession: { // ProxySession
//     VoiceConnectorId: "STRING_VALUE",
//     ProxySessionId: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Status: "Open" || "InProgress" || "Closed",
//     ExpiryMinutes: Number("int"),
//     Capabilities: [ // CapabilityList
//       "Voice" || "SMS",
//     ],
//     CreatedTimestamp: new Date("TIMESTAMP"),
//     UpdatedTimestamp: new Date("TIMESTAMP"),
//     EndedTimestamp: new Date("TIMESTAMP"),
//     Participants: [ // Participants
//       { // Participant
//         PhoneNumber: "STRING_VALUE",
//         ProxyPhoneNumber: "STRING_VALUE",
//       },
//     ],
//     NumberSelectionBehavior: "PreferSticky" || "AvoidSticky",
//     GeoMatchLevel: "Country" || "AreaCode",
//     GeoMatchParams: { // GeoMatchParams
//       Country: "STRING_VALUE", // required
//       AreaCode: "STRING_VALUE", // required
//     },
//   },
// };

GetProxySessionCommand Input

See GetProxySessionCommandInput for more details

Parameter
Type
Description
ProxySessionId
Required
string | undefined

The proxy session ID.

VoiceConnectorId
Required
string | undefined

The Voice Connector ID.

GetProxySessionCommand Output

See GetProxySessionCommandOutput for details

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

The proxy session 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.