Class DescribeImagesRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.ec2.model.DescribeImagesRequest
All Implemented Interfaces:
ReadLimitInfo, DryRunSupportedRequest<DescribeImagesRequest>, Serializable, Cloneable

public class DescribeImagesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeImagesRequest>

Contains the parameters for DescribeImages.

See Also:
  • Constructor Details

    • DescribeImagesRequest

      public DescribeImagesRequest()
  • Method Details

    • getImageIds

      public List<String> getImageIds()

      One or more image IDs.

      Default: Describes all images available to you.

      Returns:
      One or more image IDs.

      Default: Describes all images available to you.

    • setImageIds

      public void setImageIds(Collection<String> imageIds)

      One or more image IDs.

      Default: Describes all images available to you.

      Parameters:
      imageIds - One or more image IDs.

      Default: Describes all images available to you.

    • withImageIds

      public DescribeImagesRequest withImageIds(String... imageIds)

      One or more image IDs.

      Default: Describes all images available to you.

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

      Parameters:
      imageIds - One or more image IDs.

      Default: Describes all images available to you.

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

      public DescribeImagesRequest withImageIds(Collection<String> imageIds)

      One or more image IDs.

      Default: Describes all images available to you.

      Parameters:
      imageIds - One or more image IDs.

      Default: Describes all images available to you.

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

      public List<String> getOwners()

      Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

      Returns:
      Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.
    • setOwners

      public void setOwners(Collection<String> owners)

      Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

      Parameters:
      owners - Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.
    • withOwners

      public DescribeImagesRequest withOwners(String... owners)

      Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

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

      Parameters:
      owners - Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withOwners

      public DescribeImagesRequest withOwners(Collection<String> owners)

      Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

      Parameters:
      owners - Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getExecutableUsers

      public List<String> getExecutableUsers()

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

      Returns:
      Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
    • setExecutableUsers

      public void setExecutableUsers(Collection<String> executableUsers)

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

      Parameters:
      executableUsers - Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
    • withExecutableUsers

      public DescribeImagesRequest withExecutableUsers(String... executableUsers)

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

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

      Parameters:
      executableUsers - Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withExecutableUsers

      public DescribeImagesRequest withExecutableUsers(Collection<String> executableUsers)

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

      Parameters:
      executableUsers - Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getFilters

      public List<Filter> getFilters()

      One or more filters.

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

      • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

      • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

      • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

      • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

      • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

      • description - The description of the image (provided during image creation).

      • 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 AWS account alias (for example, amazon).

      • owner-id - The AWS account ID of the image owner.

      • platform - The platform. To only list Windows-based AMIs, use windows.

      • product-code - The product code.

      • product-code.type - The type of the product code ( devpay | marketplace).

      • ramdisk-id - The RAM disk ID.

      • root-device-name - The 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.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • virtualization-type - The virtualization type ( paravirtual | hvm).

      Returns:
      One or more filters.

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

      • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

      • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

      • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

      • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

      • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

      • description - The description of the image (provided during image creation).

      • 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 AWS account alias (for example, amazon).

      • owner-id - The AWS account ID of the image owner.

      • platform - The platform. To only list Windows-based AMIs, use windows.

      • product-code - The product code.

      • product-code.type - The type of the product code ( devpay | marketplace).

      • ramdisk-id - The RAM disk ID.

      • root-device-name - The 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.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • virtualization-type - The virtualization type ( paravirtual | hvm).

    • setFilters

      public void setFilters(Collection<Filter> filters)

      One or more filters.

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

      • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

      • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

      • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

      • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

      • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

      • description - The description of the image (provided during image creation).

      • 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 AWS account alias (for example, amazon).

      • owner-id - The AWS account ID of the image owner.

      • platform - The platform. To only list Windows-based AMIs, use windows.

      • product-code - The product code.

      • product-code.type - The type of the product code ( devpay | marketplace).

      • ramdisk-id - The RAM disk ID.

      • root-device-name - The 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.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • virtualization-type - The virtualization type ( paravirtual | hvm).

      Parameters:
      filters - One or more filters.

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

      • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

      • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

      • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

      • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

      • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

      • description - The description of the image (provided during image creation).

      • 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 AWS account alias (for example, amazon).

      • owner-id - The AWS account ID of the image owner.

      • platform - The platform. To only list Windows-based AMIs, use windows.

      • product-code - The product code.

      • product-code.type - The type of the product code ( devpay | marketplace).

      • ramdisk-id - The RAM disk ID.

      • root-device-name - The 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.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • virtualization-type - The virtualization type ( paravirtual | hvm).

    • withFilters

      public DescribeImagesRequest withFilters(Filter... filters)

      One or more filters.

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

      • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

      • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

      • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

      • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

      • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

      • description - The description of the image (provided during image creation).

      • 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 AWS account alias (for example, amazon).

      • owner-id - The AWS account ID of the image owner.

      • platform - The platform. To only list Windows-based AMIs, use windows.

      • product-code - The product code.

      • product-code.type - The type of the product code ( devpay | marketplace).

      • ramdisk-id - The RAM disk ID.

      • root-device-name - The 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.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • virtualization-type - The virtualization type ( paravirtual | hvm).

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

      Parameters:
      filters - One or more filters.

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

      • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

      • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

      • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

      • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

      • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

      • description - The description of the image (provided during image creation).

      • 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 AWS account alias (for example, amazon).

      • owner-id - The AWS account ID of the image owner.

      • platform - The platform. To only list Windows-based AMIs, use windows.

      • product-code - The product code.

      • product-code.type - The type of the product code ( devpay | marketplace).

      • ramdisk-id - The RAM disk ID.

      • root-device-name - The 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.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • virtualization-type - The virtualization type ( paravirtual | hvm).

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

      public DescribeImagesRequest withFilters(Collection<Filter> filters)

      One or more filters.

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

      • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

      • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

      • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

      • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

      • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

      • description - The description of the image (provided during image creation).

      • 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 AWS account alias (for example, amazon).

      • owner-id - The AWS account ID of the image owner.

      • platform - The platform. To only list Windows-based AMIs, use windows.

      • product-code - The product code.

      • product-code.type - The type of the product code ( devpay | marketplace).

      • ramdisk-id - The RAM disk ID.

      • root-device-name - The 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.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • virtualization-type - The virtualization type ( paravirtual | hvm).

      Parameters:
      filters - One or more filters.

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

      • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

      • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

      • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

      • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

      • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

      • description - The description of the image (provided during image creation).

      • 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 AWS account alias (for example, amazon).

      • owner-id - The AWS account ID of the image owner.

      • platform - The platform. To only list Windows-based AMIs, use windows.

      • product-code - The product code.

      • product-code.type - The type of the product code ( devpay | marketplace).

      • ramdisk-id - The RAM disk ID.

      • root-device-name - The 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.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • virtualization-type - The virtualization type ( paravirtual | hvm).

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

      public Request<DescribeImagesRequest> getDryRunRequest()
      This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.
      Specified by:
      getDryRunRequest in interface DryRunSupportedRequest<DescribeImagesRequest>
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public DescribeImagesRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: