Table Of Contents

Feedback

User Guide

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

[ aws . ec2 ]

describe-import-image-tasks

Description

Displays details about an import virtual machine or import snapshot tasks that are already created.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-import-image-tasks is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ImportImageTasks

Synopsis

  describe-import-image-tasks
[--dry-run | --no-dry-run]
[--filters <value>]
[--import-task-ids <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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", ...]
  }
  ...
]

--import-task-ids (list)

The IDs of the import image tasks.

Syntax:

"string" "string" ...

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

--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. 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 import image task

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

aws ec2 describe-import-image-tasks \
    --import-task-ids import-ami-1234567890abcdef0

Output for an import image task that is in progress.

{
    "ImportImageTasks": [
        {
            "ImportTaskId": "import-ami-1234567890abcdef0",
            "Progress": "28",
            "SnapshotDetails": [
                {
                    "DiskImageSize": 705638400.0,
                    "Format": "ova",
                    "Status": "completed",
                    "UserBucket": {
                        "S3Bucket": "my-import-bucket",
                        "S3Key": "vms/my-server-vm.ova"
                    }
                }
            ],
            "Status": "active",
            "StatusMessage": "converting"
        }
    ]
}

Output for an import image task that is completed. The ID of the resulting AMI is provided by ImageId.

{
    "ImportImageTasks": [
        {
            "ImportTaskId": "import-ami-1234567890abcdef0",
            "ImageId": "ami-1234567890abcdef0",
            "SnapshotDetails": [
                {
                    "DiskImageSize": 705638400.0,
                    "Format": "ova",
                    "SnapshotId": "snap-1234567890abcdef0"
                    "Status": "completed",
                    "UserBucket": {
                        "S3Bucket": "my-import-bucket",
                        "S3Key": "vms/my-server-vm.ova"
                    }
                }
            ],
            "Status": "completed"
        }
    ]
}

Output

ImportImageTasks -> (list)

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

(structure)

Describes an import image task.

Architecture -> (string)

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

Description -> (string)

A description of the import task.

Encrypted -> (boolean)

Indicates whether the image is encrypted.

Hypervisor -> (string)

The target hypervisor for the import task.

Valid values: xen

ImageId -> (string)

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

ImportTaskId -> (string)

The ID of the import image task.

KmsKeyId -> (string)

The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted image.

LicenseType -> (string)

The license type of the virtual machine.

Platform -> (string)

The description string for the import image task.

Progress -> (string)

The percentage of progress of the import image task.

SnapshotDetails -> (list)

Information about the snapshots.

(structure)

Describes the snapshot created from the imported disk.

Description -> (string)

A description for the snapshot.

DeviceName -> (string)

The block device mapping for the snapshot.

DiskImageSize -> (double)

The size of the disk in the snapshot, in GiB.

Format -> (string)

The format of the disk image from which the snapshot is created.

Progress -> (string)

The percentage of progress for the task.

SnapshotId -> (string)

The snapshot ID of the disk being imported.

Status -> (string)

A brief status of the snapshot creation.

StatusMessage -> (string)

A detailed status message for the snapshot creation.

Url -> (string)

The URL used to access the disk image.

UserBucket -> (structure)

The S3 bucket for the disk image.

S3Bucket -> (string)

The S3 bucket from which the disk image was created.

S3Key -> (string)

The file name of the disk image.

Status -> (string)

A brief status for the import image task.

StatusMessage -> (string)

A descriptive status message for the import image task.

LicenseSpecifications -> (list)

The ARNs of the license configurations associated to the import image task.

(structure)

The response information of license configurations.

LicenseConfigurationArn -> (string)

The ARN of a license configuration.

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.