DescribeImagesRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.DescribeImagesRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeImagesRequest>, Serializable
```
public class DescribeImagesRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeImagesRequest>
```
Container for the parameters to the DescribeImages operation.
The DescribeImages operation returns information about AMIs, AKIs, and ARIs available to the user. Information returned includes image type, product codes, architecture, and kernel and RAM disk IDs. Images available to the user include public images available for any user to launch, private images owned by the user making the request, and private images owned by other users for which the user has explicit launch permissions.

Launch permissions fall into three categories:
- Public: The owner of the AMI granted launch permissions for the AMI to the all group. All users have launch permissions for these AMIs.
- Explicit: The owner of the AMI granted launch permissions to a specific user.
- Implicit: A user has implicit launch permissions for all AMIs he or she owns.
The list of AMIs returned can be modified by specifying AMI IDs, AMI owners, or users with launch permissions. If no options are specified, Amazon EC2 returns all AMIs for which the user has launch permissions.

If you specify one or more AMI IDs, only AMIs that have the specified IDs are returned. If you specify an invalid AMI ID, a fault is returned. If you specify an AMI ID for which you do not have access, it will not be included in the returned results.

If you specify one or more AMI owners, only AMIs from the specified owners and for which you have access are returned. The results can include the account IDs of the specified owners, amazon for AMIs owned by Amazon or self for AMIs that you own.

If you specify a list of executable users, only users that have launch permissions for the AMIs are returned. You can specify account IDs (if you own the AMI(s)), self for AMIs for which you own or have explicit permissions, or all for public AMIs.

NOTE: Deregistered images are included in the returned results for an unspecified interval after deregistration.
See Also:
AmazonEC2.describeImages(DescribeImagesRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeImagesRequest()

Constructors
Constructor and Description
`DescribeImagesRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Request<DescribeImagesRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`List<String>`	`getExecutableUsers()` An optional list of users whose launch permissions will be used to scope the described AMIs.
`List<Filter>`	`getFilters()` A list of filters used to match properties for Images.
`List<String>`	`getImageIds()` An optional list of the AMI IDs to describe.
`List<String>`	`getOwners()` An optional list of owners by which to scope the described AMIs.
`int`	`hashCode()`
`void`	`setExecutableUsers(Collection<String> executableUsers)` An optional list of users whose launch permissions will be used to scope the described AMIs.
`void`	`setFilters(Collection<Filter> filters)` A list of filters used to match properties for Images.
`void`	`setImageIds(Collection<String> imageIds)` An optional list of the AMI IDs to describe.
`void`	`setOwners(Collection<String> owners)` An optional list of owners by which to scope the described AMIs.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeImagesRequest`	`withExecutableUsers(Collection<String> executableUsers)` An optional list of users whose launch permissions will be used to scope the described AMIs.
`DescribeImagesRequest`	`withExecutableUsers(String... executableUsers)` An optional list of users whose launch permissions will be used to scope the described AMIs.
`DescribeImagesRequest`	`withFilters(Collection<Filter> filters)` A list of filters used to match properties for Images.
`DescribeImagesRequest`	`withFilters(Filter... filters)` A list of filters used to match properties for Images.
`DescribeImagesRequest`	`withImageIds(Collection<String> imageIds)` An optional list of the AMI IDs to describe.
`DescribeImagesRequest`	`withImageIds(String... imageIds)` An optional list of the AMI IDs to describe.
`DescribeImagesRequest`	`withOwners(Collection<String> owners)` An optional list of owners by which to scope the described AMIs.
`DescribeImagesRequest`	`withOwners(String... owners)` An optional list of owners by which to scope the described AMIs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, 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 List<String> getImageIds()
```
    An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.
    
    Returns:
    An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.
  - setImageIds
```
public void setImageIds(Collection<String> imageIds)
```
    An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.
    
    Parameters:
    imageIds - An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.
  - withImageIds
```
public DescribeImagesRequest withImageIds(String... imageIds)
```
    An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    imageIds - An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withImageIds
```
public DescribeImagesRequest withImageIds(Collection<String> imageIds)
```
    An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    imageIds - An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getOwners
```
public List<String> getOwners()
```
    An optional list of owners by which to scope the described AMIs. Valid values are:
    - self : AMIs owned by you
    - AWS account ID : AMIs owned by this account ID
    - aws-marketplace : AMIs owned by the AWS Marketplace
    - amazon : AMIs owned by Amazon
    - all : Do not scope the AMIs returned by owner
    The values self, aws-marketplace, amazon, and all are literals.
    Returns:
    An optional list of owners by which to scope the described AMIs. Valid values are:
    
    self : AMIs owned by you
    
    AWS account ID : AMIs owned by this account ID
    
    aws-marketplace : AMIs owned by the AWS Marketplace
    
    amazon : AMIs owned by Amazon
    
    all : Do not scope the AMIs returned by owner
    
    The values self, aws-marketplace, amazon, and all are literals.
  - setOwners
```
public void setOwners(Collection<String> owners)
```
    An optional list of owners by which to scope the described AMIs. Valid values are:
    - self : AMIs owned by you
    - AWS account ID : AMIs owned by this account ID
    - aws-marketplace : AMIs owned by the AWS Marketplace
    - amazon : AMIs owned by Amazon
    - all : Do not scope the AMIs returned by owner
    The values self, aws-marketplace, amazon, and all are literals.
    Parameters:
    owners - An optional list of owners by which to scope the described AMIs. Valid values are:
    
    self : AMIs owned by you
    
    AWS account ID : AMIs owned by this account ID
    
    aws-marketplace : AMIs owned by the AWS Marketplace
    
    amazon : AMIs owned by Amazon
    
    all : Do not scope the AMIs returned by owner
    
    The values self, aws-marketplace, amazon, and all are literals.
  - withOwners
```
public DescribeImagesRequest withOwners(String... owners)
```
    An optional list of owners by which to scope the described AMIs. Valid values are:
    - self : AMIs owned by you
    - AWS account ID : AMIs owned by this account ID
    - aws-marketplace : AMIs owned by the AWS Marketplace
    - amazon : AMIs owned by Amazon
    - all : Do not scope the AMIs returned by owner
    The values self, aws-marketplace, amazon, and all are literals.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    owners - An optional list of owners by which to scope the described AMIs. Valid values are:
    
    self : AMIs owned by you
    
    AWS account ID : AMIs owned by this account ID
    
    aws-marketplace : AMIs owned by the AWS Marketplace
    
    amazon : AMIs owned by Amazon
    
    all : Do not scope the AMIs returned by owner
    
    The values self, aws-marketplace, amazon, and all are literals.
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withOwners
```
public DescribeImagesRequest withOwners(Collection<String> owners)
```
    An optional list of owners by which to scope the described AMIs. Valid values are:
    - self : AMIs owned by you
    - AWS account ID : AMIs owned by this account ID
    - aws-marketplace : AMIs owned by the AWS Marketplace
    - amazon : AMIs owned by Amazon
    - all : Do not scope the AMIs returned by owner
    The values self, aws-marketplace, amazon, and all are literals.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    owners - An optional list of owners by which to scope the described AMIs. Valid values are:
    
    self : AMIs owned by you
    
    AWS account ID : AMIs owned by this account ID
    
    aws-marketplace : AMIs owned by the AWS Marketplace
    
    amazon : AMIs owned by Amazon
    
    all : Do not scope the AMIs returned by owner
    
    The values self, aws-marketplace, amazon, and all are literals.
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getExecutableUsers
```
public List<String> getExecutableUsers()
```
    An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
    - self : AMIs for which you have explicit launch permissions
    - AWS account ID : AMIs for which this account ID has launch permissions
    - all : AMIs that have public launch permissions
    The values self and all are literals.
    Returns:
    An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
    
    self : AMIs for which you have explicit launch permissions
    
    AWS account ID : AMIs for which this account ID has launch permissions
    
    all : AMIs that have public launch permissions
    
    The values self and all are literals.
  - setExecutableUsers
```
public void setExecutableUsers(Collection<String> executableUsers)
```
    An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
    - self : AMIs for which you have explicit launch permissions
    - AWS account ID : AMIs for which this account ID has launch permissions
    - all : AMIs that have public launch permissions
    The values self and all are literals.
    Parameters:
    executableUsers - An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
    
    self : AMIs for which you have explicit launch permissions
    
    AWS account ID : AMIs for which this account ID has launch permissions
    
    all : AMIs that have public launch permissions
    
    The values self and all are literals.
  - withExecutableUsers
```
public DescribeImagesRequest withExecutableUsers(String... executableUsers)
```
    An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
    - self : AMIs for which you have explicit launch permissions
    - AWS account ID : AMIs for which this account ID has launch permissions
    - all : AMIs that have public launch permissions
    The values self and all are literals.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    executableUsers - An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
    
    self : AMIs for which you have explicit launch permissions
    
    AWS account ID : AMIs for which this account ID has launch permissions
    
    all : AMIs that have public launch permissions
    
    The values self and all are literals.
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withExecutableUsers
```
public DescribeImagesRequest withExecutableUsers(Collection<String> executableUsers)
```
    An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
    - self : AMIs for which you have explicit launch permissions
    - AWS account ID : AMIs for which this account ID has launch permissions
    - all : AMIs that have public launch permissions
    The values self and all are literals.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    executableUsers - An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
    
    self : AMIs for which you have explicit launch permissions
    
    AWS account ID : AMIs for which this account ID has launch permissions
    
    all : AMIs that have public launch permissions
    
    The values self and all are literals.
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getFilters
```
public List<Filter> getFilters()
```
    A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    
    Returns:
    A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
  - setFilters
```
public void setFilters(Collection<Filter> filters)
```
    A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    
    Parameters:
    filters - A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
  - withFilters
```
public DescribeImagesRequest withFilters(Filter... filters)
```
    A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    filters - A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withFilters
```
public DescribeImagesRequest withFilters(Collection<Filter> filters)
```
    A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    filters - A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    
    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 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:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class DescribeImagesRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeImagesRequest

Method Detail

getImageIds

setImageIds

withImageIds

withImageIds

getOwners

setOwners

withOwners

withOwners

getExecutableUsers

setExecutableUsers

withExecutableUsers

withExecutableUsers

getFilters

setFilters

withFilters

withFilters

getDryRunRequest

toString

hashCode

equals