KinesisVideo / Client / update_stream

update_stream#

KinesisVideo.Client.update_stream(**kwargs)#

Updates stream metadata, such as the device name and media type.

You must provide the stream name or the Amazon Resource Name (ARN) of the stream.

To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

UpdateStream is an asynchronous operation, and takes time to complete.

See also: AWS API Documentation

Request Syntax

response = client.update_stream(
    StreamName='string',
    StreamARN='string',
    CurrentVersion='string',
    DeviceName='string',
    MediaType='string'
)
Parameters:

  • StreamName (string) –

    The name of the stream whose metadata you want to update.

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

  • StreamARN (string) – The ARN of the stream whose metadata you want to update.

  • CurrentVersion (string) –

    [REQUIRED]

    The version of the stream whose metadata you want to update.

  • 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.

  • MediaType (string) –

    The stream’s media type. Use MediaType to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements.

    To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify video/h264 as the MediaType.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • KinesisVideo.Client.exceptions.ClientLimitExceededException

  • KinesisVideo.Client.exceptions.InvalidArgumentException

  • KinesisVideo.Client.exceptions.ResourceNotFoundException

  • KinesisVideo.Client.exceptions.ResourceInUseException

  • KinesisVideo.Client.exceptions.NotAuthorizedException

  • KinesisVideo.Client.exceptions.VersionMismatchException