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.
Deregistered images are included in the returned results for an unspecified interval after deregistration.
Access
public
Parameters
Parameter |
Type |
Required |
Description |
---|---|---|---|
|
Optional |
An associative array of parameters that can have the following keys:
|
Returns
Type |
Description |
---|---|
A |
Examples
Describe all accessible images.
$ec2 = new AmazonEC2(); $response = $ec2->describe_images(); var_dump($response->isOK());Result:
bool(true)
Describe all images owned by Amazon.
$ec2 = new AmazonEC2(); $response = $ec2->describe_images(array( 'Owner' => 'amazon' )); var_dump($response->isOK());Result:
bool(true)
Describe all images that your account can execute.
$ec2 = new AmazonEC2(); $response = $ec2->describe_images(array( 'ExecutableBy' => 'self' )); var_dump($response->isOK());Result:
bool(true)
Filter accessible images.
$ec2 = new AmazonEC2(); $response = $ec2->describe_images(array( 'Filter' => array( array('Name' => 'architecture', 'Value' => 'x86_64' ), array('Name' => 'image-type', 'Value' => 'machine' ), array('Name' => 'root-device-type', 'Value' => 'ebs' ), array('Name' => 'virtualization-type', 'Value' => 'paravirtual'), ) )); var_dump($response->isOK());Result:
bool(true)
Related Methods
Source
Method defined in services/ec2.class.php | Toggle source view (42 lines) | View on GitHub