[ aws . ec2 ]

describe-export-tasks

Description

Describes the specified export instance tasks or all of your export instance tasks.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-export-tasks
[--export-task-ids <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--export-task-ids (list)

The export task IDs.

(string)

Syntax:

"string" "string" ...

--filters (list)

the filters for the export tasks.

(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. The filters supported by a describe operation are documented with the describe operation. For example:

• DescribeAvailabilityZones

• DescribeImages

• DescribeInstances

• DescribeKeyPairs

• DescribeSecurityGroups

• DescribeSnapshots

• DescribeSubnets

• DescribeTags

• DescribeVolumes

• DescribeVpcs

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.

--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 list details about an instance export task

This example describes the export task with ID export-i-fh8sjjsq.

Command:

aws ec2 describe-export-tasks --export-task-ids export-i-fh8sjjsq

Output:

{
    "ExportTasks": [
        {
            "State": "active",
            "InstanceExportDetails": {
                "InstanceId": "i-1234567890abcdef0",
                "TargetEnvironment": "vmware"
            },
            "ExportToS3Task": {
                "S3Bucket": "myexportbucket",
                "S3Key": "RHEL5export-i-fh8sjjsq.ova",
                "DiskImageFormat": "vmdk",
                "ContainerFormat": "ova"
            },
            "Description": "RHEL5 instance",
            "ExportTaskId": "export-i-fh8sjjsq"
        }
    ]
}

Output

ExportTasks -> (list)

Information about the export tasks.

(structure)

Describes an instance export task.

Description -> (string)

A description of the resource being exported.

ExportTaskId -> (string)

The ID of the export task.

ExportToS3Task -> (structure)

Information about the export task.

ContainerFormat -> (string)

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

DiskImageFormat -> (string)

The format for the exported image.

S3Bucket -> (string)

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com .

S3Key -> (string)

The encryption key for your S3 bucket.

InstanceExportDetails -> (structure)

Information about the instance to export.

InstanceId -> (string)

The ID of the resource being exported.

TargetEnvironment -> (string)

The target virtualization environment.

State -> (string)

The state of the export task.

StatusMessage -> (string)

The status message related to the export task.

Tags -> (list)

The tags for the export task.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.