| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
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
- data DeleteStream = DeleteStream' {
- currentVersion :: Maybe Text
- streamARN :: Text
- newDeleteStream :: Text -> DeleteStream
- deleteStream_currentVersion :: Lens' DeleteStream (Maybe Text)
- deleteStream_streamARN :: Lens' DeleteStream Text
- data DeleteStreamResponse = DeleteStreamResponse' {
- httpStatus :: Int
- newDeleteStreamResponse :: Int -> DeleteStreamResponse
- deleteStreamResponse_httpStatus :: Lens' DeleteStreamResponse Int
Creating a Request
data DeleteStream Source #
See: newDeleteStream smart constructor.
Constructors
| DeleteStream' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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.
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
newDeleteStreamResponse Source #
Arguments
| :: Int | |
| -> 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.