Network.AWS.Firehose.DescribeDeliveryStream

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

Creating a Request

describeDeliveryStream

Arguments

:: Text

ddsDeliveryStreamName

-> DescribeDeliveryStream

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. Kinesis Data Firehose supports one destination per delivery stream.
• ddsLimit - The limit on the number of destinations to return. You can have one destination per delivery stream.
• ddsDeliveryStreamName - The name of the delivery stream.

data DescribeDeliveryStream

See: describeDeliveryStream smart constructor.

Instances

Eq DescribeDeliveryStream

Methods

(==) :: DescribeDeliveryStream -> DescribeDeliveryStream -> Bool

(/=) :: DescribeDeliveryStream -> DescribeDeliveryStream -> Bool

Data DescribeDeliveryStream

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

Methods

readsPrec :: Int -> ReadS DescribeDeliveryStream

readList :: ReadS [DescribeDeliveryStream]

readPrec :: ReadPrec DescribeDeliveryStream

readListPrec :: ReadPrec [DescribeDeliveryStream]

Show DescribeDeliveryStream

Methods

showsPrec :: Int -> DescribeDeliveryStream -> ShowS

show :: DescribeDeliveryStream -> String

showList :: [DescribeDeliveryStream] -> ShowS

Generic DescribeDeliveryStream

Associated Types

type Rep DescribeDeliveryStream :: * -> *

Methods

from :: DescribeDeliveryStream -> Rep DescribeDeliveryStream x

to :: Rep DescribeDeliveryStream x -> DescribeDeliveryStream

Hashable DescribeDeliveryStream

Methods

hashWithSalt :: Int -> DescribeDeliveryStream -> Int

hash :: DescribeDeliveryStream -> Int

ToJSON DescribeDeliveryStream

Methods

toJSON :: DescribeDeliveryStream -> Value

toEncoding :: DescribeDeliveryStream -> Encoding

toJSONList :: [DescribeDeliveryStream] -> Value

toEncodingList :: [DescribeDeliveryStream] -> Encoding

NFData DescribeDeliveryStream

Methods

rnf :: DescribeDeliveryStream -> ()

AWSRequest DescribeDeliveryStream

Associated Types

type Rs DescribeDeliveryStream :: *

Methods

request :: DescribeDeliveryStream -> Request DescribeDeliveryStream

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeDeliveryStream -> ClientResponse -> m (Response DescribeDeliveryStream)

ToHeaders DescribeDeliveryStream

Methods

toHeaders :: DescribeDeliveryStream -> [Header]

ToPath DescribeDeliveryStream

Methods

toPath :: DescribeDeliveryStream -> ByteString

ToQuery DescribeDeliveryStream

Methods

toQuery :: DescribeDeliveryStream -> QueryString

type Rep DescribeDeliveryStream

type Rep DescribeDeliveryStream = D1 * (MetaData "DescribeDeliveryStream" "Network.AWS.Firehose.DescribeDeliveryStream" "amazonka-kinesis-firehose-1.6.0-LQ2fZHJK53J4iOaqJbzMJD" 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

type Rs DescribeDeliveryStream = DescribeDeliveryStreamResponse

Request Lenses

ddsExclusiveStartDestinationId :: Lens' DescribeDeliveryStream (Maybe Text)

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

ddsLimit :: Lens' DescribeDeliveryStream (Maybe Natural)

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

ddsDeliveryStreamName :: Lens' DescribeDeliveryStream Text

The name of the delivery stream.

Destructuring the Response

describeDeliveryStreamResponse

Arguments

:: Int

ddsrsResponseStatus

-> DeliveryStreamDescription

ddsrsDeliveryStreamDescription

-> DescribeDeliveryStreamResponse

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:

• ddsrsResponseStatus - -- | The response status code.
• ddsrsDeliveryStreamDescription - Information about the delivery stream.

data DescribeDeliveryStreamResponse

See: describeDeliveryStreamResponse smart constructor.

Instances

Eq DescribeDeliveryStreamResponse

Methods

(==) :: DescribeDeliveryStreamResponse -> DescribeDeliveryStreamResponse -> Bool

(/=) :: DescribeDeliveryStreamResponse -> DescribeDeliveryStreamResponse -> Bool

Data DescribeDeliveryStreamResponse

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

Methods

showsPrec :: Int -> DescribeDeliveryStreamResponse -> ShowS

show :: DescribeDeliveryStreamResponse -> String

showList :: [DescribeDeliveryStreamResponse] -> ShowS

Generic DescribeDeliveryStreamResponse

Associated Types

type Rep DescribeDeliveryStreamResponse :: * -> *

Methods

from :: DescribeDeliveryStreamResponse -> Rep DescribeDeliveryStreamResponse x

to :: Rep DescribeDeliveryStreamResponse x -> DescribeDeliveryStreamResponse

NFData DescribeDeliveryStreamResponse

Methods

rnf :: DescribeDeliveryStreamResponse -> ()

type Rep DescribeDeliveryStreamResponse

type Rep DescribeDeliveryStreamResponse = D1 * (MetaData "DescribeDeliveryStreamResponse" "Network.AWS.Firehose.DescribeDeliveryStream" "amazonka-kinesis-firehose-1.6.0-LQ2fZHJK53J4iOaqJbzMJD" 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

ddsrsResponseStatus :: Lens' DescribeDeliveryStreamResponse Int

• - | The response status code.

ddsrsDeliveryStreamDescription :: Lens' DescribeDeliveryStreamResponse DeliveryStreamDescription

Information about the delivery stream.