KinesisVideo / Client / update_media_storage_configuration

update_media_storage_configuration#

KinesisVideo.Client.update_media_storage_configuration(**kwargs)#

Warning

This API is related to WebRTC Ingestion and is only available in the us-west-2 region.

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can specified :

  • If the StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed.

  • If the StorageStatus is enabled, the data will be stored in the StreamARN provided.

Warning

If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP offer send and establish a connection between a peer and the storage session.

See also: AWS API Documentation

Request Syntax

response = client.update_media_storage_configuration(
    ChannelARN='string',
    MediaStorageConfiguration={
        'StreamARN': 'string',
        'Status': 'ENABLED'|'DISABLED'
    }
)
Parameters:

  • ChannelARN (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the channel.

  • MediaStorageConfiguration (dict) –

    [REQUIRED]

    A structure that encapsulates, or contains, the media storage configuration properties.

    • StreamARN (string) –

      The Amazon Resource Name (ARN) of the stream

    • Status (string) – [REQUIRED]

      The status of the media storage configuration.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • KinesisVideo.Client.exceptions.ResourceInUseException

  • KinesisVideo.Client.exceptions.InvalidArgumentException

  • KinesisVideo.Client.exceptions.ClientLimitExceededException

  • KinesisVideo.Client.exceptions.ResourceNotFoundException

  • KinesisVideo.Client.exceptions.AccessDeniedException

  • KinesisVideo.Client.exceptions.NoDataRetentionException