ChimeSDKVoice / Client / get_voice_connector_termination_health

get_voice_connector_termination_health#

ChimeSDKVoice.Client.get_voice_connector_termination_health(**kwargs)#

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.

Request Syntax

response = client.get_voice_connector_termination_health(
    VoiceConnectorId='string'
)

Parameters:

VoiceConnectorId (string) –

[REQUIRED]

The Voice Connector ID.

Return type:

dict

Returns:

Response Syntax

{
    'TerminationHealth': {
        'Timestamp': datetime(2015, 1, 1),
        'Source': 'string'
    }
}

Response Structure

(dict) –
- TerminationHealth (dict) –
  
  The termination health details.
  - Timestamp (datetime) –
    
    The timestamp, in ISO 8601 format.
  - Source (string) –
    
    The source IP address.

Exceptions

ChimeSDKVoice.Client.exceptions.UnauthorizedClientException
ChimeSDKVoice.Client.exceptions.NotFoundException
ChimeSDKVoice.Client.exceptions.ForbiddenException
ChimeSDKVoice.Client.exceptions.BadRequestException
ChimeSDKVoice.Client.exceptions.ThrottledClientException
ChimeSDKVoice.Client.exceptions.ServiceUnavailableException
ChimeSDKVoice.Client.exceptions.ServiceFailureException