@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonDynamoDBStreams extends Object implements AmazonDynamoDBStreams
AmazonDynamoDBStreams
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
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.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://streams.dynamodb.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonDynamoDBStreams.setEndpoint(String) , sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
public void setEndpoint(String endpoint)
AmazonDynamoDBStreams
Callers can pass in just the endpoint (ex: "streams.dynamodb.us-east-1.amazonaws.com") or a full URL, including
the protocol (ex: "https://streams.dynamodb.us-east-1.amazonaws.com"). If the protocol is not specified here, the
default protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AmazonDynamoDBStreams
endpoint
- The endpoint (ex: "streams.dynamodb.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://streams.dynamodb.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.public void setRegion(Region region)
AmazonDynamoDBStreams
AmazonDynamoDBStreams.setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AmazonDynamoDBStreams
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public DescribeStreamResult describeStream(DescribeStreamRequest request)
AmazonDynamoDBStreams
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 AmazonDynamoDBStreams
request
- Represents the input of a DescribeStream
operation.public GetRecordsResult getRecords(GetRecordsRequest request)
AmazonDynamoDBStreams
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 AmazonDynamoDBStreams
request
- Represents the input of a GetRecords
operation.public GetShardIteratorResult getShardIterator(GetShardIteratorRequest request)
AmazonDynamoDBStreams
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 AmazonDynamoDBStreams
request
- Represents the input of a GetShardIterator
operation.public ListStreamsResult listStreams(ListStreamsRequest request)
AmazonDynamoDBStreams
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 AmazonDynamoDBStreams
request
- Represents the input of a ListStreams
operation.public void shutdown()
AmazonDynamoDBStreams
shutdown
in interface AmazonDynamoDBStreams
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonDynamoDBStreams
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 a request.
getCachedResponseMetadata
in interface AmazonDynamoDBStreams
request
- The originally executed request.