ListScenesCommand

Lists all scenes in a workspace.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTTwinMakerClient, ListScenesCommand } from "@aws-sdk/client-iottwinmaker"; // ES Modules import
// const { IoTTwinMakerClient, ListScenesCommand } = require("@aws-sdk/client-iottwinmaker"); // CommonJS import
const client = new IoTTwinMakerClient(config);
const input = { // ListScenesRequest
  workspaceId: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListScenesCommand(input);
const response = await client.send(command);
// { // ListScenesResponse
//   sceneSummaries: [ // SceneSummaries
//     { // SceneSummary
//       sceneId: "STRING_VALUE", // required
//       contentLocation: "STRING_VALUE", // required
//       arn: "STRING_VALUE", // required
//       creationDateTime: new Date("TIMESTAMP"), // required
//       updateDateTime: new Date("TIMESTAMP"), // required
//       description: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListScenesCommand Input

See ListScenesCommandInput for more details

Parameter
Type
Description
workspaceId
Required
string | undefined

The ID of the workspace that contains the scenes.

maxResults
number | undefined

Specifies the maximum number of results to display.

nextToken
string | undefined

The string that specifies the next page of results.

ListScenesCommand Output

See ListScenesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
nextToken
string | undefined

The string that specifies the next page of results.

sceneSummaries
SceneSummary[] | undefined

A list of objects that contain information about the scenes.

Throws

Name
Fault
Details
AccessDeniedException
client

Access is denied.

InternalServerException
server

An unexpected error has occurred.

ThrottlingException
client

The rate exceeds the limit.

ValidationException
client

Failed

IoTTwinMakerServiceException
Base exception class for all service exceptions from IoTTwinMaker service.