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.Firehose.DescribeDeliveryStream

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified delivery stream and its 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.

If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. If the status is DELETING_FAILED, you can force deletion by invoking DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true.

Synopsis

Creating a Request

data DescribeDeliveryStream Source #

See: newDescribeDeliveryStream smart constructor.

Constructors

DescribeDeliveryStream'
Fields exclusiveStartDestinationId :: Maybe Text The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream. limit :: Maybe Natural The limit on the number of destinations to return. You can have one destination per delivery stream. deliveryStreamName :: Text The name of the delivery stream.

Instances

Instances details

Eq DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Methods (==) :: DescribeDeliveryStream -> DescribeDeliveryStream -> Bool # (/=) :: DescribeDeliveryStream -> DescribeDeliveryStream -> Bool #
Read DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Methods readsPrec :: Int -> ReadS DescribeDeliveryStream # readList :: ReadS [DescribeDeliveryStream] # readPrec :: ReadPrec DescribeDeliveryStream # readListPrec :: ReadPrec [DescribeDeliveryStream] #
Show DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Methods showsPrec :: Int -> DescribeDeliveryStream -> ShowS # show :: DescribeDeliveryStream -> String # showList :: [DescribeDeliveryStream] -> ShowS #
Generic DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Associated Types type Rep DescribeDeliveryStream :: Type -> Type # Methods from :: DescribeDeliveryStream -> Rep DescribeDeliveryStream x # to :: Rep DescribeDeliveryStream x -> DescribeDeliveryStream #
NFData DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Methods rnf :: DescribeDeliveryStream -> () #
Hashable DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Methods hashWithSalt :: Int -> DescribeDeliveryStream -> Int # hash :: DescribeDeliveryStream -> Int #
ToJSON DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Methods toJSON :: DescribeDeliveryStream -> Value # toEncoding :: DescribeDeliveryStream -> Encoding # toJSONList :: [DescribeDeliveryStream] -> Value # toEncodingList :: [DescribeDeliveryStream] -> Encoding #
AWSRequest DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Associated Types type AWSResponse DescribeDeliveryStream # Methods request :: DescribeDeliveryStream -> Request DescribeDeliveryStream # response :: MonadResource m => Logger -> Service -> Proxy DescribeDeliveryStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDeliveryStream))) #
ToHeaders DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Methods toHeaders :: DescribeDeliveryStream -> [Header] #
ToPath DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Methods toPath :: DescribeDeliveryStream -> ByteString #
ToQuery DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Methods toQuery :: DescribeDeliveryStream -> QueryString #
type Rep DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream type Rep DescribeDeliveryStream = D1 ('MetaData "DescribeDeliveryStream" "Amazonka.Firehose.DescribeDeliveryStream" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "DescribeDeliveryStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exclusiveStartDestinationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "deliveryStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream type AWSResponse DescribeDeliveryStream = DescribeDeliveryStreamResponse

newDescribeDeliveryStream Source #

Arguments

:: Text	`$sel:deliveryStreamName:DescribeDeliveryStream'`
-> DescribeDeliveryStream

Create a value of DescribeDeliveryStream 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:exclusiveStartDestinationId:DescribeDeliveryStream', describeDeliveryStream_exclusiveStartDestinationId - The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.

$sel:limit:DescribeDeliveryStream', describeDeliveryStream_limit - The limit on the number of destinations to return. You can have one destination per delivery stream.

$sel:deliveryStreamName:DescribeDeliveryStream', describeDeliveryStream_deliveryStreamName - The name of the delivery stream.

Request Lenses

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

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

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

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

describeDeliveryStream_deliveryStreamName :: Lens' DescribeDeliveryStream Text Source #

The name of the delivery stream.

Destructuring the Response

data DescribeDeliveryStreamResponse Source #

See: newDescribeDeliveryStreamResponse smart constructor.

Constructors

DescribeDeliveryStreamResponse'
Fields httpStatus :: Int The response's http status code. deliveryStreamDescription :: DeliveryStreamDescription Information about the delivery stream.

Instances

Instances details

Eq DescribeDeliveryStreamResponse Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Methods (==) :: DescribeDeliveryStreamResponse -> DescribeDeliveryStreamResponse -> Bool # (/=) :: DescribeDeliveryStreamResponse -> DescribeDeliveryStreamResponse -> Bool #
Show DescribeDeliveryStreamResponse Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Methods showsPrec :: Int -> DescribeDeliveryStreamResponse -> ShowS # show :: DescribeDeliveryStreamResponse -> String # showList :: [DescribeDeliveryStreamResponse] -> ShowS #
Generic DescribeDeliveryStreamResponse Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Associated Types type Rep DescribeDeliveryStreamResponse :: Type -> Type # Methods from :: DescribeDeliveryStreamResponse -> Rep DescribeDeliveryStreamResponse x # to :: Rep DescribeDeliveryStreamResponse x -> DescribeDeliveryStreamResponse #
NFData DescribeDeliveryStreamResponse Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream Methods rnf :: DescribeDeliveryStreamResponse -> () #
type Rep DescribeDeliveryStreamResponse Source #
Instance details Defined in Amazonka.Firehose.DescribeDeliveryStream type Rep DescribeDeliveryStreamResponse = D1 ('MetaData "DescribeDeliveryStreamResponse" "Amazonka.Firehose.DescribeDeliveryStream" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "DescribeDeliveryStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "deliveryStreamDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeliveryStreamDescription)))

newDescribeDeliveryStreamResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDeliveryStreamResponse'`
-> DeliveryStreamDescription	`$sel:deliveryStreamDescription:DescribeDeliveryStreamResponse'`
-> DescribeDeliveryStreamResponse

Create a value of DescribeDeliveryStreamResponse 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:DescribeDeliveryStreamResponse', describeDeliveryStreamResponse_httpStatus - The response's http status code.

$sel:deliveryStreamDescription:DescribeDeliveryStreamResponse', describeDeliveryStreamResponse_deliveryStreamDescription - Information about the delivery stream.

Response Lenses

describeDeliveryStreamResponse_httpStatus :: Lens' DescribeDeliveryStreamResponse Int Source #

The response's http status code.

describeDeliveryStreamResponse_deliveryStreamDescription :: Lens' DescribeDeliveryStreamResponse DeliveryStreamDescription Source #

Information about the delivery stream.