Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface StreamingImage

Represents a streaming image resource.

Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.

Amazon provides a number of streaming images that include popular 3rd-party software.

You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.


  • StreamingImage


arn?: string

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

description?: string

A human-readable description of the streaming image.

ec2ImageId?: string

The ID of an EC2 machine image with which to create the streaming image.

encryptionConfiguration?: StreamingImageEncryptionConfiguration

The encryption configuration.

eulaIds?: string[]

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

name?: string

A friendly name for a streaming image resource.

owner?: string

The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.

platform?: string

The platform of the streaming image, either Windows or Linux.

state?: string

The current state.

statusCode?: string

The status code.

statusMessage?: string

The status message for the streaming image.

streamingImageId?: string

The ID of the streaming image.

tags?: Record<string, string>

A collection of labels, in the form of key-value pairs, that apply to this resource.