IoTTwinMaker / Client / get_scene

get_scene#

IoTTwinMaker.Client.get_scene(**kwargs)#

Retrieves information about a scene.

See also: AWS API Documentation

Request Syntax

response = client.get_scene(
    workspaceId='string',
    sceneId='string'
)
Parameters:

  • workspaceId (string) –

    [REQUIRED]

    The ID of the workspace that contains the scene.

  • sceneId (string) –

    [REQUIRED]

    The ID of the scene.

Return type:

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.

Exceptions