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.

URI

/2020-08-01/studios/studioId/streaming-images/streamingImageId

HTTP methods

GET

Operation ID: GetStreamingImage

Get streaming image.

Path parameters
Name Type Required Description
streamingImageId String True

The streaming image ID.

studioId String True

The studio ID.

Responses
Status code Response model Description
200 GetStreamingImageOutput

Success

400 ValidationException

One of the parameters in the request is invalid.

402 ServiceQuotaExceededException

This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to request an increase.

403 AccessDeniedException

You do not have permission to perform this action.

404 ResourceNotFoundException

A requested resource was not found.

409 ConflictException

This request conflicts with another concurrent request. Please retry your request.

429 ThrottlingException

The request was denied due to request throttling. Please retry your request.

500 InternalServerException

A service fault has occurred. Please retry your request and contact AWS Support if this error continues.

DELETE

Operation ID: DeleteStreamingImage

Delete streaming image.

Path parameters
Name Type Required Description
streamingImageId String True

The streaming image ID.

studioId String True

The studio ID.

Header parameters
Name Type Required Description
X-Amz-Client-Token String False

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

Responses
Status code Response model Description
200 DeleteStreamingImageOutput

Success

400 ValidationException

One of the parameters in the request is invalid.

402 ServiceQuotaExceededException

This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to request an increase.

403 AccessDeniedException

You do not have permission to perform this action.

404 ResourceNotFoundException

A requested resource was not found.

409 ConflictException

This request conflicts with another concurrent request. Please retry your request.

429 ThrottlingException

The request was denied due to request throttling. Please retry your request.

500 InternalServerException

A service fault has occurred. Please retry your request and contact AWS Support if this error continues.

PATCH

Operation ID: UpdateStreamingImage

Update streaming image.

Path parameters
Name Type Required Description
streamingImageId String True

The streaming image ID.

studioId String True

The studio ID.

Header parameters
Name Type Required Description
X-Amz-Client-Token String False

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

Responses
Status code Response model Description
200 UpdateStreamingImageOutput

Success

400 ValidationException

One of the parameters in the request is invalid.

402 ServiceQuotaExceededException

This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to request an increase.

403 AccessDeniedException

You do not have permission to perform this action.

404 ResourceNotFoundException

A requested resource was not found.

409 ConflictException

This request conflicts with another concurrent request. Please retry your request.

429 ThrottlingException

The request was denied due to request throttling. Please retry your request.

500 InternalServerException

A service fault has occurred. Please retry your request and contact AWS Support if this error continues.

Schemas

Request bodies

{ "name": "string", "description": "string" }
{ "name": "string", "description": "string" }

Response bodies

{ "streamingImage": { "streamingImageId": "string", "ec2ImageId": "string", "description": "string", "name": "string", "owner": "string", "encryptionConfiguration": { "keyArn": "string", "keyType": enum }, "eulaIds": [ "string" ], "state": enum, "statusCode": enum, "statusMessage": "string", "arn": "string", "platform": "string", "tags": { } } }
{ "streamingImage": { "streamingImageId": "string", "ec2ImageId": "string", "description": "string", "name": "string", "owner": "string", "encryptionConfiguration": { "keyArn": "string", "keyType": enum }, "eulaIds": [ "string" ], "state": enum, "statusCode": enum, "statusMessage": "string", "arn": "string", "platform": "string", "tags": { } } }
{ "streamingImage": { "streamingImageId": "string", "ec2ImageId": "string", "description": "string", "name": "string", "owner": "string", "encryptionConfiguration": { "keyArn": "string", "keyType": enum }, "eulaIds": [ "string" ], "state": enum, "statusCode": enum, "statusMessage": "string", "arn": "string", "platform": "string", "tags": { } } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }

Properties

AccessDeniedException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ConflictException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

DeleteStreamingImageOutput

Property Type Required Description
streamingImage

StreamingImage

False

The streaming image.

ExceptionContext

ExceptionContext is a set of key-value pairs that provide you with more information about the error that occurred. For example, when the service returns a 404 ResourceNotFound error, ExceptionContext will contain the key `resourceId` with the value of resource that was not found.

ExceptionContext enables scripts and other programmatic clients to provide for better error handling.

Property Type Required Description

*

string

False

GetStreamingImageOutput

Property Type Required Description
streamingImage

StreamingImage

False

The streaming image.

InternalServerException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ResourceNotFoundException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ServiceQuotaExceededException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

StreamingImage

Property Type Required Description
streamingImageId

string

False

The ID of the streaming image.

ec2ImageId

string

False

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

description

string

False

A human-readable description of the streaming image.

name

string

False

A friendly name for a streaming image resource.

owner

string

False

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.

encryptionConfiguration

StreamingImageEncryptionConfiguration

False

The encryption configuration.

eulaIds

Array of type string

False

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

state

StreamingImageState

False

The current state.

statusCode

StreamingImageStatusCode

False

The status code.

statusMessage

string

False

The status message for the streaming image.

arn

string

False

The ARN of the resource.

platform

string

False

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

tags

Tags

False

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

StreamingImageEncryptionConfiguration

Property Type Required Description
keyArn

string

False

The ARN for a KMS key that is used to encrypt studio data.

keyType

StreamingImageEncryptionConfigurationKeyType

True

The type of KMS key that is used to encrypt studio data.

StreamingImageEncryptionConfigurationKeyType

  • CUSTOMER_MANAGED_KEY

StreamingImageState

  • CREATE_IN_PROGRESS

  • READY

  • DELETE_IN_PROGRESS

  • DELETED

  • UPDATE_IN_PROGRESS

  • UPDATE_FAILED

  • CREATE_FAILED

  • DELETE_FAILED

StreamingImageStatusCode

The status code.

  • STREAMING_IMAGE_CREATE_IN_PROGRESS

  • STREAMING_IMAGE_READY

  • STREAMING_IMAGE_DELETE_IN_PROGRESS

  • STREAMING_IMAGE_DELETED

  • STREAMING_IMAGE_UPDATE_IN_PROGRESS

  • INTERNAL_ERROR

Tags

Property Type Required Description

*

string

False

ThrottlingException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

UpdateStreamingImageInput

Property Type Required Description
name

string

False

The name for the streaming image.

description

string

False

The description.

UpdateStreamingImageOutput

Property Type Required Description
streamingImage

StreamingImage

False

ValidationException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

See also

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

GetStreamingImage

DeleteStreamingImage

UpdateStreamingImage