Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Kinesis.DeleteStream

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception ResourceNotFoundException.

If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

Note: Kinesis Data Streams might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete.

When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.

You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus.

DeleteStream has a limit of five transactions per second per account.

Synopsis

Creating a Request

data DeleteStream Source #

Represents the input for DeleteStream.

See: newDeleteStream smart constructor.

Constructors

DeleteStream'
Fields enforceConsumerDeletion :: Maybe Bool If this parameter is unset (`null`) or if you set it to `false`, and the stream has registered consumers, the call to `DeleteStream` fails with a `ResourceInUseException`. streamName :: Text The name of the stream to delete.

Instances

Instances details

Eq DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods (==) :: DeleteStream -> DeleteStream -> Bool # (/=) :: DeleteStream -> DeleteStream -> Bool #
Read DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods readsPrec :: Int -> ReadS DeleteStream # readList :: ReadS [DeleteStream] # readPrec :: ReadPrec DeleteStream # readListPrec :: ReadPrec [DeleteStream] #
Show DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods showsPrec :: Int -> DeleteStream -> ShowS # show :: DeleteStream -> String # showList :: [DeleteStream] -> ShowS #
Generic DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.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.Kinesis.DeleteStream Methods rnf :: DeleteStream -> () #
Hashable DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods hashWithSalt :: Int -> DeleteStream -> Int # hash :: DeleteStream -> Int #
ToJSON DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods toJSON :: DeleteStream -> Value # toEncoding :: DeleteStream -> Encoding # toJSONList :: [DeleteStream] -> Value # toEncodingList :: [DeleteStream] -> Encoding #
AWSRequest DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.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.Kinesis.DeleteStream Methods toHeaders :: DeleteStream -> [Header] #
ToPath DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods toPath :: DeleteStream -> ByteString #
ToQuery DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods toQuery :: DeleteStream -> QueryString #
type Rep DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream type Rep DeleteStream = D1 ('MetaData "DeleteStream" "Amazonka.Kinesis.DeleteStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DeleteStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enforceConsumerDeletion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteStream Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream type AWSResponse DeleteStream = DeleteStreamResponse

newDeleteStream Source #

Arguments

:: Text	`$sel:streamName: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:enforceConsumerDeletion:DeleteStream', deleteStream_enforceConsumerDeletion - If this parameter is unset (null) or if you set it to false, and the stream has registered consumers, the call to DeleteStream fails with a ResourceInUseException.

$sel:streamName:DeleteStream', deleteStream_streamName - The name of the stream to delete.

Request Lenses

deleteStream_enforceConsumerDeletion :: Lens' DeleteStream (Maybe Bool) Source #

If this parameter is unset (null) or if you set it to false, and the stream has registered consumers, the call to DeleteStream fails with a ResourceInUseException.

deleteStream_streamName :: Lens' DeleteStream Text Source #

The name of the stream to delete.

Destructuring the Response

data DeleteStreamResponse Source #

See: newDeleteStreamResponse smart constructor.

Constructors

DeleteStreamResponse'

Instances

Instances details

Eq DeleteStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods (==) :: DeleteStreamResponse -> DeleteStreamResponse -> Bool # (/=) :: DeleteStreamResponse -> DeleteStreamResponse -> Bool #
Read DeleteStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods readsPrec :: Int -> ReadS DeleteStreamResponse # readList :: ReadS [DeleteStreamResponse] # readPrec :: ReadPrec DeleteStreamResponse # readListPrec :: ReadPrec [DeleteStreamResponse] #
Show DeleteStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream Methods showsPrec :: Int -> DeleteStreamResponse -> ShowS # show :: DeleteStreamResponse -> String # showList :: [DeleteStreamResponse] -> ShowS #
Generic DeleteStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.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.Kinesis.DeleteStream Methods rnf :: DeleteStreamResponse -> () #
type Rep DeleteStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.DeleteStream type Rep DeleteStreamResponse = D1 ('MetaData "DeleteStreamResponse" "Amazonka.Kinesis.DeleteStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DeleteStreamResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteStreamResponse :: DeleteStreamResponse Source #

Create a value of DeleteStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.