Network.AWS.DynamoDBStreams.ListStreams

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.

Creating a Request

listStreams :: ListStreams

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:

• lsExclusiveStartStreamARN
• lsLimit
• lsTableName

data ListStreams

Represents the input of a ListStreams operation.

See: listStreams smart constructor.

Instances

Eq ListStreams

Data ListStreams

Read ListStreams

Show ListStreams

Generic ListStreams

ToJSON ListStreams

AWSRequest ListStreams

ToPath ListStreams

ToHeaders ListStreams

ToQuery ListStreams

Typeable * ListStreams

type Rep ListStreams

type Rs ListStreams = ListStreamsResponse

Request Lenses

lsExclusiveStartStreamARN :: Lens' ListStreams (Maybe Text)

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)

The maximum number of streams to return. The upper limit is 100.

lsTableName :: Lens' ListStreams (Maybe Text)

If this parameter is provided, then only the streams associated with this table name are returned.

Destructuring the Response

listStreamsResponse

Arguments

:: Int

lsrsStatus

-> ListStreamsResponse

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:

• lsrsLastEvaluatedStreamARN
• lsrsStreams
• lsrsStatus

data ListStreamsResponse

Represents the output of a ListStreams operation.

See: listStreamsResponse smart constructor.

Instances

Eq ListStreamsResponse

Data ListStreamsResponse

Read ListStreamsResponse

Show ListStreamsResponse

Generic ListStreamsResponse

Typeable * ListStreamsResponse

type Rep ListStreamsResponse

Response Lenses

lsrsLastEvaluatedStreamARN :: Lens' ListStreamsResponse (Maybe Text)

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]

A list of stream descriptors associated with the current account and endpoint.

lsrsStatus :: Lens' ListStreamsResponse Int

The response status code.