amazonka-kinesis-firehose-1.5.0: Amazon Kinesis Firehose SDK.

Copyright(c) 2013-2017 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.Firehose.DescribeDeliveryStream

Contents

Description

Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call DescribeDeliveryStream to see if the delivery stream is ACTIVE and therefore ready for data to be sent to it.

Synopsis

Creating a Request

describeDeliveryStream Source #

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

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

  • ddsExclusiveStartDestinationId - The ID of the destination to start returning the destination information. Currently, Kinesis Firehose supports one destination per delivery stream.
  • ddsLimit - The limit on the number of destinations to return. Currently, you can have one destination per delivery stream.
  • ddsDeliveryStreamName - The name of the delivery stream.

data DescribeDeliveryStream Source #

See: describeDeliveryStream smart constructor.

Instances

Eq DescribeDeliveryStream Source # 
Data DescribeDeliveryStream Source # 

Methods

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

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

toConstr :: DescribeDeliveryStream -> Constr #

dataTypeOf :: DescribeDeliveryStream -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeDeliveryStream -> DescribeDeliveryStream #

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

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

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

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

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

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

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

Read DescribeDeliveryStream Source # 
Show DescribeDeliveryStream Source # 
Generic DescribeDeliveryStream Source # 
Hashable DescribeDeliveryStream Source # 
ToJSON DescribeDeliveryStream Source # 
NFData DescribeDeliveryStream Source # 

Methods

rnf :: DescribeDeliveryStream -> () #

AWSRequest DescribeDeliveryStream Source # 
ToQuery DescribeDeliveryStream Source # 
ToPath DescribeDeliveryStream Source # 
ToHeaders DescribeDeliveryStream Source # 
type Rep DescribeDeliveryStream Source # 
type Rep DescribeDeliveryStream = D1 (MetaData "DescribeDeliveryStream" "Network.AWS.Firehose.DescribeDeliveryStream" "amazonka-kinesis-firehose-1.5.0-Dtz9uddwQTAHiRIoMAbpKt" False) (C1 (MetaCons "DescribeDeliveryStream'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddsExclusiveStartDestinationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ddsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_ddsDeliveryStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs DescribeDeliveryStream Source # 

Request Lenses

ddsExclusiveStartDestinationId :: Lens' DescribeDeliveryStream (Maybe Text) Source #

The ID of the destination to start returning the destination information. Currently, Kinesis Firehose supports one destination per delivery stream.

ddsLimit :: Lens' DescribeDeliveryStream (Maybe Natural) Source #

The limit on the number of destinations to return. Currently, you can have one destination per delivery stream.

ddsDeliveryStreamName :: Lens' DescribeDeliveryStream Text Source #

The name of the delivery stream.

Destructuring the Response

describeDeliveryStreamResponse Source #

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

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

data DescribeDeliveryStreamResponse Source #

See: describeDeliveryStreamResponse smart constructor.

Instances

Eq DescribeDeliveryStreamResponse Source # 
Data DescribeDeliveryStreamResponse Source # 

Methods

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

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

toConstr :: DescribeDeliveryStreamResponse -> Constr #

dataTypeOf :: DescribeDeliveryStreamResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeDeliveryStreamResponse -> DescribeDeliveryStreamResponse #

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

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

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

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

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

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

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

Show DescribeDeliveryStreamResponse Source # 
Generic DescribeDeliveryStreamResponse Source # 
NFData DescribeDeliveryStreamResponse Source # 
type Rep DescribeDeliveryStreamResponse Source # 
type Rep DescribeDeliveryStreamResponse = D1 (MetaData "DescribeDeliveryStreamResponse" "Network.AWS.Firehose.DescribeDeliveryStream" "amazonka-kinesis-firehose-1.5.0-Dtz9uddwQTAHiRIoMAbpKt" False) (C1 (MetaCons "DescribeDeliveryStreamResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_ddsrsDeliveryStreamDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DeliveryStreamDescription))))

Response Lenses