Network.AWS.KinesisVideo.DeleteStream

Deletes a Kinesis video stream and the data contained in the stream.

This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.

To ensure that you have the latest version of the stream before deleting 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.

This operation requires permission for the KinesisVideo:DeleteStream action.

Creating a Request

deleteStream

Arguments

:: Text

dsStreamARN

-> DeleteStream

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

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

• dsCurrentVersion - Optional: The version of the stream that you want to delete. Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API. If not specified, only the CreationTime is checked before deleting the stream.
• dsStreamARN - The Amazon Resource Name (ARN) of the stream that you want to delete.

data DeleteStream

See: deleteStream smart constructor.

Instances

Eq DeleteStream

Methods

(==) :: DeleteStream -> DeleteStream -> Bool

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

Data DeleteStream

Methods

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

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

toConstr :: DeleteStream -> Constr

dataTypeOf :: DeleteStream -> DataType

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

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

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

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

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

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

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

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

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

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

Read DeleteStream

Methods

readsPrec :: Int -> ReadS DeleteStream

readList :: ReadS [DeleteStream]

readPrec :: ReadPrec DeleteStream

readListPrec :: ReadPrec [DeleteStream]

Show DeleteStream

Methods

showsPrec :: Int -> DeleteStream -> ShowS

show :: DeleteStream -> String

showList :: [DeleteStream] -> ShowS

Generic DeleteStream

Associated Types

type Rep DeleteStream :: * -> *

Methods

from :: DeleteStream -> Rep DeleteStream x

to :: Rep DeleteStream x -> DeleteStream

Hashable DeleteStream

Methods

hashWithSalt :: Int -> DeleteStream -> Int

hash :: DeleteStream -> Int

ToJSON DeleteStream

Methods

toJSON :: DeleteStream -> Value

toEncoding :: DeleteStream -> Encoding

toJSONList :: [DeleteStream] -> Value

toEncodingList :: [DeleteStream] -> Encoding

NFData DeleteStream

Methods

rnf :: DeleteStream -> ()

AWSRequest DeleteStream

Associated Types

type Rs DeleteStream :: *

Methods

request :: DeleteStream -> Request DeleteStream

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

ToHeaders DeleteStream

Methods

toHeaders :: DeleteStream -> [Header]

ToPath DeleteStream

Methods

toPath :: DeleteStream -> ByteString

ToQuery DeleteStream

Methods

toQuery :: DeleteStream -> QueryString

type Rep DeleteStream

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

type Rs DeleteStream

type Rs DeleteStream = DeleteStreamResponse

Request Lenses

dsCurrentVersion :: Lens' DeleteStream (Maybe Text)

Optional: The version of the stream that you want to delete. Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API. If not specified, only the CreationTime is checked before deleting the stream.

dsStreamARN :: Lens' DeleteStream Text

The Amazon Resource Name (ARN) of the stream that you want to delete.

Destructuring the Response

deleteStreamResponse

Arguments

:: Int

dsrsResponseStatus

-> DeleteStreamResponse

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

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

• dsrsResponseStatus - -- | The response status code.

data DeleteStreamResponse

See: deleteStreamResponse smart constructor.

Instances

Eq DeleteStreamResponse

Methods

(==) :: DeleteStreamResponse -> DeleteStreamResponse -> Bool

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

Data DeleteStreamResponse

Methods

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

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

toConstr :: DeleteStreamResponse -> Constr

dataTypeOf :: DeleteStreamResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DeleteStreamResponse

Methods

readsPrec :: Int -> ReadS DeleteStreamResponse

readList :: ReadS [DeleteStreamResponse]

readPrec :: ReadPrec DeleteStreamResponse

readListPrec :: ReadPrec [DeleteStreamResponse]

Show DeleteStreamResponse

Methods

showsPrec :: Int -> DeleteStreamResponse -> ShowS

show :: DeleteStreamResponse -> String

showList :: [DeleteStreamResponse] -> ShowS

Generic DeleteStreamResponse

Associated Types

type Rep DeleteStreamResponse :: * -> *

Methods

from :: DeleteStreamResponse -> Rep DeleteStreamResponse x

to :: Rep DeleteStreamResponse x -> DeleteStreamResponse

NFData DeleteStreamResponse

Methods

rnf :: DeleteStreamResponse -> ()

type Rep DeleteStreamResponse

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

Response Lenses

dsrsResponseStatus :: Lens' DeleteStreamResponse Int

• - | The response status code.