Class: Aws::DynamoDBStreams::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DynamoDBStreams::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/client.rb
Overview
An API client for DynamoDBStreams. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::DynamoDBStreams::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#describe_stream(params = {}) ⇒ Types::DescribeStreamOutput
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.
-
#get_records(params = {}) ⇒ Types::GetRecordsOutput
Retrieves the stream records from a given shard.
-
#get_shard_iterator(params = {}) ⇒ Types::GetShardIteratorOutput
Returns a shard iterator.
-
#list_streams(params = {}) ⇒ Types::ListStreamsOutput
Returns an array of stream ARNs associated with the current account and endpoint.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
381 382 383 |
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/client.rb', line 381 def initialize(*args) super end |
Instance Method Details
#describe_stream(params = {}) ⇒ Types::DescribeStreamOutput
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.
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.
511 512 513 514 |
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/client.rb', line 511 def describe_stream(params = {}, = {}) req = build_request(:describe_stream, params) req.send_request() end |
#get_records(params = {}) ⇒ Types::GetRecordsOutput
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.
657 658 659 660 |
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/client.rb', line 657 def get_records(params = {}, = {}) req = build_request(:get_records, params) req.send_request() end |
#get_shard_iterator(params = {}) ⇒ Types::GetShardIteratorOutput
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.
740 741 742 743 |
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/client.rb', line 740 def get_shard_iterator(params = {}, = {}) req = build_request(:get_shard_iterator, params) req.send_request() end |
#list_streams(params = {}) ⇒ Types::ListStreamsOutput
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.
ListStreams
at a maximum rate of 5 times per second.
819 820 821 822 |
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/client.rb', line 819 def list_streams(params = {}, = {}) req = build_request(:list_streams, params) req.send_request() end |