Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- describeDeliveryStream :: Text -> DescribeDeliveryStream
- data DescribeDeliveryStream
- ddsExclusiveStartDestinationId :: Lens' DescribeDeliveryStream (Maybe Text)
- ddsLimit :: Lens' DescribeDeliveryStream (Maybe Natural)
- ddsDeliveryStreamName :: Lens' DescribeDeliveryStream Text
- describeDeliveryStreamResponse :: Int -> DeliveryStreamDescription -> DescribeDeliveryStreamResponse
- data DescribeDeliveryStreamResponse
- ddsrsResponseStatus :: Lens' DescribeDeliveryStreamResponse Int
- ddsrsDeliveryStreamDescription :: Lens' DescribeDeliveryStreamResponse DeliveryStreamDescription
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
- Specifies the destination ID to start returning the destination information. Currently 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 #
Contains the parameters for DescribeDeliveryStream
.
See: describeDeliveryStream
smart constructor.
Request Lenses
ddsExclusiveStartDestinationId :: Lens' DescribeDeliveryStream (Maybe Text) Source #
Specifies the destination ID to start returning the destination information. Currently 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:
ddsrsResponseStatus
- -- | The response status code.ddsrsDeliveryStreamDescription
- Information about the delivery stream.
data DescribeDeliveryStreamResponse Source #
Contains the output of DescribeDeliveryStream
.
See: describeDeliveryStreamResponse
smart constructor.
Response Lenses
ddsrsResponseStatus :: Lens' DescribeDeliveryStreamResponse Int Source #
- - | The response status code.
ddsrsDeliveryStreamDescription :: Lens' DescribeDeliveryStreamResponse DeliveryStreamDescription Source #
Information about the delivery stream.