KinesisVideo / Client / create_stream

create_stream#

KinesisVideo.Client.create_stream(**kwargs)#

Creates a new Kinesis video stream.

When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream’s metadata, Kinesis Video Streams updates the version.

CreateStream is an asynchronous operation.

For information about how the service works, see How it Works.

You must have permissions for the KinesisVideo:CreateStream action.

See also: AWS API Documentation

Request Syntax

response = client.create_stream(
    DeviceName='string',
    StreamName='string',
    MediaType='string',
    KmsKeyId='string',
    DataRetentionInHours=123,
    Tags={
        'string': 'string'
    }
)
Parameters:

  • DeviceName (string) –

    The name of the device that is writing to the stream.

    Note

    In the current implementation, Kinesis Video Streams does not use this name.

  • StreamName (string) –

    [REQUIRED]

    A name for the stream that you are creating.

    The stream name is an identifier for the stream, and must be unique for each account and region.

  • MediaType (string) –

    The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

    Example valid values include “video/h264” and “video/h264,audio/aac”.

    This parameter is optional; the default value is null (or empty in JSON).

  • KmsKeyId (string) –

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

    If no key ID is specified, the default, Kinesis Video-managed key ( Amazon Web Services/kinesisvideo) is used.

    For more information, see DescribeKey.

  • DataRetentionInHours (integer) –

    The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

    The default value is 0, indicating that the stream does not persist data.

    When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

  • Tags (dict) –

    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'StreamARN': 'string'
}

Response Structure

  • (dict) –

    • StreamARN (string) –

      The Amazon Resource Name (ARN) of the stream.

Exceptions