GetSceneCommand

Suggest an Edit

Retrieves information about a scene.

Example Syntax

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

import { IoTTwinMakerClient, GetSceneCommand } from "@aws-sdk/client-iottwinmaker"; // ES Modules import
// const { IoTTwinMakerClient, GetSceneCommand } = require("@aws-sdk/client-iottwinmaker"); // CommonJS import
const client = new IoTTwinMakerClient(config);
const input = { // GetSceneRequest
  workspaceId: "STRING_VALUE", // required
  sceneId: "STRING_VALUE", // required
};
const command = new GetSceneCommand(input);
const response = await client.send(command);
// { // GetSceneResponse
//   workspaceId: "STRING_VALUE", // required
//   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",
//   capabilities: [ // SceneCapabilities
//     "STRING_VALUE",
//   ],
//   sceneMetadata: { // SceneMetadataMap
//     "<keys>": "STRING_VALUE",
//   },
//   generatedSceneMetadata: { // GeneratedSceneMetadataMap
//     "<keys>": "STRING_VALUE",
//   },
//   error: { // SceneError
//     code: "STRING_VALUE",
//     message: "STRING_VALUE",
//   },
// };

GetSceneCommand Input

See GetSceneCommandInput for more details

Parameter
Type
Description
sceneId
Required
string | undefined

The ID of the scene.

workspaceId
Required
string | undefined

The ID of the workspace that contains the scene.

GetSceneCommand Output

See GetSceneCommandOutput for details

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

The ARN of the scene.

contentLocation
Required
string | undefined

The relative path that specifies the location of the content definition file.

creationDateTime
Required
Date | undefined

The date and time when the scene was created.

sceneId
Required
string | undefined

The ID of the scene.

updateDateTime
Required
Date | undefined

The date and time when the scene was last updated.

workspaceId
Required
string | undefined

The ID of the workspace that contains the scene.

capabilities
string[] | undefined

A list of capabilities that the scene uses to render.

description
string | undefined

The description of the scene.

error
SceneError | undefined

The SceneResponse error.

generatedSceneMetadata
Record<string, string> | undefined

The generated scene metadata.

sceneMetadata
Record<string, string> | undefined

The response metadata.

Throws

Name
Fault
Details
AccessDeniedException
client

Access is denied.

InternalServerException
server

An unexpected error has occurred.

ResourceNotFoundException
client

The resource wasn't found.

ThrottlingException
client

The rate exceeds the limit.

ValidationException
client

Failed

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