Skip to content

Describe Store Image Tasks

ec2_describe_store_image_tasks R Documentation

Describes the progress of the AMI store 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 EC2 User Guide.

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

Usage

ec2_describe_store_image_tasks(ImageIds, DryRun, Filters, NextToken,
  MaxResults)

Arguments

ImageIds

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

DryRun

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

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.

When you specify the ImageIds parameter, any filters that you specify are ignored. To use the filters, you must remove the ImageIds parameter.

NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

MaxResults

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.

You cannot specify this parameter and the ImageIds parameter in the same call.

Value

A list with the following syntax: 

list(
  StoreImageTaskResults = list(
    list(
      AmiId = "string",
      TaskStartTime = as.POSIXct(
        "2015-01-01"
      ),
      Bucket = "string",
      S3objectKey = "string",
      ProgressPercentage = 123,
      StoreTaskState = "string",
      StoreTaskFailureReason = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_store_image_tasks(
  ImageIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)