StreamingImage - Amazon Nimble Studio

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 Elastic Compute Cloud (Amazon EC2) machine image that you create for this purpose. You can also include software that your users require.

Contents

arn

The ARN of the resource.

Type: String

Required: No

description

A human-readable description of the streaming image.

Type: String

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

Required: No

ec2ImageId

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

Type: String

Pattern: ^ami-[0-9A-z]+$

Required: No

encryptionConfiguration

The encryption configuration.

Type: StreamingImageEncryptionConfiguration object

Required: No

eulaIds

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

Type: Array of strings

Required: No

name

A friendly name for a streaming image resource.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: No

owner

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.

Type: String

Required: No

platform

The platform of the streaming image, either WINDOWS or LINUX.

Type: String

Pattern: ^[a-zA-Z]*$

Required: No

state

The current state.

Type: String

Valid Values: CREATE_IN_PROGRESS | READY | DELETE_IN_PROGRESS | DELETED | UPDATE_IN_PROGRESS | UPDATE_FAILED | CREATE_FAILED | DELETE_FAILED

Required: No

statusCode

The status code.

Type: String

Valid Values: STREAMING_IMAGE_CREATE_IN_PROGRESS | STREAMING_IMAGE_READY | STREAMING_IMAGE_DELETE_IN_PROGRESS | STREAMING_IMAGE_DELETED | STREAMING_IMAGE_UPDATE_IN_PROGRESS | INTERNAL_ERROR | ACCESS_DENIED

Required: No

statusMessage

The status message for the streaming image.

Type: String

Required: No

streamingImageId

The ID of the streaming image.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 22.

Pattern: ^[a-zA-Z0-9-_]*$

Required: No

tags

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

Type: String to string map

Required: No

See Also

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