UpdateScene
Updates a scene.
Request Syntax
PUT /workspaces/workspaceId/scenes/sceneId HTTP/1.1
Content-type: application/json
{
"capabilities": [ "string" ],
"contentLocation": "string",
"description": "string",
"sceneMetadata": {
"string" : "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- sceneId
-
The ID of the scene.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+Required: Yes
- workspaceId
-
The ID of the workspace that contains the scene.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- capabilities
-
A list of capabilities that the scene uses to render.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
.*Required: No
- contentLocation
-
The relative path that specifies the location of the content definition file.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[sS]3://[A-Za-z0-9._/-]+Required: No
- description
-
The description of this scene.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
.*Required: No
- sceneMetadata
-
The scene metadata.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Key Pattern:
[a-zA-Z_\-0-9]+Value Length Constraints: Minimum length of 0. Maximum length of 2048.
Value Pattern:
.*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"updateDateTime": number
}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.
- updateDateTime
-
The date and time when the scene was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access is denied.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error has occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource wasn't found.
HTTP Status Code: 404
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 429
- ValidationException
-
Failed
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
