Class: Aws::EC2::Waiters::ImageAvailable

Inherits:

Object

• Object
• Aws::EC2::Waiters::ImageAvailable

Defined in:

lib/aws-sdk-ec2/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ ImageAvailable constructor

  A new instance of ImageAvailable.

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

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

Constructor Details

#initialize(options) ⇒ ImageAvailable

Returns a new instance of ImageAvailable.

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 309

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_images,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "pathAll",
          "argument" => "images[].state",
          "expected" => "available"
        },
        {
          "state" => "failure",
          "matcher" => "pathAny",
          "argument" => "images[].state",
          "expected" => "failed"
        }
      ]
    )
  }.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 341

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #images => Array<Types::Image>

Options Hash (params):

• :executable_users (Array<String>) —

  Scopes the images by users with explicit launch permissions. Specify an AWS account ID, ‘self` (the sender of the request), or `all` (public AMIs).

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

  One or more filters.

  • ‘architecture` - The image architecture (`i386` | `x86_64`).

  • ‘block-device-mapping.delete-on-termination` - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • ‘block-device-mapping.device-name` - The device name specified in the block device mapping (for example, `/dev/sdh` or `xvdh`).

  • ‘block-device-mapping.snapshot-id` - The ID of the snapshot used for the EBS volume.

  • ‘block-device-mapping.volume-size` - The volume size of the EBS volume, in GiB.

  • ‘block-device-mapping.volume-type` - The volume type of the EBS volume (`gp2` | `io1` | `st1 `| `sc1` | `standard`).

  • ‘description` - The description of the image (provided during image creation).

  • ‘ena-support` - A Boolean that indicates whether enhanced networking with ENA is enabled.

  • ‘hypervisor` - The hypervisor type (`ovm` | `xen`).

  • ‘image-id` - The ID of the image.

  • ‘image-type` - The image type (`machine` | `kernel` | `ramdisk`).

  • ‘is-public` - A Boolean that indicates whether the image is public.

  • ‘kernel-id` - The kernel ID.

  • ‘manifest-location` - The location of the image manifest.

  • ‘name` - The name of the AMI (provided during image creation).

  • ‘owner-alias` - String 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 AWS account ID of the image owner.

  • ‘platform` - The platform. To only list Windows-based AMIs, use `windows`.

  • ‘product-code` - The product code.

  • ‘product-code.type` - The type of the product code (`devpay` | `marketplace`).

  • ‘ramdisk-id` - The RAM disk ID.

  • ‘root-device-name` - The device name of the root device volume (for example, `/dev/sda1`).

  • ‘root-device-type` - The type of the root device volume (`ebs` | `instance-store`).

  • ‘state` - The state of the image (`available` | `pending` | `failed`).

  • ‘state-reason-code` - The reason code for the state change.

  • ‘state-reason-message` - The message for the state change.

  • ‘sriov-net-support` - A value of `simple` indicates that enhanced networking with the Intel 82599 VF interface is enabled.

  • ‘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.

  • ‘virtualization-type` - The virtualization type (`paravirtual` | `hvm`).

• :image_ids (Array<String>) —

  One or more image IDs.

  Default: Describes all images available to you.

• :owners (Array<String>) —

  Filters the images by the owner. Specify an AWS account ID, ‘self` (owner is the sender of the request), or an AWS owner alias (valid values are `amazon` | `aws-marketplace` | `microsoft`). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

• :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::DescribeImagesResult) —

  Returns a response object which responds to the following methods:

  • #images => Array&lt;Types::Image&gt;

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

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