Chime / Client / put_voice_connector_streaming_configuration

put_voice_connector_streaming_configuration#

Chime.Client.put_voice_connector_streaming_configuration(**kwargs)#

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorStreamingConfiguration, 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_streaming_configuration(
    VoiceConnectorId='string',
    StreamingConfiguration={
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ]
    }
)
Parameters:

  • VoiceConnectorId (string) –

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • StreamingConfiguration (dict) –

    [REQUIRED]

    The streaming configuration details to add.

    • DataRetentionInHours (integer) – [REQUIRED]

      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) – [REQUIRED]

          The streaming notification target.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • StreamingConfiguration (dict) –

      The updated 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