com.amazonaws.services.ec2.model
Class DescribeImagesRequest

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

public class DescribeImagesRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<DescribeImagesRequest>

Container for the parameters to the DescribeImages operation.

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

NOTE: Deregistered images are included in the returned results for an unspecified interval after deregistration.

See Also:
AmazonEC2.describeImages(DescribeImagesRequest), Serialized Form

Constructor Summary
DescribeImagesRequest()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 Request<DescribeImagesRequest> getDryRunRequest()
          This method is intended for internal use only.
 java.util.List<java.lang.String> getExecutableUsers()
          Scopes the images by users with explicit launch permissions.
 java.util.List<Filter> getFilters()
          One or more filters.
 java.util.List<java.lang.String> getImageIds()
          One or more image IDs.
 java.util.List<java.lang.String> getOwners()
          Filters the images by the owner.
 int hashCode()
           
 void setExecutableUsers(java.util.Collection<java.lang.String> executableUsers)
          Scopes the images by users with explicit launch permissions.
 void setFilters(java.util.Collection<Filter> filters)
          One or more filters.
 void setImageIds(java.util.Collection<java.lang.String> imageIds)
          One or more image IDs.
 void setOwners(java.util.Collection<java.lang.String> owners)
          Filters the images by the owner.
 java.lang.String toString()
          Returns a string representation of this object; useful for testing and debugging.
 DescribeImagesRequest withExecutableUsers(java.util.Collection<java.lang.String> executableUsers)
          Scopes the images by users with explicit launch permissions.
 DescribeImagesRequest withExecutableUsers(java.lang.String... executableUsers)
          Scopes the images by users with explicit launch permissions.
 DescribeImagesRequest withFilters(java.util.Collection<Filter> filters)
          One or more filters.
 DescribeImagesRequest withFilters(Filter... filters)
          One or more filters.
 DescribeImagesRequest withImageIds(java.util.Collection<java.lang.String> imageIds)
          One or more image IDs.
 DescribeImagesRequest withImageIds(java.lang.String... imageIds)
          One or more image IDs.
 DescribeImagesRequest withOwners(java.util.Collection<java.lang.String> owners)
          Filters the images by the owner.
 DescribeImagesRequest withOwners(java.lang.String... owners)
          Filters the images by the owner.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DescribeImagesRequest

public DescribeImagesRequest()
Method Detail

getImageIds

public java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.String... imageIds)
One or more image IDs.

Default: Describes all images available to you.

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

Parameters:
imageIds - One or more image IDs.

Default: Describes all images available to you.

Returns:
A reference to this updated object so that method calls can be chained together.

withImageIds

public DescribeImagesRequest withImageIds(java.util.Collection<java.lang.String> imageIds)
One or more image IDs.

Default: Describes all images available to you.

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

Parameters:
imageIds - One or more image IDs.

Default: Describes all images available to you.

Returns:
A reference to this updated object so that method calls can be chained together.

getOwners

public java.util.List<java.lang.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), or all (all owners).

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), or all (all owners).

setOwners

public void setOwners(java.util.Collection<java.lang.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), or all (all owners).

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), or all (all owners).

withOwners

public DescribeImagesRequest withOwners(java.lang.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), or all (all owners).

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

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), or all (all owners).
Returns:
A reference to this updated object so that method calls can be chained together.

withOwners

public DescribeImagesRequest withOwners(java.util.Collection<java.lang.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), or all (all owners).

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

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), or all (all owners).
Returns:
A reference to this updated object so that method calls can be chained together.

getExecutableUsers

public java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.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).

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

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:
A reference to this updated object so that method calls can be chained together.

withExecutableUsers

public DescribeImagesRequest withExecutableUsers(java.util.Collection<java.lang.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).

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

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:
A reference to this updated object so that method calls can be chained together.

getFilters

public java.util.List<Filter> getFilters()
One or more filters.

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 Amazon EBS volume (for example, /dev/sdh).

  • 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 (gp2 | standard | io1).

  • 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(java.util.Collection<Filter> filters)
One or more filters.

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 Amazon EBS volume (for example, /dev/sdh).

  • 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 (gp2 | standard | io1).

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

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

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 Amazon EBS volume (for example, /dev/sdh).

  • 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 (gp2 | standard | io1).

  • 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:
A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeImagesRequest withFilters(java.util.Collection<Filter> filters)
One or more filters.

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

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 Amazon EBS volume (for example, /dev/sdh).

  • 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 (gp2 | standard | io1).

  • 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:
A reference to this updated 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 java.lang.String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.