com.amazonaws.services.ec2.model
Class DescribeImagesRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.ec2.model.DescribeImagesRequest

public class DescribeImagesRequest
extends AmazonWebServiceRequest

A request to describe the available Amazon Machine Images (AMIs).


Constructor Summary
DescribeImagesRequest()
           
 
Method Summary
 List<String> getExecutableUsers()
          The optional list of users with explicit launch permissions for the described AMIs.
 List<String> getImageIds()
          An optional list of the AMI IDs to describe.
 List<String> getOwners()
          The optional list of owners for the described AMIs.
 void setExecutableUsers(Collection<String> executableUsers)
          The optional list of users with explicit launch permissions for the described AMIs.
 void setImageIds(Collection<String> imageIds)
          An optional list of the AMI IDs to describe.
 void setOwners(Collection<String> owners)
          The optional list of owners for the described AMIs.
 String toString()
           
 DescribeImagesRequest withExecutableUsers(Collection<String> executableUsers)
          The optional list of users with explicit launch permissions for the described AMIs.
 DescribeImagesRequest withExecutableUsers(String... executableUsers)
          The optional list of users with explicit launch permissions for the described AMIs.
 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)
          The optional list of owners for the described AMIs.
 DescribeImagesRequest withOwners(String... owners)
          The optional list of owners for the described AMIs.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, 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()
The optional list of owners for the described AMIs. The IDs amazon, self, and explicit can be used to include AMIs owned by Amazon, AMIs owned by the user, and AMIs for which the user has explicit launch permissions, respectively.

Returns:
The optional list of owners for the described AMIs. The IDs amazon, self, and explicit can be used to include AMIs owned by Amazon, AMIs owned by the user, and AMIs for which the user has explicit launch permissions, respectively.

setOwners

public void setOwners(Collection<String> owners)
The optional list of owners for the described AMIs. The IDs amazon, self, and explicit can be used to include AMIs owned by Amazon, AMIs owned by the user, and AMIs for which the user has explicit launch permissions, respectively.

Parameters:
owners - The optional list of owners for the described AMIs. The IDs amazon, self, and explicit can be used to include AMIs owned by Amazon, AMIs owned by the user, and AMIs for which the user has explicit launch permissions, respectively.

withOwners

public DescribeImagesRequest withOwners(String... owners)
The optional list of owners for the described AMIs. The IDs amazon, self, and explicit can be used to include AMIs owned by Amazon, AMIs owned by the user, and AMIs for which the user has explicit launch permissions, respectively.

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

Parameters:
owners - The optional list of owners for the described AMIs. The IDs amazon, self, and explicit can be used to include AMIs owned by Amazon, AMIs owned by the user, and AMIs for which the user has explicit launch permissions, respectively.
Returns:
A reference to this updated object so that method calls can be chained together.

withOwners

public DescribeImagesRequest withOwners(Collection<String> owners)
The optional list of owners for the described AMIs. The IDs amazon, self, and explicit can be used to include AMIs owned by Amazon, AMIs owned by the user, and AMIs for which the user has explicit launch permissions, respectively.

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

Parameters:
owners - The optional list of owners for the described AMIs. The IDs amazon, self, and explicit can be used to include AMIs owned by Amazon, AMIs owned by the user, and AMIs for which the user has explicit launch permissions, respectively.
Returns:
A reference to this updated object so that method calls can be chained together.

getExecutableUsers

public List<String> getExecutableUsers()
The optional list of users with explicit launch permissions for the described AMIs. The user ID can be a user's account ID, 'self' to return AMIs for which the sender of the request has explicit launch permissions, or 'all' to return AMIs with public launch permissions.

Returns:
The optional list of users with explicit launch permissions for the described AMIs. The user ID can be a user's account ID, 'self' to return AMIs for which the sender of the request has explicit launch permissions, or 'all' to return AMIs with public launch permissions.

setExecutableUsers

public void setExecutableUsers(Collection<String> executableUsers)
The optional list of users with explicit launch permissions for the described AMIs. The user ID can be a user's account ID, 'self' to return AMIs for which the sender of the request has explicit launch permissions, or 'all' to return AMIs with public launch permissions.

Parameters:
executableUsers - The optional list of users with explicit launch permissions for the described AMIs. The user ID can be a user's account ID, 'self' to return AMIs for which the sender of the request has explicit launch permissions, or 'all' to return AMIs with public launch permissions.

withExecutableUsers

public DescribeImagesRequest withExecutableUsers(String... executableUsers)
The optional list of users with explicit launch permissions for the described AMIs. The user ID can be a user's account ID, 'self' to return AMIs for which the sender of the request has explicit launch permissions, or 'all' to return AMIs with public launch permissions.

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

Parameters:
executableUsers - The optional list of users with explicit launch permissions for the described AMIs. The user ID can be a user's account ID, 'self' to return AMIs for which the sender of the request has explicit launch permissions, or 'all' to return AMIs with public launch permissions.
Returns:
A reference to this updated object so that method calls can be chained together.

withExecutableUsers

public DescribeImagesRequest withExecutableUsers(Collection<String> executableUsers)
The optional list of users with explicit launch permissions for the described AMIs. The user ID can be a user's account ID, 'self' to return AMIs for which the sender of the request has explicit launch permissions, or 'all' to return AMIs with public launch permissions.

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

Parameters:
executableUsers - The optional list of users with explicit launch permissions for the described AMIs. The user ID can be a user's account ID, 'self' to return AMIs for which the sender of the request has explicit launch permissions, or 'all' to return AMIs with public launch permissions.
Returns:
A reference to this updated object so that method calls can be chained together.

toString

public String toString()
Overrides:
toString in class Object


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