List Streams

dynamodbstreams_list_streams

R Documentation

Returns an array of stream ARNs associated with the current account and endpoint¶

Description¶

Returns an array of stream ARNs associated with the current account and endpoint. If the TableName parameter is present, then list_streams will return only the streams ARNs for that table.

You can call list_streams at a maximum rate of 5 times per second.

Usage¶

dynamodbstreams_list_streams(TableName, Limit, ExclusiveStartStreamArn)

Arguments¶

TableName

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

Limit

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

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.

Value¶

A list with the following syntax:

list(
  Streams = list(
    list(
      StreamArn = "string",
      TableName = "string",
      StreamLabel = "string"
    )
  ),
  LastEvaluatedStreamArn = "string"
)

Request syntax¶

svc$list_streams(
  TableName = "string",
  Limit = 123,
  ExclusiveStartStreamArn = "string"
)

Examples¶

## Not run: 
# The following example lists all of the stream ARNs.
svc$list_streams()

## End(Not run)