/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeImagesRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeImagesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest
* Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID,
*
* 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
* If you specify
* The filters.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
* The image IDs.
*
* Default: Describes all images available to you.
*
* Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services
* account IDs,
* 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.
*
* 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.
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
* Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID,
*
* 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
* If you specify self (the sender of the request), or all (public AMIs).
*
*
*/
private com.amazonaws.internal.SdkInternalListself 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.
* all, all public AMIs are returned.
*
*
*/
private com.amazonaws.internal.SdkInternalListarchitecture - 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).
* 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).
* self, amazon, and aws-marketplace. If you omit this
* parameter, the results include all images for which you have launch permissions, regardless of ownership.
* self (the sender of the request), or all (public AMIs).
*
*
*
* @return Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID,
* 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.
* all, all public AMIs are returned.
* 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.
*
* 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.
*
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.
*
* 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 * {@link #setExecutableUsers(java.util.Collection)} or {@link #withExecutableUsers(java.util.Collection)} if you * want to override the existing values. *
* * @param 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.
*
* 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.
*
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.
*
* 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).
*
* 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).
*
* 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).
*
* 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).
*
* 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).
*
* 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).
*
* 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).
*
* 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).
*
* 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).
*
* 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 * {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override * the existing values. *
* * @param filters * 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).
*
* 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).
*
* 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).
*
* 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).
*
* 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).
*
* 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).
*
* The image IDs. *
** Default: Describes all images available to you. *
* * @return The image IDs. *
* Default: Describes all images available to you.
*/
public java.util.List
* The image IDs.
*
* Default: Describes all images available to you.
*
* Default: Describes all images available to you.
*/
public void setImageIds(java.util.Collection
* The image IDs.
*
* Default: Describes all images available to you.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setImageIds(java.util.Collection)} or {@link #withImageIds(java.util.Collection)} if you want to override
* the existing values.
*
* Default: Describes all images available to you.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withImageIds(String... imageIds) {
if (this.imageIds == null) {
setImageIds(new com.amazonaws.internal.SdkInternalList
* The image IDs.
*
* Default: Describes all images available to you.
*
* Default: Describes all images available to you.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withImageIds(java.util.Collection
* Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services
* account IDs,
* Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services
* account IDs,
* Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services
* account IDs,
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setOwners(java.util.Collection)} or {@link #withOwners(java.util.Collection)} if you want to override the
* existing values.
*
* Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services
* account IDs,
* 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.
* self, amazon, and aws-marketplace. If you omit this
* parameter, the results include all images for which you have launch permissions, regardless of ownership.
* self, amazon, and aws-marketplace. If you
* omit this parameter, the results include all images for which you have launch permissions, regardless of
* ownership.
*/
public java.util.Listself, amazon, and aws-marketplace. If you omit this
* parameter, the results include all images for which you have launch permissions, regardless of ownership.
* self, amazon, and aws-marketplace. If you
* omit this parameter, the results include all images for which you have launch permissions, regardless of
* ownership.
*/
public void setOwners(java.util.Collectionself, amazon, and aws-marketplace. If you omit this
* parameter, the results include all images for which you have launch permissions, regardless of ownership.
* self, amazon, and aws-marketplace. If you
* omit this parameter, the results include all images for which you have launch permissions, regardless of
* ownership.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withOwners(String... owners) {
if (this.owners == null) {
setOwners(new com.amazonaws.internal.SdkInternalListself, amazon, and aws-marketplace. If you omit this
* parameter, the results include all images for which you have launch permissions, regardless of ownership.
* self, amazon, and aws-marketplace. If you
* omit this parameter, the results include all images for which you have launch permissions, regardless of
* ownership.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withOwners(java.util.Collection
* 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. *
*/ public void setIncludeDeprecated(Boolean includeDeprecated) { this.includeDeprecated = 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. *
** 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. *
*/ public Boolean getIncludeDeprecated() { return this.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. *
** 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. *
* @return Returns a reference to this object so that method calls can be chained together. */ public DescribeImagesRequest withIncludeDeprecated(Boolean includeDeprecated) { setIncludeDeprecated(includeDeprecated); return this; } /** ** 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. *
** 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. *
*/ public Boolean isIncludeDeprecated() { return this.includeDeprecated; } /** ** 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. *
* * @param 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. */ public void setMaxResults(Integer maxResults) { this.maxResults = 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. *
* * @return 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. */ public Integer getMaxResults() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeImagesRequest withMaxResults(Integer maxResults) { setMaxResults(maxResults); return this; } /** ** The token returned from a previous paginated request. Pagination continues from the end of the items returned by * the previous request. *
* * @param nextToken * The token returned from a previous paginated request. Pagination continues from the end of the items * returned by the previous request. */ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** ** The token returned from a previous paginated request. Pagination continues from the end of the items returned by * the previous request. *
* * @return The token returned from a previous paginated request. Pagination continues from the end of the items * returned by the previous request. */ public String getNextToken() { return this.nextToken; } /** ** The token returned from a previous paginated request. Pagination continues from the end of the items returned by * the previous request. *
* * @param nextToken * The token returned from a previous paginated request. Pagination continues from the end of the items * returned by the previous request. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeImagesRequest withNextToken(String nextToken) { setNextToken(nextToken); return this; } /** * This method is intended for internal use only. Returns the marshaled request configured with additional * parameters to enable operation dry-run. */ @Override public Request