CreateUpdatedImage - Amazon AppStream 2.0

CreateUpdatedImage

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.

Request Syntax

{ "dryRun": boolean, "existingImageName": "string", "newImageDescription": "string", "newImageDisplayName": "string", "newImageName": "string", "newImageTags": { "string" : "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

dryRun

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.

Type: Boolean

Required: No

existingImageName

The name of the image to update.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

newImageDescription

The description to display for the new image.

Type: String

Length Constraints: Maximum length of 256.

Required: No

newImageDisplayName

The name to display for the new image.

Type: String

Length Constraints: Maximum length of 100.

Required: No

newImageName

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

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

newImageTags

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.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(^(?!aws:).[\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No

Response Syntax

{ "canUpdateImage": boolean, "image": { "Applications": [ { "DisplayName": "string", "Enabled": boolean, "IconURL": "string", "LaunchParameters": "string", "LaunchPath": "string", "Metadata": { "string" : "string" }, "Name": "string" } ], "AppstreamAgentVersion": "string", "Arn": "string", "BaseImageArn": "string", "CreatedTime": number, "Description": "string", "DisplayName": "string", "ImageBuilderName": "string", "ImageBuilderSupported": boolean, "ImageErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "ErrorTimestamp": number } ], "ImagePermissions": { "allowFleet": boolean, "allowImageBuilder": boolean }, "Name": "string", "Platform": "string", "PublicBaseImageReleasedDate": number, "State": "string", "StateChangeReason": { "Code": "string", "Message": "string" }, "Visibility": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

canUpdateImage

Indicates whether a new image can be created.

Type: Boolean

image

Describes an image.

Type: Image object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

An API error occurred. Wait a few minutes and try again.

HTTP Status Code: 400

IncompatibleImageException

The image can't be updated because it's not compatible for updates.

HTTP Status Code: 400

InvalidAccountStatusException

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

HTTP Status Code: 400

LimitExceededException

The requested limit exceeds the permitted limit for an account.

HTTP Status Code: 400

OperationNotPermittedException

The attempted operation is not permitted.

HTTP Status Code: 400

ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: