@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface DynamoDbStreamsAsyncClient extends SdkClient
builder() method.
Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see Capturing Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static DynamoDbStreamsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
DynamoDbStreamsAsyncClient. |
static DynamoDbStreamsAsyncClient |
create()
Create a
DynamoDbStreamsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<DescribeStreamResponse> |
describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)
Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN),
the composition of its shards, and its corresponding DynamoDB table.
|
default CompletableFuture<DescribeStreamResponse> |
describeStream(DescribeStreamRequest describeStreamRequest)
Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN),
the composition of its shards, and its corresponding DynamoDB table.
|
default CompletableFuture<GetRecordsResponse> |
getRecords(Consumer<GetRecordsRequest.Builder> getRecordsRequest)
Retrieves the stream records from a given shard.
|
default CompletableFuture<GetRecordsResponse> |
getRecords(GetRecordsRequest getRecordsRequest)
Retrieves the stream records from a given shard.
|
default CompletableFuture<GetShardIteratorResponse> |
getShardIterator(Consumer<GetShardIteratorRequest.Builder> getShardIteratorRequest)
Returns a shard iterator.
|
default CompletableFuture<GetShardIteratorResponse> |
getShardIterator(GetShardIteratorRequest getShardIteratorRequest)
Returns a shard iterator.
|
default CompletableFuture<ListStreamsResponse> |
listStreams()
Returns an array of stream ARNs associated with the current account and endpoint.
|
default CompletableFuture<ListStreamsResponse> |
listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Returns an array of stream ARNs associated with the current account and endpoint.
|
default CompletableFuture<ListStreamsResponse> |
listStreams(ListStreamsRequest listStreamsRequest)
Returns an array of stream ARNs associated with the current account and endpoint.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static DynamoDbStreamsAsyncClient create()
DynamoDbStreamsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DynamoDbStreamsAsyncClientBuilder builder()
DynamoDbStreamsAsyncClient.default CompletableFuture<DescribeStreamResponse> describeStream(DescribeStreamRequest describeStreamRequest)
Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.
You can call DescribeStream at a maximum rate of 10 times per second.
Each shard in the stream has a SequenceNumberRange associated with it. If the
SequenceNumberRange has a StartingSequenceNumber but no
EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both
StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed
and can no longer receive more data.
describeStreamRequest - Represents the input of a DescribeStream operation.ACTIVE.default CompletableFuture<DescribeStreamResponse> describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)
Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.
You can call DescribeStream at a maximum rate of 10 times per second.
Each shard in the stream has a SequenceNumberRange associated with it. If the
SequenceNumberRange has a StartingSequenceNumber but no
EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both
StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed
and can no longer receive more data.
This is a convenience which creates an instance of the DescribeStreamRequest.Builder avoiding the need to
create one manually via DescribeStreamRequest.builder()
describeStreamRequest - A Consumer that will call methods on DescribeStreamInput.Builder to create a request.
Represents the input of a DescribeStream operation.ACTIVE.default CompletableFuture<GetRecordsResponse> getRecords(GetRecordsRequest getRecordsRequest)
Retrieves the stream records from a given shard.
Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the
position in the shard from which you want to start reading stream records sequentially. If there are no stream
records available in the portion of the shard that the iterator points to, GetRecords returns an
empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.
GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first.
getRecordsRequest - Represents the input of a GetRecords operation.ACTIVE.
Up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable, UpdateTable, DeleteTable,
UpdateTimeToLive, RestoreTableFromBackup, and
RestoreTableToPointInTime.
The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.
There is a soft account quota of 2,500 tables.
GetShardIterator action.In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:
You request a shard iterator with a sequence number older than the trim point (24 hours).
You obtain a shard iterator, but before you use the iterator in a GetRecords request, a
stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access
a record that no longer exists.
default CompletableFuture<GetRecordsResponse> getRecords(Consumer<GetRecordsRequest.Builder> getRecordsRequest)
Retrieves the stream records from a given shard.
Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the
position in the shard from which you want to start reading stream records sequentially. If there are no stream
records available in the portion of the shard that the iterator points to, GetRecords returns an
empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.
GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first.
This is a convenience which creates an instance of the GetRecordsRequest.Builder avoiding the need to
create one manually via GetRecordsRequest.builder()
getRecordsRequest - A Consumer that will call methods on GetRecordsInput.Builder to create a request.
Represents the input of a GetRecords operation.ACTIVE.
Up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable, UpdateTable, DeleteTable,
UpdateTimeToLive, RestoreTableFromBackup, and
RestoreTableToPointInTime.
The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.
There is a soft account quota of 2,500 tables.
GetShardIterator action.In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:
You request a shard iterator with a sequence number older than the trim point (24 hours).
You obtain a shard iterator, but before you use the iterator in a GetRecords request, a
stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access
a record that no longer exists.
default CompletableFuture<GetShardIteratorResponse> getShardIterator(GetShardIteratorRequest getShardIteratorRequest)
Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from
within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records
from the shard.
A shard iterator expires 15 minutes after it is returned to the requester.
getShardIteratorRequest - Represents the input of a GetShardIterator operation.ACTIVE.In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:
You request a shard iterator with a sequence number older than the trim point (24 hours).
You obtain a shard iterator, but before you use the iterator in a GetRecords request, a
stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access
a record that no longer exists.
default CompletableFuture<GetShardIteratorResponse> getShardIterator(Consumer<GetShardIteratorRequest.Builder> getShardIteratorRequest)
Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from
within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records
from the shard.
A shard iterator expires 15 minutes after it is returned to the requester.
This is a convenience which creates an instance of the GetShardIteratorRequest.Builder avoiding the need
to create one manually via GetShardIteratorRequest.builder()
getShardIteratorRequest - A Consumer that will call methods on GetShardIteratorInput.Builder to create a request.
Represents the input of a GetShardIterator operation.ACTIVE.In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:
You request a shard iterator with a sequence number older than the trim point (24 hours).
You obtain a shard iterator, but before you use the iterator in a GetRecords request, a
stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access
a record that no longer exists.
default CompletableFuture<ListStreamsResponse> listStreams(ListStreamsRequest listStreamsRequest)
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.
listStreamsRequest - Represents the input of a ListStreams operation.ACTIVE.default CompletableFuture<ListStreamsResponse> listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
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.
This is a convenience which creates an instance of the ListStreamsRequest.Builder avoiding the need to
create one manually via ListStreamsRequest.builder()
listStreamsRequest - A Consumer that will call methods on ListStreamsInput.Builder to create a request.
Represents the input of a ListStreams operation.ACTIVE.default CompletableFuture<ListStreamsResponse> 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.
ACTIVE.Copyright © 2022. All rights reserved.