You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DynamoDBStreams::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon DynamoDB Streams. To construct a client, you need to configure a :region and :credentials.

dynamodbstreams = Aws::DynamoDBStreams::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::DynamoDBStreams::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::DynamoDBStreams::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#describe_stream(options = {}) ⇒ 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.

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.

Examples:

Example: To describe a stream with a given stream ARN


# The following example describes a stream with a given stream ARN.

resp = client.describe_stream({
  stream_arn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252", 
})

# resp.to_h outputs the following:
{
  stream_description: {
    creation_request_date_time: Time.parse("Wed May 20 13:51:10 PDT 2015"), 
    key_schema: [
      {
        attribute_name: "ForumName", 
        key_type: "HASH", 
      }, 
      {
        attribute_name: "Subject", 
        key_type: "RANGE", 
      }, 
    ], 
    shards: [
      {
        sequence_number_range: {
          ending_sequence_number: "20500000000000000910398", 
          starting_sequence_number: "20500000000000000910398", 
        }, 
        shard_id: "shardId-00000001414562045508-2bac9cd2", 
      }, 
      {
        parent_shard_id: "shardId-00000001414562045508-2bac9cd2", 
        sequence_number_range: {
          ending_sequence_number: "820400000000000001192334", 
          starting_sequence_number: "820400000000000001192334", 
        }, 
        shard_id: "shardId-00000001414576573621-f55eea83", 
      }, 
      {
        parent_shard_id: "shardId-00000001414576573621-f55eea83", 
        sequence_number_range: {
          ending_sequence_number: "1683700000000000001135967", 
          starting_sequence_number: "1683700000000000001135967", 
        }, 
        shard_id: "shardId-00000001414592258131-674fd923", 
      }, 
      {
        parent_shard_id: "shardId-00000001414592258131-674fd923", 
        sequence_number_range: {
          starting_sequence_number: "2574600000000000000935255", 
        }, 
        shard_id: "shardId-00000001414608446368-3a1afbaf", 
      }, 
    ], 
    stream_arn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252", 
    stream_label: "2015-05-20T20:51:10.252", 
    stream_status: "ENABLED", 
    stream_view_type: "NEW_AND_OLD_IMAGES", 
    table_name: "Forum", 
  }, 
}

Request syntax with placeholder values


resp = client.describe_stream({
  stream_arn: "StreamArn", # required
  limit: 1,
  exclusive_start_shard_id: "ShardId",
})

Response structure


resp.stream_description.stream_arn #=> String
resp.stream_description.stream_label #=> String
resp.stream_description.stream_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED"
resp.stream_description.stream_view_type #=> String, one of "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY"
resp.stream_description.creation_request_date_time #=> Time
resp.stream_description.table_name #=> String
resp.stream_description.key_schema #=> Array
resp.stream_description.key_schema[0].attribute_name #=> String
resp.stream_description.key_schema[0].key_type #=> String, one of "HASH", "RANGE"
resp.stream_description.shards #=> Array
resp.stream_description.shards[0].shard_id #=> String
resp.stream_description.shards[0].sequence_number_range.starting_sequence_number #=> String
resp.stream_description.shards[0].sequence_number_range.ending_sequence_number #=> String
resp.stream_description.shards[0].parent_shard_id #=> String
resp.stream_description.last_evaluated_shard_id #=> String

Options Hash (options):

  • :stream_arn (required, String)

    The Amazon Resource Name (ARN) for the stream.

  • :limit (Integer)

    The maximum number of shard objects to return. The upper limit is 100.

  • :exclusive_start_shard_id (String)

    The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Returns:

See Also:

#get_records(options = {}) ⇒ 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.

Examples:

Example: To retrieve all the stream records from a shard


# The following example retrieves all the stream records from a shard.

resp = client.get_records({
  shard_iterator: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ...  <remaining characters omitted> ...", 
})

# resp.to_h outputs the following:
{
  next_shard_iterator: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAGQBYshYDEe ... <remaining characters omitted> ...", 
  records: [
    {
      aws_region: "us-west-2", 
      dynamodb: {
        approximate_creation_date_time: Time.parse("1.46480646E9"), 
        keys: {
          "ForumName" => {
            s: "DynamoDB", 
          }, 
          "Subject" => {
            s: "DynamoDB Thread 3", 
          }, 
        }, 
        sequence_number: "300000000000000499659", 
        size_bytes: 41, 
        stream_view_type: "KEYS_ONLY", 
      }, 
      event_id: "e2fd9c34eff2d779b297b26f5fef4206", 
      event_name: "INSERT", 
      event_source: "aws:dynamodb", 
      event_version: "1.0", 
    }, 
    {
      aws_region: "us-west-2", 
      dynamodb: {
        approximate_creation_date_time: Time.parse("1.46480527E9"), 
        keys: {
          "ForumName" => {
            s: "DynamoDB", 
          }, 
          "Subject" => {
            s: "DynamoDB Thread 1", 
          }, 
        }, 
        sequence_number: "400000000000000499660", 
        size_bytes: 41, 
        stream_view_type: "KEYS_ONLY", 
      }, 
      event_id: "4b25bd0da9a181a155114127e4837252", 
      event_name: "MODIFY", 
      event_source: "aws:dynamodb", 
      event_version: "1.0", 
    }, 
    {
      aws_region: "us-west-2", 
      dynamodb: {
        approximate_creation_date_time: Time.parse("1.46480646E9"), 
        keys: {
          "ForumName" => {
            s: "DynamoDB", 
          }, 
          "Subject" => {
            s: "DynamoDB Thread 2", 
          }, 
        }, 
        sequence_number: "500000000000000499661", 
        size_bytes: 41, 
        stream_view_type: "KEYS_ONLY", 
      }, 
      event_id: "740280c73a3df7842edab3548a1b08ad", 
      event_name: "REMOVE", 
      event_source: "aws:dynamodb", 
      event_version: "1.0", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.get_records({
  shard_iterator: "ShardIterator", # required
  limit: 1,
})

Response structure


resp.records #=> Array
resp.records[0].event_id #=> String
resp.records[0].event_name #=> String, one of "INSERT", "MODIFY", "REMOVE"
resp.records[0].event_version #=> String
resp.records[0].event_source #=> String
resp.records[0].aws_region #=> String
resp.records[0].dynamodb.approximate_creation_date_time #=> Time
resp.records[0].dynamodb.keys #=> Hash
resp.records[0].dynamodb.keys["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.records[0].dynamodb.new_image #=> Hash
resp.records[0].dynamodb.new_image["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.records[0].dynamodb.old_image #=> Hash
resp.records[0].dynamodb.old_image["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.records[0].dynamodb.sequence_number #=> String
resp.records[0].dynamodb.size_bytes #=> Integer
resp.records[0].dynamodb.stream_view_type #=> String, one of "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY"
resp.records[0].user_identity.principal_id #=> String
resp.records[0].user_identity.type #=> String
resp.next_shard_iterator #=> String

Options Hash (options):

  • :shard_iterator (required, String)

    A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.

  • :limit (Integer)

    The maximum number of records to return from the shard. The upper limit is 1000.

Returns:

See Also:

#get_shard_iterator(options = {}) ⇒ 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.

A shard iterator expires 15 minutes after it is returned to the requester.

Examples:

Example: To obtain a shard iterator for the provided stream ARN and shard ID


# The following example returns a shard iterator for the provided stream ARN and shard ID.

resp = client.get_shard_iterator({
  shard_id: "00000001414576573621-f55eea83", 
  shard_iterator_type: "TRIM_HORIZON", 
  stream_arn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252", 
})

# resp.to_h outputs the following:
{
  shard_iterator: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ...  <remaining characters omitted> ...", 
}

Request syntax with placeholder values


resp = client.get_shard_iterator({
  stream_arn: "StreamArn", # required
  shard_id: "ShardId", # required
  shard_iterator_type: "TRIM_HORIZON", # required, accepts TRIM_HORIZON, LATEST, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER
  sequence_number: "SequenceNumber",
})

Response structure


resp.shard_iterator #=> String

Options Hash (options):

  • :stream_arn (required, String)

    The Amazon Resource Name (ARN) for the stream.

  • :shard_id (required, String)

    The identifier of the shard. The iterator will be returned for this shard ID.

  • :shard_iterator_type (required, String)

    Determines how the shard iterator is used to start reading stream records from the shard:

    • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

    • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

    • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the 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.

    • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

  • :sequence_number (String)

    The sequence number of a stream record in the shard from which to start reading.

Returns:

See Also:

#list_streams(options = {}) ⇒ 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.

You can call ListStreams at a maximum rate of 5 times per second.

Examples:

Example: To list all of the stream ARNs


# The following example lists all of the stream ARNs.

resp = client.list_streams({
})

# resp.to_h outputs the following:
{
  streams: [
    {
      stream_arn: "arn:aws:dynamodb:us-wesst-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252", 
      stream_label: "2015-05-20T20:51:10.252", 
      table_name: "Forum", 
    }, 
    {
      stream_arn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:50:02.714", 
      stream_label: "2015-05-20T20:50:02.714", 
      table_name: "Forum", 
    }, 
    {
      stream_arn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-19T23:03:50.641", 
      stream_label: "2015-05-19T23:03:50.641", 
      table_name: "Forum", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_streams({
  table_name: "TableName",
  limit: 1,
  exclusive_start_stream_arn: "StreamArn",
})

Response structure


resp.streams #=> Array
resp.streams[0].stream_arn #=> String
resp.streams[0].table_name #=> String
resp.streams[0].stream_label #=> String
resp.last_evaluated_stream_arn #=> String

Options Hash (options):

  • :table_name (String)

    If this parameter is provided, then only the streams associated with this table name are returned.

  • :limit (Integer)

    The maximum number of streams to return. The upper limit is 100.

  • :exclusive_start_stream_arn (String)

    The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {})

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.