Chime / Client / get_voice_connector_streaming_configuration

get_voice_connector_streaming_configuration#

Chime.Client.get_voice_connector_streaming_configuration(**kwargs)#

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_streaming_configuration(
    VoiceConnectorId='string'
)
Parameters:

VoiceConnectorId (string) –

[REQUIRED]

The Amazon Chime Voice Connector ID.

Return type:

dict

Returns:

Response Syntax

{
    'StreamingConfiguration': {
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • StreamingConfiguration (dict) –

      The streaming configuration details.

      • DataRetentionInHours (integer) –

        The retention period, in hours, for the Amazon Kinesis data.

      • Disabled (boolean) –

        When true, media streaming to Amazon Kinesis is turned off.

      • StreamingNotificationTargets (list) –

        The streaming notification targets.

        • (dict) –

          The targeted recipient for a streaming configuration notification.

          • NotificationTarget (string) –

            The streaming notification target.

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