@Generated(value="software.amazon.awssdk:codegen") public class DescribeImagesRequest extends EC2Request implements ToCopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>
Contains the parameters for DescribeImages.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeImagesRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeImagesRequest.Builder |
builder() |
boolean |
equals(Object obj) |
List<String> |
executableUsers()
Scopes the images by users with explicit launch permissions.
|
List<Filter> |
filters()
One or more filters.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
List<String> |
imageIds()
One or more image IDs.
|
List<String> |
owners()
Filters the images by the owner.
|
static Class<? extends DescribeImagesRequest.Builder> |
serializableBuilderClass() |
DescribeImagesRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public List<String> executableUsers()
Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self
(the
sender of the request), or all
(public AMIs).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
self
(the sender of the request), or all
(public AMIs).public List<Filter> filters()
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
: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
).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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
: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
).
public List<String> imageIds()
One or more image IDs.
Default: Describes all images available to you.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Default: Describes all images available to you.
public List<String> owners()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.public DescribeImagesRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>
toBuilder
in class EC2Request
public static DescribeImagesRequest.Builder builder()
public static Class<? extends DescribeImagesRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.