KinesisVideo / Client / describe_stream_storage_configuration

describe_stream_storage_configuration¶

KinesisVideo.Client.describe_stream_storage_configuration(**kwargs)¶

Retrieves the current storage configuration for the specified Kinesis video stream.

In the request, you must specify either the StreamName or the StreamARN.

You must have permissions for the KinesisVideo:DescribeStreamStorageConfiguration action.

See also: AWS API Documentation

Request Syntax

response = client.describe_stream_storage_configuration(
    StreamName='string',
    StreamARN='string'
)

Parameters:

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

Return type:

dict

Returns:

Response Syntax

{
    'StreamName': 'string',
    'StreamARN': 'string',
    'StreamStorageConfiguration': {
        'DefaultStorageTier': 'HOT'|'WARM'
    }
}

Response Structure

(dict) –
- StreamName (string) –
  
  The name of the stream.
- StreamARN (string) –
  
  The Amazon Resource Name (ARN) of the stream.
- StreamStorageConfiguration (dict) –
  
  The current storage configuration for the stream, including the default storage tier and other storage-related settings.
  - DefaultStorageTier (string) –
    
    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.

Exceptions

KinesisVideo.Client.exceptions.AccessDeniedException
KinesisVideo.Client.exceptions.ClientLimitExceededException
KinesisVideo.Client.exceptions.InvalidArgumentException
KinesisVideo.Client.exceptions.ResourceNotFoundException