describe_stream

KinesisVideo.Client.describe_stream(**kwargs)

Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN .

See also: AWS API Documentation

Request Syntax

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

Parameters

• StreamName (string) -- The name of the stream.
• StreamARN (string) -- The Amazon Resource Name (ARN) of the stream.

Return type

dict

Returns

Response Syntax

{
    'StreamInfo': {
        'DeviceName': 'string',
        'StreamName': 'string',
        'StreamARN': 'string',
        'MediaType': 'string',
        'KmsKeyId': 'string',
        'Version': 'string',
        'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING',
        'CreationTime': datetime(2015, 1, 1),
        'DataRetentionInHours': 123
    }
}

Response Structure

• (dict) --

  • StreamInfo (dict) --

    An object that describes the stream.

    • DeviceName (string) --

      The name of the device that is associated with the stream.

    • StreamName (string) --

      The name of the stream.

    • StreamARN (string) --

      The Amazon Resource Name (ARN) of the stream.

    • MediaType (string) --

      The MediaType of the stream.

    • KmsKeyId (string) --

      The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

    • Version (string) --

      The version of the stream.

    • Status (string) --

      The status of the stream.

    • CreationTime (datetime) --

      A time stamp that indicates when the stream was created.

    • DataRetentionInHours (integer) --

      How long the stream retains data, in hours.

Exceptions

• KinesisVideo.Client.exceptions.InvalidArgumentException
• KinesisVideo.Client.exceptions.ResourceNotFoundException
• KinesisVideo.Client.exceptions.ClientLimitExceededException
• KinesisVideo.Client.exceptions.NotAuthorizedException