Skip to content

Describe Bundle Tasks

ec2_describe_bundle_tasks R Documentation

Describes the specified bundle tasks or all of your bundle tasks

Description

Describes the specified bundle tasks or all of your bundle tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use register_image with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

Usage

ec2_describe_bundle_tasks(BundleIds, Filters, DryRun)

Arguments

BundleIds

The bundle task IDs.

Default: Describes all your bundle tasks.

Filters

The filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | ⁠waiting-for-shutdown⁠ | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

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.

Value

A list with the following syntax: 

list(
  BundleTasks = list(
    list(
      BundleId = "string",
      BundleTaskError = list(
        Code = "string",
        Message = "string"
      ),
      InstanceId = "string",
      Progress = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      State = "pending"|"waiting-for-shutdown"|"bundling"|"storing"|"cancelling"|"complete"|"failed",
      Storage = list(
        S3 = list(
          AWSAccessKeyId = "string",
          Bucket = "string",
          Prefix = "string",
          UploadPolicy = raw,
          UploadPolicySignature = "string"
        )
      ),
      UpdateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$describe_bundle_tasks(
  BundleIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE
)