Network.AWS.KinesisVideo.UpdateStream

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.

Creating a Request

updateStream

Arguments

:: Text

uCurrentVersion

-> UpdateStream

Creates a value of UpdateStream with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uMediaType - 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 .
• uStreamARN - The ARN of the stream whose metadata you want to update.
• uDeviceName - The name of the device that is writing to the stream.
• uStreamName - 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.
• uCurrentVersion - The version of the stream whose metadata you want to update.

data UpdateStream

See: updateStream smart constructor.

Instances

Eq UpdateStream

Methods

(==) :: UpdateStream -> UpdateStream -> Bool

(/=) :: UpdateStream -> UpdateStream -> Bool

Data UpdateStream

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateStream -> c UpdateStream

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateStream

toConstr :: UpdateStream -> Constr

dataTypeOf :: UpdateStream -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateStream)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateStream)

gmapT :: (forall b. Data b => b -> b) -> UpdateStream -> UpdateStream

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStream -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStream -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateStream -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateStream -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateStream -> m UpdateStream

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStream -> m UpdateStream

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStream -> m UpdateStream

Read UpdateStream

Methods

readsPrec :: Int -> ReadS UpdateStream

readList :: ReadS [UpdateStream]

readPrec :: ReadPrec UpdateStream

readListPrec :: ReadPrec [UpdateStream]

Show UpdateStream

Methods

showsPrec :: Int -> UpdateStream -> ShowS

show :: UpdateStream -> String

showList :: [UpdateStream] -> ShowS

Generic UpdateStream

Associated Types

type Rep UpdateStream :: * -> *

Methods

from :: UpdateStream -> Rep UpdateStream x

to :: Rep UpdateStream x -> UpdateStream

Hashable UpdateStream

Methods

hashWithSalt :: Int -> UpdateStream -> Int

hash :: UpdateStream -> Int

ToJSON UpdateStream

Methods

toJSON :: UpdateStream -> Value

toEncoding :: UpdateStream -> Encoding

toJSONList :: [UpdateStream] -> Value

toEncodingList :: [UpdateStream] -> Encoding

NFData UpdateStream

Methods

rnf :: UpdateStream -> ()

AWSRequest UpdateStream

Associated Types

type Rs UpdateStream :: *

Methods

request :: UpdateStream -> Request UpdateStream

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpdateStream -> ClientResponse -> m (Response UpdateStream)

ToHeaders UpdateStream

Methods

toHeaders :: UpdateStream -> [Header]

ToPath UpdateStream

Methods

toPath :: UpdateStream -> ByteString

ToQuery UpdateStream

Methods

toQuery :: UpdateStream -> QueryString

type Rep UpdateStream

type Rep UpdateStream = D1 * (MetaData "UpdateStream" "Network.AWS.KinesisVideo.UpdateStream" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) (C1 * (MetaCons "UpdateStream'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_uMediaType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_uStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_uDeviceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_uStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_uCurrentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs UpdateStream

type Rs UpdateStream = UpdateStreamResponse

Request Lenses

uMediaType :: Lens' UpdateStream (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 .

uStreamARN :: Lens' UpdateStream (Maybe Text)

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

uDeviceName :: Lens' UpdateStream (Maybe Text)

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

uStreamName :: Lens' UpdateStream (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.

uCurrentVersion :: Lens' UpdateStream Text

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

Destructuring the Response

updateStreamResponse

Arguments

:: Int

usrsResponseStatus

-> UpdateStreamResponse

Creates a value of UpdateStreamResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• usrsResponseStatus - -- | The response status code.

data UpdateStreamResponse

See: updateStreamResponse smart constructor.

Instances

Eq UpdateStreamResponse

Methods

(==) :: UpdateStreamResponse -> UpdateStreamResponse -> Bool

(/=) :: UpdateStreamResponse -> UpdateStreamResponse -> Bool

Data UpdateStreamResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateStreamResponse -> c UpdateStreamResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateStreamResponse

toConstr :: UpdateStreamResponse -> Constr

dataTypeOf :: UpdateStreamResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateStreamResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateStreamResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateStreamResponse -> UpdateStreamResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStreamResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStreamResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateStreamResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateStreamResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateStreamResponse -> m UpdateStreamResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStreamResponse -> m UpdateStreamResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStreamResponse -> m UpdateStreamResponse

Read UpdateStreamResponse

Methods

readsPrec :: Int -> ReadS UpdateStreamResponse

readList :: ReadS [UpdateStreamResponse]

readPrec :: ReadPrec UpdateStreamResponse

readListPrec :: ReadPrec [UpdateStreamResponse]

Show UpdateStreamResponse

Methods

showsPrec :: Int -> UpdateStreamResponse -> ShowS

show :: UpdateStreamResponse -> String

showList :: [UpdateStreamResponse] -> ShowS

Generic UpdateStreamResponse

Associated Types

type Rep UpdateStreamResponse :: * -> *

Methods

from :: UpdateStreamResponse -> Rep UpdateStreamResponse x

to :: Rep UpdateStreamResponse x -> UpdateStreamResponse

NFData UpdateStreamResponse

Methods

rnf :: UpdateStreamResponse -> ()

type Rep UpdateStreamResponse

type Rep UpdateStreamResponse = D1 * (MetaData "UpdateStreamResponse" "Network.AWS.KinesisVideo.UpdateStream" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" True) (C1 * (MetaCons "UpdateStreamResponse'" PrefixI True) (S1 * (MetaSel (Just Symbol "_usrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))

Response Lenses

usrsResponseStatus :: Lens' UpdateStreamResponse Int

• - | The response status code.