describe-store-image-tasks¶

Description¶

Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don’t specify the AMIs, you get a paginated list of store tasks from the last 31 days.

For each AMI task, the response indicates if the task is InProgress , Completed , or Failed . For tasks InProgress , the response shows the estimated progress as a percentage.

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide .

For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide .

Synopsis¶

  describe-store-image-tasks
[--image-ids <value>]
[--dry-run | --no-dry-run]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--image-ids (list)

The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.

(string)

Syntax:

"string" "string" ...

--dry-run | --no-dry-run (boolean)

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 DryRunOperation . Otherwise, it is UnauthorizedOperation .

--filters (list)

The filters.

task-state - Returns tasks in a certain state (InProgress | Completed | Failed )

bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To view the progress of an AMI store task

The following describe-store-image-tasks example describes the specified AMI store task.

aws ec2 describe-store-image-tasks

Output:

{
    "AmiId": "ami-1234567890abcdef0",
    "Bucket": "myamibucket",
    "ProgressPercentage": 17,
    "S3objectKey": "ami-1234567890abcdef0.bin",
    "StoreTaskState": "InProgress",
    "StoreTaskFailureReason": null,
    "TaskStartTime": "2021-01-01T01:01:01.001Z"
}

For more information, see Store and restore an AMI in the Amazon EC2 User Guide.

Output¶

StoreImageTaskResults -> (list)

The information about the AMI store tasks.

(structure)

The information about the AMI store task, including the progress of the task.

AmiId -> (string)

The ID of the AMI that is being stored.

TaskStartTime -> (timestamp)

The time the task started.

Bucket -> (string)

The name of the Amazon S3 bucket that contains the stored AMI object.

S3objectKey -> (string)

The name of the stored AMI object in the bucket.

ProgressPercentage -> (integer)

The progress of the task as a percentage.

StoreTaskState -> (string)

The state of the store task (InProgress , Completed , or Failed ).

StoreTaskFailureReason -> (string)

If the tasks fails, the reason for the failure is returned. If the task succeeds, null is returned.

NextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Table of Contents

Feedback

User Guide