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

Inherits:

Struct

Object
Struct
Aws::EC2::Types::DescribeImagesRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-ec2/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
#executable_users ⇒ Array<String>

Scopes the images by users with explicit launch permissions.
#filters ⇒ Array<Types::Filter>

The filters.
#image_ids ⇒ Array<String>

The image IDs.
#include_deprecated ⇒ Boolean

Specifies whether to include deprecated AMIs.
#include_disabled ⇒ Boolean

Specifies whether to include disabled AMIs.
#max_results ⇒ Integer

The maximum number of items to return for this request.
#next_token ⇒ String

The token returned from a previous paginated request.
#owners ⇒ Array<String>

Scopes the results to images with the specified owners.

Instance Attribute Details

#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:

(Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 19629

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :include_deprecated,
  :include_disabled,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#executable_users ⇒ `Array<String>`

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

If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.
If you specify ‘self` or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.
If you specify ‘all`, all public AMIs are returned.

Returns:

(Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 19629

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :include_deprecated,
  :include_disabled,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ `Array<Types::Filter>`

The filters.

‘architecture` - The image architecture (`i386` | `x86_64` | `arm64` | `x86_64_mac` | `arm64_mac`).
‘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 Amazon EBS volume.
‘block-device-mapping.volume-size` - The volume size of the Amazon EBS volume, in GiB.
‘block-device-mapping.volume-type` - The volume type of the Amazon EBS volume (`io1` | `io2` | `gp2` | `gp3` | `sc1 `| `st1` | `standard`).
‘block-device-mapping.encrypted` - A Boolean that indicates whether the Amazon EBS volume is encrypted.
‘creation-date` - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, `2021-09-29T11:04:43.305Z`. You can use a wildcard (`*`), for example, `2021-09-29T*`, which matches an entire day.
‘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` - The owner alias (`amazon` | `aws-marketplace`). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.
‘owner-id` - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
‘platform` - The platform. The only supported value is `windows`.
‘product-code` - The product code.
‘product-code.type` - The type of the product code (`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`).
‘source-instance-id` - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using [CreateImage].
‘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`:<key> - 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`).

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html

Returns:

(Array<Types::Filter>)

# File 'lib/aws-sdk-ec2/types.rb', line 19629

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :include_deprecated,
  :include_disabled,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#image_ids ⇒ `Array<String>`

The image IDs.

Default: Describes all images available to you.

Returns:

(Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 19629

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :include_deprecated,
  :include_disabled,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#include_deprecated ⇒ `Boolean`

Specifies whether to include deprecated AMIs.

Default: No deprecated AMIs are included in the response.

<note markdown=“1”> If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

</note>

Returns:

(Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 19629

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :include_deprecated,
  :include_disabled,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#include_disabled ⇒ `Boolean`

Specifies whether to include disabled AMIs.

Default: No disabled AMIs are included in the response.

Returns:

(Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 19629

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :include_deprecated,
  :include_disabled,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ `Integer`

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

(Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 19629

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :include_deprecated,
  :include_disabled,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ `String`

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 19629

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :include_deprecated,
  :include_disabled,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#owners ⇒ `Array<String>`

Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, ‘self`, `amazon`, and `aws-marketplace`. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.

Returns:

(Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 19629

class DescribeImagesRequest < Struct.new(
  :executable_users,
  :filters,
  :image_ids,
  :owners,
  :include_deprecated,
  :include_disabled,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ Boolean

#executable_users ⇒ Array<String>

#filters ⇒ Array<Types::Filter>

#image_ids ⇒ Array<String>

#include_deprecated ⇒ Boolean

#include_disabled ⇒ Boolean

#max_results ⇒ Integer

#next_token ⇒ String

#owners ⇒ Array<String>

#dry_run ⇒ `Boolean`

#executable_users ⇒ `Array<String>`

#filters ⇒ `Array<Types::Filter>`

#image_ids ⇒ `Array<String>`

#include_deprecated ⇒ `Boolean`

#include_disabled ⇒ `Boolean`

#max_results ⇒ `Integer`

#next_token ⇒ `String`

#owners ⇒ `Array<String>`