KinesisVideo / Client / describe_media_storage_configuration

describe_media_storage_configuration#

KinesisVideo.Client.describe_media_storage_configuration(**kwargs)#

Warning

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

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

See also: AWS API Documentation

Request Syntax

response = client.describe_media_storage_configuration(
    ChannelName='string',
    ChannelARN='string'
)
Parameters:

  • ChannelName (string) – The name of the channel.

  • ChannelARN (string) – The Amazon Resource Name (ARN) of the channel.

Return type:

dict

Returns:

Response Syntax

{
    'MediaStorageConfiguration': {
        'StreamARN': 'string',
        'Status': 'ENABLED'|'DISABLED'
    }
}

Response Structure

  • (dict) –

    • MediaStorageConfiguration (dict) –

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

      • StreamARN (string) –

        The Amazon Resource Name (ARN) of the stream

      • Status (string) –

        The status of the media storage configuration.

Exceptions

  • KinesisVideo.Client.exceptions.ResourceNotFoundException

  • KinesisVideo.Client.exceptions.InvalidArgumentException

  • KinesisVideo.Client.exceptions.AccessDeniedException

  • KinesisVideo.Client.exceptions.ClientLimitExceededException