@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonDynamoDBStreamsClient extends AmazonWebServiceClient implements AmazonDynamoDBStreams
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonDynamoDBStreamsClient()
Deprecated.
|
AmazonDynamoDBStreamsClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonDynamoDBStreamsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonDynamoDBStreamsClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonDynamoDBStreamsClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonDynamoDBStreamsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonDynamoDBStreamsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonDynamoDBStreamsClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AmazonDynamoDBStreamsClientBuilder |
builder() |
DescribeStreamResult |
describeStream(DescribeStreamRequest request)
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.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetRecordsResult |
getRecords(GetRecordsRequest request)
Retrieves the stream records from a given shard.
|
GetShardIteratorResult |
getShardIterator(GetShardIteratorRequest request)
Returns a shard iterator.
|
ListStreamsResult |
listStreams(ListStreamsRequest request)
Returns an array of stream ARNs associated with the current account and endpoint.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@Deprecated public AmazonDynamoDBStreamsClient()
AmazonDynamoDBStreamsClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonDynamoDBStreamsClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Amazon DynamoDB Streams (ex:
proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AmazonDynamoDBStreamsClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonDynamoDBStreamsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonDynamoDBStreamsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon DynamoDB Streams (ex:
proxy settings, retry counts, etc.).@Deprecated public AmazonDynamoDBStreamsClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonDynamoDBStreamsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon DynamoDB Streams (ex:
proxy settings, retry counts, etc.).@Deprecated public AmazonDynamoDBStreamsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon DynamoDB Streams (ex:
proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AmazonDynamoDBStreamsClientBuilder builder()
public DescribeStreamResult describeStream(DescribeStreamRequest request)
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.
describeStream in interface AmazonDynamoDBStreamsdescribeStreamRequest - Represents the input of a DescribeStream operation.ResourceNotFoundException - The operation tried to access a nonexistent stream.InternalServerErrorException - An error occurred on the server side.public GetRecordsResult getRecords(GetRecordsRequest request)
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.
getRecords in interface AmazonDynamoDBStreamsgetRecordsRequest - Represents the input of a GetRecords operation.ResourceNotFoundException - The operation tried to access a nonexistent stream.LimitExceededException - Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this
exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce
the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.InternalServerErrorException - An error occurred on the server side.ExpiredIteratorException - The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator
expires 15 minutes after it is retrieved using the GetShardIterator action.TrimmedDataAccessException - The operation attempted to read past the oldest stream record in a shard.
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.
public GetShardIteratorResult getShardIterator(GetShardIteratorRequest request)
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.
getShardIterator in interface AmazonDynamoDBStreamsgetShardIteratorRequest - Represents the input of a GetShardIterator operation.ResourceNotFoundException - The operation tried to access a nonexistent stream.InternalServerErrorException - An error occurred on the server side.TrimmedDataAccessException - The operation attempted to read past the oldest stream record in a shard.
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.
public ListStreamsResult listStreams(ListStreamsRequest request)
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.
listStreams in interface AmazonDynamoDBStreamslistStreamsRequest - Represents the input of a ListStreams operation.ResourceNotFoundException - The operation tried to access a nonexistent stream.InternalServerErrorException - An error occurred on the server side.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonDynamoDBStreamsrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.