@Generated(value="software.amazon.awssdk:codegen") public interface DynamoDbStreamsClient extends SdkClient
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 | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and 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 DescribeStreamIterable |
describeStreamPaginator(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 DescribeStreamIterable |
describeStreamPaginator(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 ListStreamsIterable |
listStreamsPaginator()
Returns an array of stream ARNs associated with the current account and endpoint.
|
default ListStreamsIterable |
listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Returns an array of stream ARNs associated with the current account and endpoint.
|
default ListStreamsIterable |
listStreamsPaginator(ListStreamsRequest listStreamsRequest)
Returns an array of stream ARNs associated with the current account and endpoint.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static DynamoDbStreamsClient create()
DynamoDbStreamsClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static DynamoDbStreamsClientBuilder builder()
DynamoDbStreamsClient
.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.
describeStreamRequest
- Represents the input of a DescribeStream
operation.ResourceNotFoundException
- The operation tried to access a nonexistent stream.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
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()
describeStreamRequest
- A Consumer
that will call methods on DescribeStreamInput.Builder
to create a request.
Represents the input of a DescribeStream
operation.ResourceNotFoundException
- The operation tried to access a nonexistent stream.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
default DescribeStreamIterable describeStreamPaginator(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.
This is a variant of
describeStream(software.amazon.awssdk.services.dynamodb.model.DescribeStreamRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.dynamodb.streams.paginators.DescribeStreamIterable responses = client.describeStreamPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.dynamodb.streams.paginators.DescribeStreamIterable responses = client .describeStreamPaginator(request); for (software.amazon.awssdk.services.dynamodb.model.DescribeStreamResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.dynamodb.streams.paginators.DescribeStreamIterable responses = client.describeStreamPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeStream(software.amazon.awssdk.services.dynamodb.model.DescribeStreamRequest)
operation.
describeStreamRequest
- Represents the input of a DescribeStream
operation.ResourceNotFoundException
- The operation tried to access a nonexistent stream.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
default DescribeStreamIterable describeStreamPaginator(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 variant of
describeStream(software.amazon.awssdk.services.dynamodb.model.DescribeStreamRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.dynamodb.streams.paginators.DescribeStreamIterable responses = client.describeStreamPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.dynamodb.streams.paginators.DescribeStreamIterable responses = client .describeStreamPaginator(request); for (software.amazon.awssdk.services.dynamodb.model.DescribeStreamResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.dynamodb.streams.paginators.DescribeStreamIterable responses = client.describeStreamPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeStream(software.amazon.awssdk.services.dynamodb.model.DescribeStreamRequest)
operation.
This is a convenience which creates an instance of the DescribeStreamRequest.Builder
avoiding the need to
create one manually via DescribeStreamRequest.builder()
describeStreamRequest
- A Consumer
that will call methods on DescribeStreamInput.Builder
to create a request.
Represents the input of a DescribeStream
operation.ResourceNotFoundException
- The operation tried to access a nonexistent stream.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
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.
getRecordsRequest
- 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.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
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()
getRecordsRequest
- A Consumer
that will call methods on GetRecordsInput.Builder
to create a request.
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.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
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.
getShardIteratorRequest
- 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.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
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()
getShardIteratorRequest
- A Consumer
that will call methods on GetShardIteratorInput.Builder
to create a request.
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.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
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.
ResourceNotFoundException
- The operation tried to access a nonexistent stream.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
listStreams(ListStreamsRequest)
,
AWS
API Documentationdefault 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.
listStreamsRequest
- Represents the input of a ListStreams
operation.ResourceNotFoundException
- The operation tried to access a nonexistent stream.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
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()
listStreamsRequest
- A Consumer
that will call methods on ListStreamsInput.Builder
to create a request.
Represents the input of a ListStreams
operation.ResourceNotFoundException
- The operation tried to access a nonexistent stream.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
default ListStreamsIterable listStreamsPaginator() 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 variant of listStreams(software.amazon.awssdk.services.dynamodb.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsIterable responses = client .listStreamsPaginator(request); for (software.amazon.awssdk.services.dynamodb.model.ListStreamsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.dynamodb.model.ListStreamsRequest)
operation.
ResourceNotFoundException
- The operation tried to access a nonexistent stream.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
listStreamsPaginator(ListStreamsRequest)
,
AWS
API Documentationdefault ListStreamsIterable listStreamsPaginator(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.
This is a variant of listStreams(software.amazon.awssdk.services.dynamodb.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsIterable responses = client .listStreamsPaginator(request); for (software.amazon.awssdk.services.dynamodb.model.ListStreamsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.dynamodb.model.ListStreamsRequest)
operation.
listStreamsRequest
- Represents the input of a ListStreams
operation.ResourceNotFoundException
- The operation tried to access a nonexistent stream.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
default ListStreamsIterable listStreamsPaginator(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 variant of listStreams(software.amazon.awssdk.services.dynamodb.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsIterable responses = client .listStreamsPaginator(request); for (software.amazon.awssdk.services.dynamodb.model.ListStreamsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.dynamodb.model.ListStreamsRequest)
operation.
This is a convenience which creates an instance of the ListStreamsRequest.Builder
avoiding the need to
create one manually via ListStreamsRequest.builder()
listStreamsRequest
- A Consumer
that will call methods on ListStreamsInput.Builder
to create a request.
Represents the input of a ListStreams
operation.ResourceNotFoundException
- The operation tried to access a nonexistent stream.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
DynamoDbException
static ServiceMetadata serviceMetadata()
Copyright © 2019. All rights reserved.