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

Class: Aws::Kinesis::Waiters::StreamNotExists

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/waiters.rb

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ StreamNotExists

Returns a new instance of StreamNotExists

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 18
  • :delay (Integer) — default: 10
  • :before_attempt (Proc)
  • :before_wait (Proc)


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/waiters.rb', line 57

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 18,
    delay: 10,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_stream,
      acceptors: [{
        "expected" => "ResourceNotFoundException",
        "matcher" => "error",
        "state" => "success"
      }]
    )
  }.merge(options))
end

Instance Method Details

#wait(params = {}) ⇒ Types::DescribeStreamOutput

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream to describe.

  • :limit (Integer)

    The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

  • :exclusive_start_shard_id (String)

    The shard ID of the shard to start with.

Returns:



75
76
77
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/waiters.rb', line 75

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end