KinesisVideo / Client / update_stream_storage_configuration

update_stream_storage_configuration

KinesisVideo.Client.update_stream_storage_configuration(**kwargs)

Updates the storage configuration for an existing Kinesis video stream.

This operation allows you to modify the storage tier settings for a stream, enabling you to optimize storage costs and performance based on your access patterns.

UpdateStreamStorageConfiguration is an asynchronous operation.

You must have permissions for the KinesisVideo:UpdateStreamStorageConfiguration action.

See also: AWS API Documentation

Request Syntax

response = client.update_stream_storage_configuration(
    StreamName='string',
    StreamARN='string',
    CurrentVersion='string',
    StreamStorageConfiguration={
        'DefaultStorageTier': 'HOT'|'WARM'
    }
)
Parameters:

  • StreamName (string) – The name of the stream for which you want to update the storage configuration.

  • StreamARN (string) – The Amazon Resource Name (ARN) of the stream for which you want to update the storage configuration.

  • CurrentVersion (string) –

    [REQUIRED]

    The version of the stream whose storage configuration you want to change. To get the version, call either the DescribeStream or the ListStreams API.

  • StreamStorageConfiguration (dict) –

    [REQUIRED]

    The new storage configuration for the stream. This includes the default storage tier that determines how stream data is stored and accessed.

    Different storage tiers offer varying levels of performance and cost optimization to match your specific use case requirements.

    • DefaultStorageTier (string) – [REQUIRED]

      The default storage tier for the stream data. This setting determines the storage class used for stream data, affecting both performance characteristics and storage costs.

      Available storage tiers:

      • HOT - Optimized for frequent access with the lowest latency and highest performance. Ideal for real-time applications and frequently accessed data.

      • WARM - Balanced performance and cost for moderately accessed data. Suitable for data that is accessed regularly but not continuously.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • KinesisVideo.Client.exceptions.AccessDeniedException

  • KinesisVideo.Client.exceptions.ClientLimitExceededException

  • KinesisVideo.Client.exceptions.InvalidArgumentException

  • KinesisVideo.Client.exceptions.ResourceNotFoundException

  • KinesisVideo.Client.exceptions.ResourceInUseException

  • KinesisVideo.Client.exceptions.VersionMismatchException