Menu
Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

Image

New streaming instances are booted from images. The image stores the application catalog and is connected to fleets.

Contents

Applications

The applications associated with an image.

Type: array of Application objects

Required: No

Arn

The ARN for the image.

Type: String

Pattern: ^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Required: No

BaseImageArn

The source image ARN from which this image was created.

Type: String

Pattern: ^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Required: No

CreatedTime

The timestamp when the image was created.

Type: Timestamp

Required: No

Description

A meaningful description for the image.

Type: String

Length Constraints: Minimum length of 1.

Required: No

DisplayName

The display name for the image.

Type: String

Length Constraints: Minimum length of 1.

Required: No

ImageBuilderSupported

Whether an image builder can be launched from this image.

Type: Boolean

Required: No

Name

The unique identifier for the image.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Platform

The operating system platform of the image.

Type: String

Valid Values: WINDOWS

Required: No

State

The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.

Type: String

Valid Values: PENDING | AVAILABLE | FAILED | DELETING

Required: No

StateChangeReason

The reason why the last state change occurred.

Type: ImageStateChangeReason object

Required: No

Visibility

The visibility of an image to the user; images can be public or private.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No

See Also

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

On this page: