AWS CLI Command Reference

[ aws . appstream ]

create-updated-image

Description

Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.

For more information, see the “Update an Image by Using Managed AppStream 2.0 Image Updates” section in Administer Your AppStream 2.0 Images , in the Amazon AppStream 2.0 Administration Guide .

See also: AWS API Documentation

Synopsis

  create-updated-image
--existing-image-name <value>
--new-image-name <value>
[--new-image-description <value>]
[--new-image-display-name <value>]
[--new-image-tags <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--existing-image-name (string)

The name of the image to update.

--new-image-name (string)

The name of the new image. The name must be unique within the AWS account and Region.

--new-image-description (string)

The description to display for the new image.

--new-image-display-name (string)

The name to display for the new image.

--new-image-tags (map)

The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide .

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--dry-run | --no-dry-run (boolean)

Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to true , AppStream 2.0 displays whether image updates are available. If this value is set to false , AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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.

--output (string)

The formatting style for command output.

  • json

  • text

  • table

  • yaml

  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64

  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

image -> (structure)

Describes an image.

Name -> (string)

The name of the image.

Arn -> (string)

The ARN of the image.

BaseImageArn -> (string)

The ARN of the image from which this image was created.

DisplayName -> (string)

The image name to display.

State -> (string)

The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .

Visibility -> (string)

Indicates whether the image is public or private.

ImageBuilderSupported -> (boolean)

Indicates whether an image builder can be launched from this image.

ImageBuilderName -> (string)

The name of the image builder that was used to create the private image. If the image is shared, this value is null.

Platform -> (string)

The operating system platform of the image.

Description -> (string)

The description to display.

StateChangeReason -> (structure)

The reason why the last state change occurred.

Code -> (string)

The state change reason code.

Message -> (string)

The state change reason message.

Applications -> (list)

The applications associated with the image.

(structure)

Describes an application in the application catalog.

Name -> (string)

The name of the application.

DisplayName -> (string)

The application name to display.

IconURL -> (string)

The URL for the application icon. This URL might be time-limited.

LaunchPath -> (string)

The path to the application executable in the instance.

LaunchParameters -> (string)

The arguments that are passed to the application at launch.

Enabled -> (boolean)

If there is a problem, the application can be disabled after image creation.

Metadata -> (map)

Additional attributes that describe the application.

key -> (string)

value -> (string)

WorkingDirectory -> (string)

The working directory for the application.

Description -> (string)

The description of the application.

Arn -> (string)

The ARN of the application.

AppBlockArn -> (string)

The app block ARN of the application.

IconS3Location -> (structure)

The S3 location of the application icon.

S3Bucket -> (string)

The S3 bucket of the S3 object.

S3Key -> (string)

The S3 key of the S3 object.

Platforms -> (list)

The platforms on which the application can run.

(string)

InstanceFamilies -> (list)

The instance families for the application.

(string)

CreatedTime -> (timestamp)

The time at which the application was created within the app block.

CreatedTime -> (timestamp)

The time the image was created.

PublicBaseImageReleasedDate -> (timestamp)

The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.

AppstreamAgentVersion -> (string)

The version of the AppStream 2.0 agent to use for instances that are launched from this image.

ImagePermissions -> (structure)

The permissions to provide to the destination AWS account for the specified image.

allowFleet -> (boolean)

Indicates whether the image can be used for a fleet.

allowImageBuilder -> (boolean)

Indicates whether the image can be used for an image builder.

ImageErrors -> (list)

Describes the errors that are returned when a new image can’t be created.

(structure)

Describes a resource error.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.

ErrorTimestamp -> (timestamp)

The time the error occurred.

canUpdateImage -> (boolean)

Indicates whether a new image can be created.

© Copyright 2018, Amazon Web Services. Created using Sphinx.