| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
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
- data UpdateStream = UpdateStream' {
- mediaType :: Maybe Text
- streamARN :: Maybe Text
- deviceName :: Maybe Text
- streamName :: Maybe Text
- currentVersion :: Text
- newUpdateStream :: Text -> UpdateStream
- updateStream_mediaType :: Lens' UpdateStream (Maybe Text)
- updateStream_streamARN :: Lens' UpdateStream (Maybe Text)
- updateStream_deviceName :: Lens' UpdateStream (Maybe Text)
- updateStream_streamName :: Lens' UpdateStream (Maybe Text)
- updateStream_currentVersion :: Lens' UpdateStream Text
- data UpdateStreamResponse = UpdateStreamResponse' {
- httpStatus :: Int
- newUpdateStreamResponse :: Int -> UpdateStreamResponse
- updateStreamResponse_httpStatus :: Lens' UpdateStreamResponse Int
Creating a Request
data UpdateStream Source #
See: newUpdateStream smart constructor.
Constructors
| UpdateStream' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> UpdateStream |
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
newUpdateStreamResponse Source #
Arguments
| :: Int | |
| -> UpdateStreamResponse |
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
updateStreamResponse_httpStatus :: Lens' UpdateStreamResponse Int Source #
The response's http status code.