Package software.amazon.awssdk.services.dynamodb.streams

Interface DynamoDbStreamsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface DynamoDbStreamsClient
extends AwsClient

Service client for accessing Amazon DynamoDB Streams. 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 final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final 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(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 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(Consumer<GetRecordsRequest.Builder> getRecordsRequest)	Retrieves the stream records from a given shard.
default GetRecordsResponse	getRecords(GetRecordsRequest getRecordsRequest)	Retrieves the stream records from a given shard.
default GetShardIteratorResponse	getShardIterator(Consumer<GetShardIteratorRequest.Builder> getShardIteratorRequest)	Returns a shard iterator.
default GetShardIteratorResponse	getShardIterator(GetShardIteratorRequest getShardIteratorRequest)	Returns a shard iterator.
default ListStreamsResponse	listStreams()	Returns an array of stream ARNs associated with the current account and endpoint.
default ListStreamsResponse	listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)	Returns an array of stream ARNs associated with the current account and endpoint.
default ListStreamsResponse	listStreams(ListStreamsRequest listStreamsRequest)	Returns an array of stream ARNs associated with the current account and endpoint.
default DynamoDbStreamsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

describeStream

default DescribeStreamResponse describeStream(DescribeStreamRequest describeStreamRequest)
                                       throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
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.

See Also:

• AWS API Documentation

describeStream

default DescribeStreamResponse describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)
                                       throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
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.

This is a convenience which creates an instance of the DescribeStreamRequest.Builder avoiding the need to create one manually via DescribeStreamRequest.builder()

Parameters:

describeStreamRequest - A Consumer that will call methods on DescribeStreamRequest.Builder to create a request. Represents the input of a DescribeStream operation.

Returns:

Result of the DescribeStream operation returned by the service.

See Also:

• AWS API Documentation

getRecords

default GetRecordsResponse getRecords(GetRecordsRequest getRecordsRequest)
                               throws ResourceNotFoundException,
LimitExceededException,
InternalServerErrorException,
ExpiredIteratorException,
TrimmedDataAccessException,
AwsServiceException,
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.

See Also:

• AWS API Documentation

getRecords

default GetRecordsResponse getRecords(Consumer<GetRecordsRequest.Builder> getRecordsRequest)
                               throws ResourceNotFoundException,
LimitExceededException,
InternalServerErrorException,
ExpiredIteratorException,
TrimmedDataAccessException,
AwsServiceException,
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.

This is a convenience which creates an instance of the GetRecordsRequest.Builder avoiding the need to create one manually via GetRecordsRequest.builder()

Parameters:

getRecordsRequest - A Consumer that will call methods on GetRecordsRequest.Builder to create a request. Represents the input of a GetRecords operation.

Returns:

Result of the GetRecords operation returned by the service.

See Also:

• AWS API Documentation

getShardIterator

default GetShardIteratorResponse getShardIterator(GetShardIteratorRequest getShardIteratorRequest)
                                           throws ResourceNotFoundException,
InternalServerErrorException,
TrimmedDataAccessException,
AwsServiceException,
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.

See Also:

• AWS API Documentation

getShardIterator

default GetShardIteratorResponse getShardIterator(Consumer<GetShardIteratorRequest.Builder> getShardIteratorRequest)
                                           throws ResourceNotFoundException,
InternalServerErrorException,
TrimmedDataAccessException,
AwsServiceException,
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.

This is a convenience which creates an instance of the GetShardIteratorRequest.Builder avoiding the need to create one manually via GetShardIteratorRequest.builder()

Parameters:

getShardIteratorRequest - A Consumer that will call methods on GetShardIteratorRequest.Builder to create a request. Represents the input of a GetShardIterator operation.

Returns:

Result of the GetShardIterator operation returned by the service.

See Also:

• AWS API Documentation

listStreams

default ListStreamsResponse listStreams(ListStreamsRequest listStreamsRequest)
                                 throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
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.

See Also:

• AWS API Documentation

listStreams

default ListStreamsResponse listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
                                 throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
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.

This is a convenience which creates an instance of the ListStreamsRequest.Builder avoiding the need to create one manually via ListStreamsRequest.builder()

Parameters:

listStreamsRequest - A Consumer that will call methods on ListStreamsRequest.Builder to create a request. Represents the input of a ListStreams operation.

Returns:

Result of the ListStreams operation returned by the service.

See Also:

• AWS API Documentation

listStreams

default ListStreamsResponse listStreams()
                                 throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
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.

Returns:

Result of the ListStreams operation returned by the service.

See Also:

• listStreams(ListStreamsRequest)
• AWS API Documentation

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.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default DynamoDbStreamsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration