UpdateStreamingImage
Update streaming image.
Important
This API is only available to customers who created a Nimble Studio cloud studio before June 19th, 2023. This API won't be accessible after June 19th, 2024.
Request Syntax
PATCH /2020-08-01/studios/studioId
/streaming-images/streamingImageId
HTTP/1.1
X-Amz-Client-Token: clientToken
Content-type: application/json
{
"description": "string
",
"name": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- clientToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
Length Constraints: Minimum length of 1. Maximum length of 64.
- streamingImageId
-
The streaming image ID.
Required: Yes
- studioId
-
The studio ID.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- description
-
The description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- name
-
The name for the streaming image.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"streamingImage": {
"arn": "string",
"description": "string",
"ec2ImageId": "string",
"encryptionConfiguration": {
"keyArn": "string",
"keyType": "string"
},
"eulaIds": [ "string" ],
"name": "string",
"owner": "string",
"platform": "string",
"state": "string",
"statusCode": "string",
"statusMessage": "string",
"streamingImageId": "string",
"tags": {
"string" : "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.
- 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.
Type: StreamingImage object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
HTTP Status Code: 403
- ConflictException
-
Another operation is in progress.
HTTP Status Code: 409
- InternalServerErrorException
-
An internal error has occurred. Please retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource could not be found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.
Please use AWS Service Quotas to request an increase.
HTTP Status Code: 402
- ThrottlingException
-
The request throughput limit was exceeded.
HTTP Status Code: 429
- ValidationException
-
One of the parameters in the request is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: