@Generated(value="software.amazon.awssdk:codegen") public interface DynamoDBStreamsAsyncClient extends software.amazon.awssdk.utils.SdkAutoCloseable
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 | 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
software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
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(GetRecordsRequest getRecordsRequest)
Retrieves the stream records from a given shard.
|
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(ListStreamsRequest listStreamsRequest)
Returns an array of stream ARNs associated with the current account and endpoint.
|
static DynamoDBStreamsAsyncClient create()
DynamoDBStreamsAsyncClient
with the region loaded from the
software.amazon.awssdk.regions.providers.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.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.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.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.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.
Copyright © 2017. All rights reserved.