{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.KinesisVideo.UpdateStream
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- 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.
module Amazonka.KinesisVideo.UpdateStream
  ( -- * Creating a Request
    UpdateStream (..),
    newUpdateStream,

    -- * Request Lenses
    updateStream_deviceName,
    updateStream_mediaType,
    updateStream_streamARN,
    updateStream_streamName,
    updateStream_currentVersion,

    -- * Destructuring the Response
    UpdateStreamResponse (..),
    newUpdateStreamResponse,

    -- * Response Lenses
    updateStreamResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.KinesisVideo.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newUpdateStream' smart constructor.
data UpdateStream = UpdateStream'
  { -- | The name of the device that is writing to the stream.
    --
    -- In the current implementation, Kinesis Video Streams does not use this
    -- name.
    UpdateStream -> Maybe Text
deviceName :: Prelude.Maybe Prelude.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
    -- <http://www.iana.org/assignments/media-types/media-types.xhtml Media Types>.
    -- If you choose to specify the @MediaType@, see
    -- <https://tools.ietf.org/html/rfc6838#section-4.2 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 -> Maybe Text
mediaType :: Prelude.Maybe Prelude.Text,
    -- | The ARN of the stream whose metadata you want to update.
    UpdateStream -> Maybe Text
streamARN :: Prelude.Maybe Prelude.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.
    UpdateStream -> Maybe Text
streamName :: Prelude.Maybe Prelude.Text,
    -- | The version of the stream whose metadata you want to update.
    UpdateStream -> Text
currentVersion :: Prelude.Text
  }
  deriving (UpdateStream -> UpdateStream -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UpdateStream -> UpdateStream -> Bool
$c/= :: UpdateStream -> UpdateStream -> Bool
== :: UpdateStream -> UpdateStream -> Bool
$c== :: UpdateStream -> UpdateStream -> Bool
Prelude.Eq, ReadPrec [UpdateStream]
ReadPrec UpdateStream
Int -> ReadS UpdateStream
ReadS [UpdateStream]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [UpdateStream]
$creadListPrec :: ReadPrec [UpdateStream]
readPrec :: ReadPrec UpdateStream
$creadPrec :: ReadPrec UpdateStream
readList :: ReadS [UpdateStream]
$creadList :: ReadS [UpdateStream]
readsPrec :: Int -> ReadS UpdateStream
$creadsPrec :: Int -> ReadS UpdateStream
Prelude.Read, Int -> UpdateStream -> ShowS
[UpdateStream] -> ShowS
UpdateStream -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [UpdateStream] -> ShowS
$cshowList :: [UpdateStream] -> ShowS
show :: UpdateStream -> String
$cshow :: UpdateStream -> String
showsPrec :: Int -> UpdateStream -> ShowS
$cshowsPrec :: Int -> UpdateStream -> ShowS
Prelude.Show, forall x. Rep UpdateStream x -> UpdateStream
forall x. UpdateStream -> Rep UpdateStream x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep UpdateStream x -> UpdateStream
$cfrom :: forall x. UpdateStream -> Rep UpdateStream x
Prelude.Generic)

-- |
-- Create a value of 'UpdateStream' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'deviceName', '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.
--
-- 'mediaType', '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
-- <http://www.iana.org/assignments/media-types/media-types.xhtml Media Types>.
-- If you choose to specify the @MediaType@, see
-- <https://tools.ietf.org/html/rfc6838#section-4.2 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', 'updateStream_streamARN' - The ARN of the stream whose metadata you want to update.
--
-- 'streamName', '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.
--
-- 'currentVersion', 'updateStream_currentVersion' - The version of the stream whose metadata you want to update.
newUpdateStream ::
  -- | 'currentVersion'
  Prelude.Text ->
  UpdateStream
newUpdateStream :: Text -> UpdateStream
newUpdateStream Text
pCurrentVersion_ =
  UpdateStream'
    { $sel:deviceName:UpdateStream' :: Maybe Text
deviceName = forall a. Maybe a
Prelude.Nothing,
      $sel:mediaType:UpdateStream' :: Maybe Text
mediaType = forall a. Maybe a
Prelude.Nothing,
      $sel:streamARN:UpdateStream' :: Maybe Text
streamARN = forall a. Maybe a
Prelude.Nothing,
      $sel:streamName:UpdateStream' :: Maybe Text
streamName = forall a. Maybe a
Prelude.Nothing,
      $sel:currentVersion:UpdateStream' :: Text
currentVersion = Text
pCurrentVersion_
    }

-- | The name of the device that is writing to the stream.
--
-- In the current implementation, Kinesis Video Streams does not use this
-- name.
updateStream_deviceName :: Lens.Lens' UpdateStream (Prelude.Maybe Prelude.Text)
updateStream_deviceName :: Lens' UpdateStream (Maybe Text)
updateStream_deviceName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateStream' {Maybe Text
deviceName :: Maybe Text
$sel:deviceName:UpdateStream' :: UpdateStream -> Maybe Text
deviceName} -> Maybe Text
deviceName) (\s :: UpdateStream
s@UpdateStream' {} Maybe Text
a -> UpdateStream
s {$sel:deviceName:UpdateStream' :: Maybe Text
deviceName = Maybe Text
a} :: UpdateStream)

-- | 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
-- <http://www.iana.org/assignments/media-types/media-types.xhtml Media Types>.
-- If you choose to specify the @MediaType@, see
-- <https://tools.ietf.org/html/rfc6838#section-4.2 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_mediaType :: Lens.Lens' UpdateStream (Prelude.Maybe Prelude.Text)
updateStream_mediaType :: Lens' UpdateStream (Maybe Text)
updateStream_mediaType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateStream' {Maybe Text
mediaType :: Maybe Text
$sel:mediaType:UpdateStream' :: UpdateStream -> Maybe Text
mediaType} -> Maybe Text
mediaType) (\s :: UpdateStream
s@UpdateStream' {} Maybe Text
a -> UpdateStream
s {$sel:mediaType:UpdateStream' :: Maybe Text
mediaType = Maybe Text
a} :: UpdateStream)

-- | The ARN of the stream whose metadata you want to update.
updateStream_streamARN :: Lens.Lens' UpdateStream (Prelude.Maybe Prelude.Text)
updateStream_streamARN :: Lens' UpdateStream (Maybe Text)
updateStream_streamARN = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateStream' {Maybe Text
streamARN :: Maybe Text
$sel:streamARN:UpdateStream' :: UpdateStream -> Maybe Text
streamARN} -> Maybe Text
streamARN) (\s :: UpdateStream
s@UpdateStream' {} Maybe Text
a -> UpdateStream
s {$sel:streamARN:UpdateStream' :: Maybe Text
streamARN = Maybe Text
a} :: UpdateStream)

-- | 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_streamName :: Lens.Lens' UpdateStream (Prelude.Maybe Prelude.Text)
updateStream_streamName :: Lens' UpdateStream (Maybe Text)
updateStream_streamName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateStream' {Maybe Text
streamName :: Maybe Text
$sel:streamName:UpdateStream' :: UpdateStream -> Maybe Text
streamName} -> Maybe Text
streamName) (\s :: UpdateStream
s@UpdateStream' {} Maybe Text
a -> UpdateStream
s {$sel:streamName:UpdateStream' :: Maybe Text
streamName = Maybe Text
a} :: UpdateStream)

-- | The version of the stream whose metadata you want to update.
updateStream_currentVersion :: Lens.Lens' UpdateStream Prelude.Text
updateStream_currentVersion :: Lens' UpdateStream Text
updateStream_currentVersion = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateStream' {Text
currentVersion :: Text
$sel:currentVersion:UpdateStream' :: UpdateStream -> Text
currentVersion} -> Text
currentVersion) (\s :: UpdateStream
s@UpdateStream' {} Text
a -> UpdateStream
s {$sel:currentVersion:UpdateStream' :: Text
currentVersion = Text
a} :: UpdateStream)

instance Core.AWSRequest UpdateStream where
  type AWSResponse UpdateStream = UpdateStreamResponse
  request :: (Service -> Service) -> UpdateStream -> Request UpdateStream
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy UpdateStream
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse UpdateStream)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> () -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveEmpty
      ( \Int
s ResponseHeaders
h ()
x ->
          Int -> UpdateStreamResponse
UpdateStreamResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable UpdateStream where
  hashWithSalt :: Int -> UpdateStream -> Int
hashWithSalt Int
_salt UpdateStream' {Maybe Text
Text
currentVersion :: Text
streamName :: Maybe Text
streamARN :: Maybe Text
mediaType :: Maybe Text
deviceName :: Maybe Text
$sel:currentVersion:UpdateStream' :: UpdateStream -> Text
$sel:streamName:UpdateStream' :: UpdateStream -> Maybe Text
$sel:streamARN:UpdateStream' :: UpdateStream -> Maybe Text
$sel:mediaType:UpdateStream' :: UpdateStream -> Maybe Text
$sel:deviceName:UpdateStream' :: UpdateStream -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
deviceName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
mediaType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
streamARN
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
streamName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
currentVersion

instance Prelude.NFData UpdateStream where
  rnf :: UpdateStream -> ()
rnf UpdateStream' {Maybe Text
Text
currentVersion :: Text
streamName :: Maybe Text
streamARN :: Maybe Text
mediaType :: Maybe Text
deviceName :: Maybe Text
$sel:currentVersion:UpdateStream' :: UpdateStream -> Text
$sel:streamName:UpdateStream' :: UpdateStream -> Maybe Text
$sel:streamARN:UpdateStream' :: UpdateStream -> Maybe Text
$sel:mediaType:UpdateStream' :: UpdateStream -> Maybe Text
$sel:deviceName:UpdateStream' :: UpdateStream -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
deviceName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
mediaType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
streamARN
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
streamName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
currentVersion

instance Data.ToHeaders UpdateStream where
  toHeaders :: UpdateStream -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

instance Data.ToJSON UpdateStream where
  toJSON :: UpdateStream -> Value
toJSON UpdateStream' {Maybe Text
Text
currentVersion :: Text
streamName :: Maybe Text
streamARN :: Maybe Text
mediaType :: Maybe Text
deviceName :: Maybe Text
$sel:currentVersion:UpdateStream' :: UpdateStream -> Text
$sel:streamName:UpdateStream' :: UpdateStream -> Maybe Text
$sel:streamARN:UpdateStream' :: UpdateStream -> Maybe Text
$sel:mediaType:UpdateStream' :: UpdateStream -> Maybe Text
$sel:deviceName:UpdateStream' :: UpdateStream -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"DeviceName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
deviceName,
            (Key
"MediaType" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
mediaType,
            (Key
"StreamARN" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
streamARN,
            (Key
"StreamName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
streamName,
            forall a. a -> Maybe a
Prelude.Just
              (Key
"CurrentVersion" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
currentVersion)
          ]
      )

instance Data.ToPath UpdateStream where
  toPath :: UpdateStream -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/updateStream"

instance Data.ToQuery UpdateStream where
  toQuery :: UpdateStream -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newUpdateStreamResponse' smart constructor.
data UpdateStreamResponse = UpdateStreamResponse'
  { -- | The response's http status code.
    UpdateStreamResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (UpdateStreamResponse -> UpdateStreamResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UpdateStreamResponse -> UpdateStreamResponse -> Bool
$c/= :: UpdateStreamResponse -> UpdateStreamResponse -> Bool
== :: UpdateStreamResponse -> UpdateStreamResponse -> Bool
$c== :: UpdateStreamResponse -> UpdateStreamResponse -> Bool
Prelude.Eq, ReadPrec [UpdateStreamResponse]
ReadPrec UpdateStreamResponse
Int -> ReadS UpdateStreamResponse
ReadS [UpdateStreamResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [UpdateStreamResponse]
$creadListPrec :: ReadPrec [UpdateStreamResponse]
readPrec :: ReadPrec UpdateStreamResponse
$creadPrec :: ReadPrec UpdateStreamResponse
readList :: ReadS [UpdateStreamResponse]
$creadList :: ReadS [UpdateStreamResponse]
readsPrec :: Int -> ReadS UpdateStreamResponse
$creadsPrec :: Int -> ReadS UpdateStreamResponse
Prelude.Read, Int -> UpdateStreamResponse -> ShowS
[UpdateStreamResponse] -> ShowS
UpdateStreamResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [UpdateStreamResponse] -> ShowS
$cshowList :: [UpdateStreamResponse] -> ShowS
show :: UpdateStreamResponse -> String
$cshow :: UpdateStreamResponse -> String
showsPrec :: Int -> UpdateStreamResponse -> ShowS
$cshowsPrec :: Int -> UpdateStreamResponse -> ShowS
Prelude.Show, forall x. Rep UpdateStreamResponse x -> UpdateStreamResponse
forall x. UpdateStreamResponse -> Rep UpdateStreamResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep UpdateStreamResponse x -> UpdateStreamResponse
$cfrom :: forall x. UpdateStreamResponse -> Rep UpdateStreamResponse x
Prelude.Generic)

-- |
-- Create a value of 'UpdateStreamResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'httpStatus', 'updateStreamResponse_httpStatus' - The response's http status code.
newUpdateStreamResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  UpdateStreamResponse
newUpdateStreamResponse :: Int -> UpdateStreamResponse
newUpdateStreamResponse Int
pHttpStatus_ =
  UpdateStreamResponse' {$sel:httpStatus:UpdateStreamResponse' :: Int
httpStatus = Int
pHttpStatus_}

-- | The response's http status code.
updateStreamResponse_httpStatus :: Lens.Lens' UpdateStreamResponse Prelude.Int
updateStreamResponse_httpStatus :: Lens' UpdateStreamResponse Int
updateStreamResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateStreamResponse' {Int
httpStatus :: Int
$sel:httpStatus:UpdateStreamResponse' :: UpdateStreamResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: UpdateStreamResponse
s@UpdateStreamResponse' {} Int
a -> UpdateStreamResponse
s {$sel:httpStatus:UpdateStreamResponse' :: Int
httpStatus = Int
a} :: UpdateStreamResponse)

instance Prelude.NFData UpdateStreamResponse where
  rnf :: UpdateStreamResponse -> ()
rnf UpdateStreamResponse' {Int
httpStatus :: Int
$sel:httpStatus:UpdateStreamResponse' :: UpdateStreamResponse -> Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus