com.amazonaws.services.ec2.model.DescribeImagesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2016-2021 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,
* self (the sender of the request), or all (public AMIs).
*
*/
private com.amazonaws.internal.SdkInternalList executableUsers;
/**
*
* 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.
*
*
* -
*
* 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. To only list Windows-based AMIs, use 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).
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The image IDs.
*
*
* Default: Describes all images available to you.
*
*/
private com.amazonaws.internal.SdkInternalList imageIds;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList owners;
/**
*
* If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs
* are included in the response. If no value is specified, the default value is false.
*
*
*
* If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true
* or false) that you set for this parameter.
*
*
*/
private Boolean includeDeprecated;
/**
*
* 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).
*
*
* @return 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).
*/
public java.util.List getExecutableUsers() {
if (executableUsers == null) {
executableUsers = new com.amazonaws.internal.SdkInternalList();
}
return 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).
*
*
* @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).
*/
public void setExecutableUsers(java.util.Collection executableUsers) {
if (executableUsers == null) {
this.executableUsers = null;
return;
}
this.executableUsers = new com.amazonaws.internal.SdkInternalList(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).
*
*
* 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).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withExecutableUsers(String... executableUsers) {
if (this.executableUsers == null) {
setExecutableUsers(new com.amazonaws.internal.SdkInternalList(executableUsers.length));
}
for (String ele : executableUsers) {
this.executableUsers.add(ele);
}
return this;
}
/**
*
* 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).
*
*
* @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).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withExecutableUsers(java.util.Collection executableUsers) {
setExecutableUsers(executableUsers);
return this;
}
/**
*
* 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.
*
*
* -
*
* 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. To only list Windows-based AMIs, use 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).
*
*
*
*
* @return 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.
*
*
* -
*
* 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. To only list Windows-based AMIs, use 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).
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* -
*
* 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. To only list Windows-based AMIs, use 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).
*
*
*
*
* @param 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.
*
*
* -
*
* 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. To only list Windows-based AMIs, use 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).
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(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.
*
*
* -
*
* 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. To only list Windows-based AMIs, use 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).
*
*
* -
*
* 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.
*
*
* -
*
* 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. To only list Windows-based AMIs, use 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).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* -
*
* 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. To only list Windows-based AMIs, use 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).
*
*
*
*
* @param 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.
*
*
* -
*
* 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. To only list Windows-based AMIs, use 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).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* 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 getImageIds() {
if (imageIds == null) {
imageIds = new com.amazonaws.internal.SdkInternalList();
}
return imageIds;
}
/**
*
* The image IDs.
*
*
* Default: Describes all images available to you.
*
*
* @param imageIds
* The image IDs.
*
* Default: Describes all images available to you.
*/
public void setImageIds(java.util.Collection imageIds) {
if (imageIds == null) {
this.imageIds = null;
return;
}
this.imageIds = new com.amazonaws.internal.SdkInternalList(imageIds);
}
/**
*
* 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.
*
*
* @param imageIds
* The image IDs.
*
* 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(imageIds.length));
}
for (String ele : imageIds) {
this.imageIds.add(ele);
}
return this;
}
/**
*
* The image IDs.
*
*
* Default: Describes all images available to you.
*
*
* @param imageIds
* The image IDs.
*
* 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 imageIds) {
setImageIds(imageIds);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getOwners() {
if (owners == null) {
owners = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setOwners(java.util.Collection owners) {
if (owners == null) {
this.owners = null;
return;
}
this.owners = new com.amazonaws.internal.SdkInternalList(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
* {@link #setOwners(java.util.Collection)} or {@link #withOwners(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param 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.
* @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.SdkInternalList(owners.length));
}
for (String ele : owners) {
this.owners.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withOwners(java.util.Collection owners) {
setOwners(owners);
return this;
}
/**
*
* If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs
* are included in the response. If no value is specified, the default value is false.
*
*
*
* If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true
* or false) that you set for this parameter.
*
*
*
* @param includeDeprecated
* If true, all deprecated AMIs are included in the response. If false, no
* deprecated AMIs are included in the response. If no value is specified, the default value is
* false.
*
* If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (
* true or false) that you set for this parameter.
*
*/
public void setIncludeDeprecated(Boolean includeDeprecated) {
this.includeDeprecated = includeDeprecated;
}
/**
*
* If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs
* are included in the response. If no value is specified, the default value is false.
*
*
*
* If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true
* or false) that you set for this parameter.
*
*
*
* @return If true, all deprecated AMIs are included in the response. If false, no
* deprecated AMIs are included in the response. If no value is specified, the default value is
* false.
*
* If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (
* true or false) that you set for this parameter.
*
*/
public Boolean getIncludeDeprecated() {
return this.includeDeprecated;
}
/**
*
* If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs
* are included in the response. If no value is specified, the default value is false.
*
*
*
* If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true
* or false) that you set for this parameter.
*
*
*
* @param includeDeprecated
* If true, all deprecated AMIs are included in the response. If false, no
* deprecated AMIs are included in the response. If no value is specified, the default value is
* false.
*
* If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (
* true or false) that you set 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;
}
/**
*
* If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs
* are included in the response. If no value is specified, the default value is false.
*
*
*
* If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true
* or false) that you set for this parameter.
*
*
*
* @return If true, all deprecated AMIs are included in the response. If false, no
* deprecated AMIs are included in the response. If no value is specified, the default value is
* false.
*
* If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (
* true or false) that you set for this parameter.
*
*/
public Boolean isIncludeDeprecated() {
return this.includeDeprecated;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new DescribeImagesRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getExecutableUsers() != null)
sb.append("ExecutableUsers: ").append(getExecutableUsers()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getImageIds() != null)
sb.append("ImageIds: ").append(getImageIds()).append(",");
if (getOwners() != null)
sb.append("Owners: ").append(getOwners()).append(",");
if (getIncludeDeprecated() != null)
sb.append("IncludeDeprecated: ").append(getIncludeDeprecated());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeImagesRequest == false)
return false;
DescribeImagesRequest other = (DescribeImagesRequest) obj;
if (other.getExecutableUsers() == null ^ this.getExecutableUsers() == null)
return false;
if (other.getExecutableUsers() != null && other.getExecutableUsers().equals(this.getExecutableUsers()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getImageIds() == null ^ this.getImageIds() == null)
return false;
if (other.getImageIds() != null && other.getImageIds().equals(this.getImageIds()) == false)
return false;
if (other.getOwners() == null ^ this.getOwners() == null)
return false;
if (other.getOwners() != null && other.getOwners().equals(this.getOwners()) == false)
return false;
if (other.getIncludeDeprecated() == null ^ this.getIncludeDeprecated() == null)
return false;
if (other.getIncludeDeprecated() != null && other.getIncludeDeprecated().equals(this.getIncludeDeprecated()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getExecutableUsers() == null) ? 0 : getExecutableUsers().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getImageIds() == null) ? 0 : getImageIds().hashCode());
hashCode = prime * hashCode + ((getOwners() == null) ? 0 : getOwners().hashCode());
hashCode = prime * hashCode + ((getIncludeDeprecated() == null) ? 0 : getIncludeDeprecated().hashCode());
return hashCode;
}
@Override
public DescribeImagesRequest clone() {
return (DescribeImagesRequest) super.clone();
}
}