Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Lists your delivery streams.
The number of delivery streams might be too large to return using a single call to ListDeliveryStreams
. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams
in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the ExclusiveStartDeliveryStreamName
parameter of a subsequent call.
- listDeliveryStreams :: ListDeliveryStreams
- data ListDeliveryStreams
- ldsLimit :: Lens' ListDeliveryStreams (Maybe Natural)
- ldsDeliveryStreamType :: Lens' ListDeliveryStreams (Maybe DeliveryStreamType)
- ldsExclusiveStartDeliveryStreamName :: Lens' ListDeliveryStreams (Maybe Text)
- listDeliveryStreamsResponse :: Int -> Bool -> ListDeliveryStreamsResponse
- data ListDeliveryStreamsResponse
- ldsrsResponseStatus :: Lens' ListDeliveryStreamsResponse Int
- ldsrsDeliveryStreamNames :: Lens' ListDeliveryStreamsResponse [Text]
- ldsrsHasMoreDeliveryStreams :: Lens' ListDeliveryStreamsResponse Bool
Creating a Request
listDeliveryStreams :: ListDeliveryStreams Source #
Creates a value of ListDeliveryStreams
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldsLimit
- The maximum number of delivery streams to list. The default value is 10.ldsDeliveryStreamType
- The delivery stream type. This can be one of the following values: *DirectPut
: Provider applications access the delivery stream directly. *KinesisStreamAsSource
: The delivery stream uses a Kinesis data stream as a source. This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.ldsExclusiveStartDeliveryStreamName
- The name of the delivery stream to start the list with.
data ListDeliveryStreams Source #
See: listDeliveryStreams
smart constructor.
Request Lenses
ldsLimit :: Lens' ListDeliveryStreams (Maybe Natural) Source #
The maximum number of delivery streams to list. The default value is 10.
ldsDeliveryStreamType :: Lens' ListDeliveryStreams (Maybe DeliveryStreamType) Source #
The delivery stream type. This can be one of the following values: * DirectPut
: Provider applications access the delivery stream directly. * KinesisStreamAsSource
: The delivery stream uses a Kinesis data stream as a source. This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.
ldsExclusiveStartDeliveryStreamName :: Lens' ListDeliveryStreams (Maybe Text) Source #
The name of the delivery stream to start the list with.
Destructuring the Response
listDeliveryStreamsResponse Source #
Creates a value of ListDeliveryStreamsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldsrsResponseStatus
- -- | The response status code.ldsrsDeliveryStreamNames
- The names of the delivery streams.ldsrsHasMoreDeliveryStreams
- Indicates whether there are more delivery streams available to list.
data ListDeliveryStreamsResponse Source #
See: listDeliveryStreamsResponse
smart constructor.
Response Lenses
ldsrsResponseStatus :: Lens' ListDeliveryStreamsResponse Int Source #
- - | The response status code.
ldsrsDeliveryStreamNames :: Lens' ListDeliveryStreamsResponse [Text] Source #
The names of the delivery streams.
ldsrsHasMoreDeliveryStreams :: Lens' ListDeliveryStreamsResponse Bool Source #
Indicates whether there are more delivery streams available to list.