- 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.
GetVoiceConnectorTerminationHealthCommand
Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure 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, GetVoiceConnectorTerminationHealthCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
// const { ChimeSDKVoiceClient, GetVoiceConnectorTerminationHealthCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
const client = new ChimeSDKVoiceClient(config);
const input = { // GetVoiceConnectorTerminationHealthRequest
VoiceConnectorId: "STRING_VALUE", // required
};
const command = new GetVoiceConnectorTerminationHealthCommand(input);
const response = await client.send(command);
// { // GetVoiceConnectorTerminationHealthResponse
// TerminationHealth: { // TerminationHealth
// Timestamp: new Date("TIMESTAMP"),
// Source: "STRING_VALUE",
// },
// };
GetVoiceConnectorTerminationHealthCommand Input
See GetVoiceConnectorTerminationHealthCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
VoiceConnectorIdRequired | string | undefined | The Voice Connector ID. |
GetVoiceConnectorTerminationHealthCommand Output
See GetVoiceConnectorTerminationHealthCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
TerminationHealth | TerminationHealth | undefined | The termination health details. |
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. |
| 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. |