public interface AmazonDynamoDBStreamsAsync extends AmazonDynamoDBStreams
AsyncHandler
can be
used to receive notification when an asynchronous operation completes.
This is the Amazon DynamoDB Streams API Reference. This guide describes the low-level API actions for accessing streams and processing stream records. For information about application development with DynamoDB Streams, see the Amazon DynamoDB Developer Guide.
Note that this document is intended for use with the following DynamoDB documentation:
The following are short descriptions of each low-level DynamoDB Streams API action, organized by function.
DescribeStream - Returns detailed information about a particular stream.
GetRecords - Retrieves the stream records from within a shard.
GetShardIterator - Returns information on how to retrieve the streams record from a shard with a given shard ID.
ListStreams - Returns a list of all the streams associated with the current AWS account and endpoint.
Modifier and Type | Method and Description |
---|---|
Future<DescribeStreamResult> |
describeStreamAsync(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.
|
Future<DescribeStreamResult> |
describeStreamAsync(DescribeStreamRequest describeStreamRequest,
AsyncHandler<DescribeStreamRequest,DescribeStreamResult> asyncHandler)
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.
|
Future<GetRecordsResult> |
getRecordsAsync(GetRecordsRequest getRecordsRequest)
Retrieves the stream records from a given shard.
|
Future<GetRecordsResult> |
getRecordsAsync(GetRecordsRequest getRecordsRequest,
AsyncHandler<GetRecordsRequest,GetRecordsResult> asyncHandler)
Retrieves the stream records from a given shard.
|
Future<GetShardIteratorResult> |
getShardIteratorAsync(GetShardIteratorRequest getShardIteratorRequest)
Returns a shard iterator.
|
Future<GetShardIteratorResult> |
getShardIteratorAsync(GetShardIteratorRequest getShardIteratorRequest,
AsyncHandler<GetShardIteratorRequest,GetShardIteratorResult> asyncHandler)
Returns a shard iterator.
|
Future<ListStreamsResult> |
listStreamsAsync(ListStreamsRequest listStreamsRequest)
Returns an array of stream ARNs associated with the current account and
endpoint.
|
Future<ListStreamsResult> |
listStreamsAsync(ListStreamsRequest listStreamsRequest,
AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)
Returns an array of stream ARNs associated with the current account and
endpoint.
|
describeStream, getCachedResponseMetadata, getRecords, getShardIterator, listStreams, setEndpoint, setRegion, shutdown
Future<DescribeStreamResult> describeStreamAsync(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, the that shared is
closed and can no longer receive more data.
describeStreamRequest
- Represents the input of a DescribeStream operation.Future<DescribeStreamResult> describeStreamAsync(DescribeStreamRequest describeStreamRequest, AsyncHandler<DescribeStreamRequest,DescribeStreamResult> asyncHandler)
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, the that shared is
closed and can no longer receive more data.
describeStreamRequest
- Represents the input of a DescribeStream operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetRecordsResult> getRecordsAsync(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.
getRecordsRequest
- Represents the input of a GetRecords operation.Future<GetRecordsResult> getRecordsAsync(GetRecordsRequest getRecordsRequest, AsyncHandler<GetRecordsRequest,GetRecordsResult> asyncHandler)
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.
getRecordsRequest
- Represents the input of a GetRecords operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetShardIteratorResult> getShardIteratorAsync(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.Future<GetShardIteratorResult> getShardIteratorAsync(GetShardIteratorRequest getShardIteratorRequest, AsyncHandler<GetShardIteratorRequest,GetShardIteratorResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStreamsResult> listStreamsAsync(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.Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest listStreamsRequest, AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2015. All rights reserved.