AWS IoT TwinMaker

2023/05/03 - AWS IoT TwinMaker - 1 updated api methods

Changes  This release adds a field for GetScene API to return error code and message from dependency services.

GetScene (updated) Link ΒΆ
Changes (response)
{'error': {'code': 'MATTERPORT_ERROR', 'message': 'string'}}

Retrieves information about a scene.

See also: AWS API Documentation

Request Syntax

client.get_scene(
    workspaceId='string',
    sceneId='string'
)
type workspaceId

string

param workspaceId

[REQUIRED]

The ID of the workspace that contains the scene.

type sceneId

string

param sceneId

[REQUIRED]

The ID of the scene.

rtype

dict

returns

Response Syntax

{
    'workspaceId': 'string',
    'sceneId': 'string',
    'contentLocation': 'string',
    'arn': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'updateDateTime': datetime(2015, 1, 1),
    'description': 'string',
    'capabilities': [
        'string',
    ],
    'sceneMetadata': {
        'string': 'string'
    },
    'generatedSceneMetadata': {
        'string': 'string'
    },
    'error': {
        'code': 'MATTERPORT_ERROR',
        'message': 'string'
    }
}

Response Structure

  • (dict) --

    • workspaceId (string) --

      The ID of the workspace that contains the scene.

    • sceneId (string) --

      The ID of the scene.

    • contentLocation (string) --

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

    • arn (string) --

      The ARN of the scene.

    • creationDateTime (datetime) --

      The date and time when the scene was created.

    • updateDateTime (datetime) --

      The date and time when the scene was last updated.

    • description (string) --

      The description of the scene.

    • capabilities (list) --

      A list of capabilities that the scene uses to render.

      • (string) --

    • sceneMetadata (dict) --

      The response metadata.

      • (string) --

        • (string) --

    • generatedSceneMetadata (dict) --

      The generated scene metadata.

      • (string) --

        • (string) --

    • error (dict) --

      The SceneResponse error.

      • code (string) --

        The SceneError code.

      • message (string) --

        The SceneError message.