| 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.DynamoDBStreams.ListStreams
Description
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.
Synopsis
- data ListStreams = ListStreams' {}
- newListStreams :: ListStreams
- listStreams_exclusiveStartStreamArn :: Lens' ListStreams (Maybe Text)
- listStreams_limit :: Lens' ListStreams (Maybe Natural)
- listStreams_tableName :: Lens' ListStreams (Maybe Text)
- data ListStreamsResponse = ListStreamsResponse' {
- lastEvaluatedStreamArn :: Maybe Text
- streams :: Maybe [Stream]
- httpStatus :: Int
- newListStreamsResponse :: Int -> ListStreamsResponse
- listStreamsResponse_lastEvaluatedStreamArn :: Lens' ListStreamsResponse (Maybe Text)
- listStreamsResponse_streams :: Lens' ListStreamsResponse (Maybe [Stream])
- listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int
Creating a Request
data ListStreams Source #
Represents the input of a ListStreams operation.
See: newListStreams smart constructor.
Constructors
| ListStreams' | |
Fields
| |
Instances
newListStreams :: ListStreams Source #
Create a value of ListStreams 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:exclusiveStartStreamArn:ListStreams', listStreams_exclusiveStartStreamArn - 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.
$sel:limit:ListStreams', listStreams_limit - The maximum number of streams to return. The upper limit is 100.
$sel:tableName:ListStreams', listStreams_tableName - If this parameter is provided, then only the streams associated with
this table name are returned.
Request Lenses
listStreams_exclusiveStartStreamArn :: 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.
listStreams_limit :: Lens' ListStreams (Maybe Natural) Source #
The maximum number of streams to return. The upper limit is 100.
listStreams_tableName :: Lens' ListStreams (Maybe Text) Source #
If this parameter is provided, then only the streams associated with this table name are returned.
Destructuring the Response
data ListStreamsResponse Source #
Represents the output of a ListStreams operation.
See: newListStreamsResponse smart constructor.
Constructors
| ListStreamsResponse' | |
Fields
| |
Instances
newListStreamsResponse Source #
Arguments
| :: Int | |
| -> ListStreamsResponse |
Create a value of ListStreamsResponse 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:lastEvaluatedStreamArn:ListStreamsResponse', listStreamsResponse_lastEvaluatedStreamArn - 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.
$sel:streams:ListStreamsResponse', listStreamsResponse_streams - A list of stream descriptors associated with the current account and
endpoint.
$sel:httpStatus:ListStreamsResponse', listStreamsResponse_httpStatus - The response's http status code.
Response Lenses
listStreamsResponse_lastEvaluatedStreamArn :: 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.
listStreamsResponse_streams :: Lens' ListStreamsResponse (Maybe [Stream]) Source #
A list of stream descriptors associated with the current account and endpoint.
listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int Source #
The response's http status code.