Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ec2 ]

describe-export-image-tasks

Description

Describes the specified export image tasks or all your export image tasks.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-export-image-tasks
[--dry-run | --no-dry-run]
[--filters <value>]
[--export-image-task-ids <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--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)

Filter tasks using the task-state filter and one of the following values: active , completed , deleting , or deleted .

Shorthand Syntax:

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

JSON Syntax:

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

--export-image-task-ids (list)

The IDs of the export image tasks.

Syntax:

"string" "string" ...

--max-results (integer)

The maximum number of results to return in a single call.

--next-token (string)

A token that indicates the next page of results.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 monitor an export image task

The following describe-export-image-tasks example checks the status of the specified export image task.

aws ec2 describe-export-image-tasks \
    --export-image-task-id export-ami-1234567890abcdef0

Output for an export image task that is in progress:

{
    "ExportImageTasks": [
        {
            "ExportImageTaskId": "export-ami-1234567890abcdef0"
            "Progress": "21",
            "S3ExportLocation": {
                "S3Bucket": "my-export-bucket",
                "S3Prefix": "exports/"
            },
            "Status": "active",
            "StatusMessage": "updating"
        }
    ]
}

Output for an export image task that is completed. The resulting image file in Amazon S3 is my-export-bucket/exports/export-ami-1234567890abcdef0.vmdk.

{
    "ExportImageTasks": [
        {
            "ExportImageTaskId": "export-ami-1234567890abcdef0"
            "S3ExportLocation": {
                "S3Bucket": "my-export-bucket",
                "S3Prefix": "exports/"
            },
            "Status": "completed"
        }
    ]
}

Output

ExportImageTasks -> (list)

Information about the export image tasks.

(structure)

Describes an export image task.

Description -> (string)

A description of the image being exported.

ExportImageTaskId -> (string)

The ID of the export image task.

ImageId -> (string)

The ID of the image.

Progress -> (string)

The percent complete of the export image task.

S3ExportLocation -> (structure)

Information about the destination S3 bucket.

S3Bucket -> (string)

The destination S3 bucket.

S3Prefix -> (string)

The prefix (logical hierarchy) in the bucket.

Status -> (string)

The status of the export image task. The possible values are active , completed , deleting , and deleted .

StatusMessage -> (string)

The status message for the export image task.

NextToken -> (string)

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