Class: Aws::EC2::Waiters::SnapshotCompleted

Inherits:

Object

• Object
• Aws::EC2::Waiters::SnapshotCompleted

Defined in:

lib/aws-sdk-ec2/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ SnapshotCompleted constructor

  A new instance of SnapshotCompleted.

• #wait(params = {}) ⇒ Types::DescribeSnapshotsResult

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ SnapshotCompleted

Returns a new instance of SnapshotCompleted.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-ec2/waiters.rb', line 826

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 15,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_snapshots,
      acceptors: [{
        "expected" => "completed",
        "matcher" => "pathAll",
        "state" => "success",
        "argument" => "snapshots[].state"
      }]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-ec2/waiters.rb', line 850

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #snapshots => Array<Types::Snapshot>

• #next_token => String

Options Hash (params):

• :filters (Array<Types::Filter>) —

  One or more filters.

  • ‘description` - A description of the snapshot.

  • ‘owner-alias` - Value from an Amazon-maintained list (`amazon` | `aws-marketplace` | `microsoft`) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

  • ‘owner-id` - The ID of the AWS account that owns the snapshot.

  • ‘progress` - The progress of the snapshot, as a percentage (for example, 80%).

  • ‘snapshot-id` - The snapshot ID.

  • ‘start-time` - The time stamp when the snapshot was initiated.

  • ‘status` - The status of the snapshot (`pending` | `completed` | `error`).

  • ‘tag`:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

  • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • ‘volume-id` - The ID of the volume the snapshot is for.

  • ‘volume-size` - The size of the volume, in GiB.

• :max_results (Integer) —

  The maximum number of snapshot results returned by ‘DescribeSnapshots` in paginated output. When this parameter is used, `DescribeSnapshots` only returns `MaxResults` results in a single page along with a `NextToken` response element. The remaining results of the initial request can be seen by sending another `DescribeSnapshots` request with the returned `NextToken` value. This value can be between 5 and 1000; if `MaxResults` is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then `DescribeSnapshots` returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

• :next_token (String) —

  The ‘NextToken` value returned from a previous paginated `DescribeSnapshots` request where `MaxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `NextToken` value. This value is `null` when there are no more results to return.

• :owner_ids (Array<String>) —

  Returns the snapshots owned by the specified owner. Multiple owners can be specified.

• :restorable_by_user_ids (Array<String>) —

  One or more AWS accounts IDs that can create volumes from the snapshot.

• :snapshot_ids (Array<String>) —

  One or more snapshot IDs.

  Default: Describes snapshots for which you have launch permissions.

• :dry_run (Boolean) —

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

• (Types::DescribeSnapshotsResult) —

  Returns a response object which responds to the following methods:

  • #snapshots => Array&lt;Types::Snapshot&gt;

  • #next_token => String

# File 'lib/aws-sdk-ec2/waiters.rb', line 845

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