libZSservicesZSamazonka-kinesis-videoZSamazonka-kinesis-video
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.KinesisVideo.UpdateStream

Description

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.

Synopsis

Creating a Request

data UpdateStream Source #

See: newUpdateStream smart constructor.

Constructors

UpdateStream' 

Fields

  • mediaType :: Maybe Text

    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.

  • streamARN :: Maybe Text

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

  • deviceName :: Maybe Text

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

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

  • streamName :: Maybe Text

    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.

  • currentVersion :: Text

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

Instances

Instances details
Eq UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

Read UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

Show UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

Generic UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

Associated Types

type Rep UpdateStream :: Type -> Type #

NFData UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

Methods

rnf :: UpdateStream -> () #

Hashable UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

ToJSON UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

AWSRequest UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

Associated Types

type AWSResponse UpdateStream #

ToHeaders UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

ToPath UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

ToQuery UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

type Rep UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

type Rep UpdateStream = D1 ('MetaData "UpdateStream" "Amazonka.KinesisVideo.UpdateStream" "libZSservicesZSamazonka-kinesis-videoZSamazonka-kinesis-video" 'False) (C1 ('MetaCons "UpdateStream'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mediaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "deviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "currentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

newUpdateStream Source #

Create a value of UpdateStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:mediaType:UpdateStream', updateStream_mediaType - 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.

$sel:streamARN:UpdateStream', updateStream_streamARN - The ARN of the stream whose metadata you want to update.

$sel:deviceName:UpdateStream', updateStream_deviceName - The name of the device that is writing to the stream.

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

$sel:streamName:UpdateStream', updateStream_streamName - 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.

$sel:currentVersion:UpdateStream', updateStream_currentVersion - The version of the stream whose metadata you want to update.

Request Lenses

updateStream_mediaType :: Lens' UpdateStream (Maybe Text) Source #

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.

updateStream_streamARN :: Lens' UpdateStream (Maybe Text) Source #

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

updateStream_deviceName :: Lens' UpdateStream (Maybe Text) Source #

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

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

updateStream_streamName :: Lens' UpdateStream (Maybe Text) Source #

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.

updateStream_currentVersion :: Lens' UpdateStream Text Source #

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

Destructuring the Response

data UpdateStreamResponse Source #

See: newUpdateStreamResponse smart constructor.

Constructors

UpdateStreamResponse' 

Fields

Instances

Instances details
Eq UpdateStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

Read UpdateStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

Show UpdateStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

Generic UpdateStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

Associated Types

type Rep UpdateStreamResponse :: Type -> Type #

NFData UpdateStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

Methods

rnf :: UpdateStreamResponse -> () #

type Rep UpdateStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateStream

type Rep UpdateStreamResponse = D1 ('MetaData "UpdateStreamResponse" "Amazonka.KinesisVideo.UpdateStream" "libZSservicesZSamazonka-kinesis-videoZSamazonka-kinesis-video" 'False) (C1 ('MetaCons "UpdateStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateStreamResponse Source #

Create a value of UpdateStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateStreamResponse', updateStreamResponse_httpStatus - The response's http status code.

Response Lenses