AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . appstream ]

create-export-image-task

Description

Creates a task to export a WorkSpaces Applications image to an EC2 AMI. This allows you to use your customized WorkSpaces Applications images with other AWS services or for backup purposes.

See also: AWS API Documentation

Synopsis

  create-export-image-task
--image-name <value>
--ami-name <value>
--iam-role-arn <value>
[--tag-specifications <value>]
[--ami-description <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--image-name (string)

The name of the WorkSpaces Applications image to export. The image must be in an available state and owned by your account.

--ami-name (string)

The name for the exported EC2 AMI. This is a required field that must be unique within your account and region.

--iam-role-arn (string)

The ARN of the IAM role that allows WorkSpaces Applications to create the AMI. The role must have permissions to copy images, describe images, and create tags, with a trust relationship allowing appstream.amazonaws.com to assume the role.

--tag-specifications (map)

The tags to apply to the exported AMI. These tags help you organize and manage your EC2 AMIs.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--ami-description (string)

An optional description for the exported AMI. This description will be applied to the resulting EC2 AMI.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

ExportImageTask -> (structure)

Information about the export image task that was created, including the task ID and initial state.

TaskId -> (string)

The unique identifier for the export image task. Use this ID to track the task’s progress and retrieve its details.

ImageArn -> (string)

The ARN of the WorkSpaces Applications image being exported.

AmiName -> (string)

The name of the EC2 AMI that will be created by this export task.

CreatedDate -> (timestamp)

The date and time when the export image task was created.

AmiDescription -> (string)

The description that will be applied to the exported EC2 AMI.

State -> (string)

The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.

AmiId -> (string)

The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.

TagSpecifications -> (map)

The tags that will be applied to the exported EC2 AMI.

key -> (string)

value -> (string)

ErrorDetails -> (list)

Details about any errors that occurred during the export process. This field is only populated when the task fails.

(structure)

The error details.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.