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 |
Returns an array of stream ARNs associated with the current account and
endpoint. If the TableName
parameter is present, then ListStreams
will return only the streams ARNs for that table.
You can call ListStreams at a maximum rate of 5 times per second.
See: AWS API Reference for ListStreams.
- listStreams :: ListStreams
- data ListStreams
- lsExclusiveStartStreamARN :: Lens' ListStreams (Maybe Text)
- lsLimit :: Lens' ListStreams (Maybe Natural)
- lsTableName :: Lens' ListStreams (Maybe Text)
- listStreamsResponse :: Int -> ListStreamsResponse
- data ListStreamsResponse
- lsrsLastEvaluatedStreamARN :: Lens' ListStreamsResponse (Maybe Text)
- lsrsStreams :: Lens' ListStreamsResponse [Stream]
- lsrsStatus :: Lens' ListStreamsResponse Int
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 of a ListStreams operation.
See: listStreams
smart constructor.
Request Lenses
lsExclusiveStartStreamARN :: Lens' ListStreams (Maybe Text) Source
The ARN (Amazon Resource Name) of the first item that this operation
will evaluate. Use the value that was returned for
LastEvaluatedStreamArn
in the previous operation.
lsLimit :: Lens' ListStreams (Maybe Natural) Source
The maximum number of streams to return. The upper limit is 100.
lsTableName :: Lens' ListStreams (Maybe Text) Source
If this parameter is provided, then only the streams associated with this table name are returned.
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 of a ListStreams operation.
See: listStreamsResponse
smart constructor.
Response Lenses
lsrsLastEvaluatedStreamARN :: Lens' ListStreamsResponse (Maybe Text) Source
The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedStreamArn
is empty, then the "last page" of results
has been processed and there is no more data to be retrieved.
If LastEvaluatedStreamArn
is not empty, it does not necessarily mean
that there is more data in the result set. The only way to know when you
have reached the end of the result set is when LastEvaluatedStreamArn
is empty.
lsrsStreams :: Lens' ListStreamsResponse [Stream] Source
A list of stream descriptors associated with the current account and endpoint.
lsrsStatus :: Lens' ListStreamsResponse Int Source
The response status code.