Copyright | (c) 2013-2015 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 |
Lists your streams.
The number of streams may be too large to return from a single call to
ListStreams
. You can limit the number of returned streams using the
Limit
parameter. If you do not specify a value for the Limit
parameter, Amazon Kinesis uses the default limit, which is currently 10.
You can detect if there are more streams available to list by using the
HasMoreStreams
flag from the returned output. If there are more
streams available, you can request more streams by using the name of the
last stream returned by the ListStreams
request in the
ExclusiveStartStreamName
parameter in a subsequent request to
ListStreams
. The group of stream names returned by the subsequent
request is then added to the list. You can continue this process until
all the stream names have been collected in the list.
ListStreams has a limit of 5 transactions per second per account.
See: AWS API Reference for ListStreams.
This operation returns paginated results.
- listStreams :: ListStreams
- data ListStreams
- lsLimit :: Lens' ListStreams (Maybe Natural)
- lsExclusiveStartStreamName :: Lens' ListStreams (Maybe Text)
- listStreamsResponse :: Int -> Bool -> ListStreamsResponse
- data ListStreamsResponse
- lsrsStatus :: Lens' ListStreamsResponse Int
- lsrsStreamNames :: Lens' ListStreamsResponse [Text]
- lsrsHasMoreStreams :: Lens' ListStreamsResponse Bool
Creating a Request
listStreams :: ListStreams Source
Creates a value of ListStreams
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListStreams Source
Represents the input for ListStreams
.
See: listStreams
smart constructor.
Request Lenses
lsExclusiveStartStreamName :: Lens' ListStreams (Maybe Text) Source
The name of the stream to start the list with.
Destructuring the Response
Creates a value of ListStreamsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListStreamsResponse Source
Represents the output for ListStreams
.
See: listStreamsResponse
smart constructor.
Response Lenses
lsrsStatus :: Lens' ListStreamsResponse Int Source
The response status code.
lsrsStreamNames :: Lens' ListStreamsResponse [Text] Source
The names of the streams that are associated with the AWS account making
the ListStreams
request.
lsrsHasMoreStreams :: Lens' ListStreamsResponse Bool Source
If set to true
, there are more streams available to list.