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.DeleteStream

Description

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.

Synopsis

Creating a Request

data DeleteStream Source #

See: newDeleteStream smart constructor.

Constructors

DeleteStream' 

Fields

  • currentVersion :: 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.

  • streamARN :: Text

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

Instances

Instances details
Eq DeleteStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

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

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

Read DeleteStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

readsPrec :: Int -> ReadS DeleteStream #

readList :: ReadS [DeleteStream] #

readPrec :: ReadPrec DeleteStream #

readListPrec :: ReadPrec [DeleteStream] #

Show DeleteStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

showsPrec :: Int -> DeleteStream -> ShowS #

show :: DeleteStream -> String #

showList :: [DeleteStream] -> ShowS #

Generic DeleteStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Associated Types

type Rep DeleteStream :: Type -> Type #

Methods

from :: DeleteStream -> Rep DeleteStream x #

to :: Rep DeleteStream x -> DeleteStream #

NFData DeleteStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

rnf :: DeleteStream -> () #

Hashable DeleteStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

hashWithSalt :: Int -> DeleteStream -> Int #

hash :: DeleteStream -> Int #

ToJSON DeleteStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

toJSON :: DeleteStream -> Value #

toEncoding :: DeleteStream -> Encoding #

toJSONList :: [DeleteStream] -> Value #

toEncodingList :: [DeleteStream] -> Encoding #

AWSRequest DeleteStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Associated Types

type AWSResponse DeleteStream #

Methods

request :: DeleteStream -> Request DeleteStream #

response :: MonadResource m => Logger -> Service -> Proxy DeleteStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteStream))) #

ToHeaders DeleteStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

toHeaders :: DeleteStream -> [Header] #

ToPath DeleteStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

toPath :: DeleteStream -> ByteString #

ToQuery DeleteStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

toQuery :: DeleteStream -> QueryString #

type Rep DeleteStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

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

Defined in Amazonka.KinesisVideo.DeleteStream

type AWSResponse DeleteStream = DeleteStreamResponse

newDeleteStream Source #

Arguments

:: Text

$sel:streamARN:DeleteStream'

-> DeleteStream 

Create a value of DeleteStream 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:currentVersion:DeleteStream', deleteStream_currentVersion - 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.

$sel:streamARN:DeleteStream', deleteStream_streamARN - The Amazon Resource Name (ARN) of the stream that you want to delete.

Request Lenses

deleteStream_currentVersion :: Lens' DeleteStream (Maybe Text) Source #

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.

deleteStream_streamARN :: Lens' DeleteStream Text Source #

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

Destructuring the Response

data DeleteStreamResponse Source #

See: newDeleteStreamResponse smart constructor.

Constructors

DeleteStreamResponse' 

Fields

Instances

Instances details
Eq DeleteStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

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

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

Read DeleteStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

readsPrec :: Int -> ReadS DeleteStreamResponse #

readList :: ReadS [DeleteStreamResponse] #

readPrec :: ReadPrec DeleteStreamResponse #

readListPrec :: ReadPrec [DeleteStreamResponse] #

Show DeleteStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

showsPrec :: Int -> DeleteStreamResponse -> ShowS #

show :: DeleteStreamResponse -> String #

showList :: [DeleteStreamResponse] -> ShowS #

Generic DeleteStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Associated Types

type Rep DeleteStreamResponse :: Type -> Type #

Methods

from :: DeleteStreamResponse -> Rep DeleteStreamResponse x #

to :: Rep DeleteStreamResponse x -> DeleteStreamResponse #

NFData DeleteStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

Methods

rnf :: DeleteStreamResponse -> () #

type Rep DeleteStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.DeleteStream

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

newDeleteStreamResponse Source #

Arguments

:: Int

$sel:httpStatus:DeleteStreamResponse'

-> DeleteStreamResponse 

Create a value of DeleteStreamResponse 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:DeleteStreamResponse', deleteStreamResponse_httpStatus - The response's http status code.

Response Lenses

deleteStreamResponse_httpStatus :: Lens' DeleteStreamResponse Int Source #

The response's http status code.