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

Class: Aws::EC2::Types::DescribeImagesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeImagesRequest data as a hash:

{
  executable_users: ["String"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  image_ids: ["String"],
  owners: ["String"],
  dry_run: false,
}

Contains the parameters for DescribeImages.

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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:

  • (Boolean)


6956
6957
6958
6959
6960
6961
6962
6963
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6956

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :dry_run)
  include Aws::Structure
end

#executable_usersArray<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).

Returns:

  • (Array<String>)


6956
6957
6958
6959
6960
6961
6962
6963
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6956

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :dry_run)
  include Aws::Structure
end

#filtersArray<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 for the EBS volume (for example, /dev/sdh).

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

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

Returns:



6956
6957
6958
6959
6960
6961
6962
6963
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6956

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :dry_run)
  include Aws::Structure
end

#image_idsArray<String>

One or more image IDs.

Default: Describes all images available to you.

Returns:

  • (Array<String>)


6956
6957
6958
6959
6960
6961
6962
6963
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6956

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :dry_run)
  include Aws::Structure
end

#ownersArray<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.

Returns:

  • (Array<String>)


6956
6957
6958
6959
6960
6961
6962
6963
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6956

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :dry_run)
  include Aws::Structure
end