com.amazonaws.services.ec2.model

Class DescribeImagesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeImagesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeImagesRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeImagesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeImagesRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeImagesRequest()

Method Summary

Modifier and Type	Method and Description
DescribeImagesRequest	clone()
boolean	equals(Object obj)
Request<DescribeImagesRequest>	getDryRunRequest() This method is intended for internal use only.
List<String>	getExecutableUsers() Scopes the images by users with explicit launch permissions.
List<Filter>	getFilters() The filters.
List<String>	getImageIds() The image IDs.
Boolean	getIncludeDeprecated() Specifies whether to include deprecated AMIs.
Integer	getMaxResults() The maximum number of items to return for this request.
String	getNextToken() The token returned from a previous paginated request.
List<String>	getOwners() Scopes the results to images with the specified owners.
int	hashCode()
Boolean	isIncludeDeprecated() Specifies whether to include deprecated AMIs.
void	setExecutableUsers(Collection<String> executableUsers) Scopes the images by users with explicit launch permissions.
void	setFilters(Collection<Filter> filters) The filters.
void	setImageIds(Collection<String> imageIds) The image IDs.
void	setIncludeDeprecated(Boolean includeDeprecated) Specifies whether to include deprecated AMIs.
void	setMaxResults(Integer maxResults) The maximum number of items to return for this request.
void	setNextToken(String nextToken) The token returned from a previous paginated request.
void	setOwners(Collection<String> owners) Scopes the results to images with the specified owners.
String	toString() Returns a string representation of this object.
DescribeImagesRequest	withExecutableUsers(Collection<String> executableUsers) Scopes the images by users with explicit launch permissions.
DescribeImagesRequest	withExecutableUsers(String... executableUsers) Scopes the images by users with explicit launch permissions.
DescribeImagesRequest	withFilters(Collection<Filter> filters) The filters.
DescribeImagesRequest	withFilters(Filter... filters) The filters.
DescribeImagesRequest	withImageIds(Collection<String> imageIds) The image IDs.
DescribeImagesRequest	withImageIds(String... imageIds) The image IDs.
DescribeImagesRequest	withIncludeDeprecated(Boolean includeDeprecated) Specifies whether to include deprecated AMIs.
DescribeImagesRequest	withMaxResults(Integer maxResults) The maximum number of items to return for this request.
DescribeImagesRequest	withNextToken(String nextToken) The token returned from a previous paginated request.
DescribeImagesRequest	withOwners(Collection<String> owners) Scopes the results to images with the specified owners.
DescribeImagesRequest	withOwners(String... owners) Scopes the results to images with the specified owners.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeImagesRequest

public DescribeImagesRequest()

Method Detail

getExecutableUsers

public List<String> getExecutableUsers()

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:

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.

setExecutableUsers

public void setExecutableUsers(Collection<String> executableUsers)

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.

Parameters:

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

withExecutableUsers

public DescribeImagesRequest withExecutableUsers(String... executableUsers)

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.

NOTE: This method appends the values to the existing list (if any). Use setExecutableUsers(java.util.Collection) or withExecutableUsers(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

withExecutableUsers

public DescribeImagesRequest withExecutableUsers(Collection<String> executableUsers)

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.

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

The filters.

• architecture - The image architecture (i386 | x86_64 | arm64 ).

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

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

Returns:

The filters.

• architecture - The image architecture (i386 | x86_64 | arm64).

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

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

setFilters

public void setFilters(Collection<Filter> filters)

The filters.

• architecture - The image architecture (i386 | x86_64 | arm64 ).

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

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

Parameters:

filters - The filters.

• architecture - The image architecture (i386 | x86_64 | arm64).

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

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

withFilters

public DescribeImagesRequest withFilters(Filter... filters)

The filters.

• architecture - The image architecture (i386 | x86_64 | arm64 ).

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

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

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - The filters.

• architecture - The image architecture (i386 | x86_64 | arm64).

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withFilters

public DescribeImagesRequest withFilters(Collection<Filter> filters)

The filters.

• architecture - The image architecture (i386 | x86_64 | arm64 ).

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

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

Parameters:

filters - The filters.

• architecture - The image architecture (i386 | x86_64 | arm64).

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getImageIds

public List<String> getImageIds()

The image IDs.

Default: Describes all images available to you.

Returns:

The image IDs.

Default: Describes all images available to you.

setImageIds

public void setImageIds(Collection<String> imageIds)

The image IDs.

Default: Describes all images available to you.

Parameters:

imageIds - The image IDs.

Default: Describes all images available to you.

withImageIds

public DescribeImagesRequest withImageIds(String... imageIds)

The image IDs.

Default: Describes all images available to you.

NOTE: This method appends the values to the existing list (if any). Use setImageIds(java.util.Collection) or withImageIds(java.util.Collection) if you want to override the existing values.

Parameters:

imageIds - The image IDs.

Default: Describes all images available to you.

Returns:

Returns a reference to this object so that method calls can be chained together.

withImageIds

public DescribeImagesRequest withImageIds(Collection<String> imageIds)

The image IDs.

Default: Describes all images available to you.

Parameters:

imageIds - The image IDs.

Default: Describes all images available to you.

Returns:

Returns a reference to this object so that method calls can be chained together.

getOwners

public List<String> getOwners()

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:

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.

setOwners

public void setOwners(Collection<String> owners)

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.

Parameters:

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

withOwners

public DescribeImagesRequest withOwners(String... owners)

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.

NOTE: This method appends the values to the existing list (if any). Use setOwners(java.util.Collection) or withOwners(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

withOwners

public DescribeImagesRequest withOwners(Collection<String> owners)

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.

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

setIncludeDeprecated

public void setIncludeDeprecated(Boolean includeDeprecated)

Specifies whether to include deprecated AMIs.

Default: No deprecated AMIs are included in the response.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

Parameters:

includeDeprecated - Specifies whether to include deprecated AMIs.

Default: No deprecated AMIs are included in the response.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

getIncludeDeprecated

public Boolean getIncludeDeprecated()

Specifies whether to include deprecated AMIs.

Default: No deprecated AMIs are included in the response.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

Returns:

Specifies whether to include deprecated AMIs.

Default: No deprecated AMIs are included in the response.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

withIncludeDeprecated

public DescribeImagesRequest withIncludeDeprecated(Boolean includeDeprecated)

Specifies whether to include deprecated AMIs.

Default: No deprecated AMIs are included in the response.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

Parameters:

includeDeprecated - Specifies whether to include deprecated AMIs.

Default: No deprecated AMIs are included in the response.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

isIncludeDeprecated

public Boolean isIncludeDeprecated()

Specifies whether to include deprecated AMIs.

Default: No deprecated AMIs are included in the response.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

Returns:

Specifies whether to include deprecated AMIs.

Default: No deprecated AMIs are included in the response.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

setMaxResults

public void setMaxResults(Integer maxResults)

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.

Parameters:

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

getMaxResults

public Integer getMaxResults()

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.

Returns:

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.

withMaxResults

public DescribeImagesRequest withMaxResults(Integer maxResults)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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

Returns:

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

withNextToken

public DescribeImagesRequest withNextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeImagesRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeImagesRequest>

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeImagesRequest clone()

Overrides:

clone in class AmazonWebServiceRequest