Chime / Client / put_voice_connector_logging_configuration

put_voice_connector_logging_configuration#

Chime.Client.put_voice_connector_logging_configuration(**kwargs)#

Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_logging_configuration(
    VoiceConnectorId='string',
    LoggingConfiguration={
        'EnableSIPLogs': True|False,
        'EnableMediaMetricLogs': True|False
    }
)
Parameters:

  • VoiceConnectorId (string) –

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • LoggingConfiguration (dict) –

    [REQUIRED]

    The logging configuration details to add.

    • EnableSIPLogs (boolean) –

      Boolean that enables SIP message logs to Amazon CloudWatch logs.

    • EnableMediaMetricLogs (boolean) –

      Boolean that enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • LoggingConfiguration (dict) –

      The updated logging configuration details.

      • EnableSIPLogs (boolean) –

        Boolean that enables SIP message logs to Amazon CloudWatch logs.

      • EnableMediaMetricLogs (boolean) –

        Boolean that enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.NotFoundException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException