POST /#Action=DescribeImages
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
Servers
- https://ec2.{region}.amazonaws.com
- https://ec2.amazonaws.com
- https://ec2.{region}.amazonaws.com.cn
Request headers
Name | Type | Required | Description |
---|---|---|---|
X-Amz-Content-Sha256 |
String | No | |
X-Amz-Credential |
String | No | |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "text/xml" |
X-Amz-Date |
String | No | |
X-Amz-Algorithm |
String | No | |
X-Amz-SignedHeaders |
String | No | |
X-Amz-Security-Token |
String | No | |
X-Amz-Signature |
String | No |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
Version |
String | Yes |
Possible values:
|
MaxResults |
String | No |
Pagination limit |
NextToken |
String | No |
Pagination token |
Action |
String | Yes |
Possible values:
|
Request body fields
Name | Type | Required | Description |
---|---|---|---|
IncludeDeprecated |
Boolean | No |
Specifies whether to include deprecated AMIs. Default: No deprecated AMIs are included in the response. If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter. |
MaxResults |
Integer | No |
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. |
ExecutableUsers[] |
Array | No |
Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID,
|
Filters[] |
Array | No |
The filters.
|
NextToken |
String | No |
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. |
Owners[] |
Array | No |
Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, |
DryRun |
Boolean | No |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
ImageIds[] |
Array | No |
The image IDs. Default: Describes all images available to you. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.