ChimeSDKVoice / Client / get_voice_connector_logging_configuration

get_voice_connector_logging_configuration#

ChimeSDKVoice.Client.get_voice_connector_logging_configuration(**kwargs)#

Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

See also: AWS API Documentation

Request Syntax

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

Parameters:

VoiceConnectorId (string) –

[REQUIRED]

The Voice Connector ID.

Return type:

dict

Returns:

Response Syntax

{
    'LoggingConfiguration': {
        'EnableSIPLogs': True|False,
        'EnableMediaMetricLogs': True|False
    }
}

Response Structure

(dict) –
- LoggingConfiguration (dict) –
  
  The logging configuration details .
  - EnableSIPLogs (boolean) –
    
    Boolean that enables sending SIP message logs to Amazon CloudWatch.
  - EnableMediaMetricLogs (boolean) –
    
    Enables or disables media metrics logging.

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