Package software.amazon.awssdk.services.dynamodbstreams

Interface DynamoDBStreamsClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface DynamoDBStreamsClient
extends AutoCloseable

Service client for accessing null. This can be created using the static builder() method. Amazon DynamoDB

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.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static DynamoDBStreamsClientBuilder	builder()	Create a builder that can be used to configure and create a DynamoDBStreamsClient.
static DynamoDBStreamsClient	create()	Create a DynamoDBStreamsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default 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 GetRecordsResponse	getRecords(GetRecordsRequest getRecordsRequest)	Retrieves the stream records from a given shard.
default GetShardIteratorResponse	getShardIterator(GetShardIteratorRequest getShardIteratorRequest)	Returns a shard iterator.
default ListStreamsResponse	listStreams(ListStreamsRequest listStreamsRequest)	Returns an array of stream ARNs associated with the current account and endpoint.
static ServiceMetadata	serviceMetadata()

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static DynamoDBStreamsClient create()

Create a DynamoDBStreamsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static DynamoDBStreamsClientBuilder builder()

Create a builder that can be used to configure and create a DynamoDBStreamsClient.

describeStream

default DescribeStreamResponse describeStream(DescribeStreamRequest describeStreamRequest)
                                       throws ResourceNotFoundException,
                                              InternalServerErrorException,
                                              SdkBaseException,
                                              SdkClientException,
                                              DynamoDBException

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.

Parameters:

describeStreamRequest - Represents the input of a DescribeStream operation.

Returns:

Result of the DescribeStream operation returned by the service.

Throws:

ResourceNotFoundException - The operation tried to access a nonexistent stream.

InternalServerErrorException - An error occurred on the server side.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DynamoDBStreamsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

DynamoDBException

See Also:

AWS API Documentation

getRecords

default GetRecordsResponse getRecords(GetRecordsRequest getRecordsRequest)
                               throws ResourceNotFoundException,
                                      LimitExceededException,
                                      InternalServerErrorException,
                                      ExpiredIteratorException,
                                      TrimmedDataAccessException,
                                      SdkBaseException,
                                      SdkClientException,
                                      DynamoDBException

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.

Parameters:

getRecordsRequest - Represents the input of a GetRecords operation.

Returns:

Result of the GetRecords operation returned by the service.

Throws:

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DynamoDBStreamsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

DynamoDBException

See Also:

AWS API Documentation

getShardIterator

default GetShardIteratorResponse getShardIterator(GetShardIteratorRequest getShardIteratorRequest)
                                           throws ResourceNotFoundException,
                                                  InternalServerErrorException,
                                                  TrimmedDataAccessException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  DynamoDBException

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.

Parameters:

getShardIteratorRequest - Represents the input of a GetShardIterator operation.

Returns:

Result of the GetShardIterator operation returned by the service.

Throws:

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DynamoDBStreamsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

DynamoDBException

See Also:

AWS API Documentation

listStreams

default ListStreamsResponse listStreams(ListStreamsRequest listStreamsRequest)
                                 throws ResourceNotFoundException,
                                        InternalServerErrorException,
                                        SdkBaseException,
                                        SdkClientException,
                                        DynamoDBException

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.

Parameters:

listStreamsRequest - Represents the input of a ListStreams operation.

Returns:

Result of the ListStreams operation returned by the service.

Throws:

ResourceNotFoundException - The operation tried to access a nonexistent stream.

InternalServerErrorException - An error occurred on the server side.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DynamoDBStreamsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

DynamoDBException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()