ListScenes
Lists all scenes in a workspace.
Request Syntax
POST /workspaces/workspaceId
/scenes-list HTTP/1.1
Content-type: application/json
{
"maxResults": number
,
"nextToken": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- workspaceId
-
The ID of the workspace that contains the scenes.
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.
- maxResults
-
Specifies the maximum number of results to display.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 200.
Required: No
- nextToken
-
The string that specifies the next page of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 17880.
Pattern:
.*
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"sceneSummaries": [
{
"arn": "string",
"contentLocation": "string",
"creationDateTime": number,
"description": "string",
"sceneId": "string",
"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.
- nextToken
-
The string that specifies the next page of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 17880.
Pattern:
.*
- sceneSummaries
-
A list of objects that contain information about the scenes.
Type: Array of SceneSummary objects
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
- 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 Amazon SDKs, see the following: