amazonka-kinesis-1.6.0: Amazon Kinesis SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Kinesis.DeleteStream

Contents

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

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:

data DeleteStream #

Represents the input for DeleteStream .

See: deleteStream smart constructor.

Instances

Eq DeleteStream # 
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 # 
Show DeleteStream # 
Generic DeleteStream # 

Associated Types

type Rep DeleteStream :: * -> * #

Hashable DeleteStream # 
ToJSON DeleteStream # 
NFData DeleteStream # 

Methods

rnf :: DeleteStream -> () #

AWSRequest DeleteStream # 
ToHeaders DeleteStream # 
ToPath DeleteStream # 
ToQuery DeleteStream # 
type Rep DeleteStream # 
type Rep DeleteStream = D1 * (MetaData "DeleteStream" "Network.AWS.Kinesis.DeleteStream" "amazonka-kinesis-1.6.0-AMlDcsmqKN4oWDRc0mjTF" True) (C1 * (MetaCons "DeleteStream'" PrefixI True) (S1 * (MetaSel (Just Symbol "_dsStreamName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))
type Rs DeleteStream # 

Request Lenses

dsStreamName :: Lens' DeleteStream Text #

The name of the stream to delete.

Destructuring the Response

deleteStreamResponse :: DeleteStreamResponse #

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

data DeleteStreamResponse #

See: deleteStreamResponse smart constructor.

Instances

Eq DeleteStreamResponse # 
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 # 
Show DeleteStreamResponse # 
Generic DeleteStreamResponse # 
NFData DeleteStreamResponse # 

Methods

rnf :: DeleteStreamResponse -> () #

type Rep DeleteStreamResponse # 
type Rep DeleteStreamResponse = D1 * (MetaData "DeleteStreamResponse" "Network.AWS.Kinesis.DeleteStream" "amazonka-kinesis-1.6.0-AMlDcsmqKN4oWDRc0mjTF" False) (C1 * (MetaCons "DeleteStreamResponse'" PrefixI False) (U1 *))