AWS IoT TwinMaker

2023/03/22 - AWS IoT TwinMaker - 3 updated api methods

Changes  This release adds support of adding metadata when creating a new scene or updating an existing scene.

CreateScene (updated) Link ¶
Changes (request) 
{'sceneMetadata': {'string': 'string'}}

Creates a scene.

See also: AWS API Documentation

Request Syntax

client.create_scene(
    workspaceId='string',
    sceneId='string',
    contentLocation='string',
    description='string',
    capabilities=[
        'string',
    ],
    tags={
        'string': 'string'
    },
    sceneMetadata={
        'string': '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.

type contentLocation:

string

param contentLocation:

[REQUIRED]

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

type description:

string

param description:

The description for this scene.

type capabilities:

list

param capabilities:

A list of capabilities that the scene uses to render itself.

  • (string) --

type tags:

dict

param tags:

Metadata that you can use to manage the scene.

  • (string) --

    • (string) --

type sceneMetadata:

dict

param sceneMetadata:

The request metadata.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'creationDateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • arn (string) --

      The ARN of the scene.

    • creationDateTime (datetime) --

      The date and time when the scene was created.

GetScene (updated) Link ¶
Changes (response) 
{'generatedSceneMetadata': {'string': 'string'},
 'sceneMetadata': {'string': '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'
    }
}

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) --

UpdateScene (updated) Link ¶
Changes (request) 
{'sceneMetadata': {'string': 'string'}}

Updates a scene.

See also: AWS API Documentation

Request Syntax

client.update_scene(
    workspaceId='string',
    sceneId='string',
    contentLocation='string',
    description='string',
    capabilities=[
        'string',
    ],
    sceneMetadata={
        'string': '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.

type contentLocation:

string

param contentLocation:

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

type description:

string

param description:

The description of this scene.

type capabilities:

list

param capabilities:

A list of capabilities that the scene uses to render.

  • (string) --

type sceneMetadata:

dict

param sceneMetadata:

The scene metadata.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'updateDateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • updateDateTime (datetime) --

      The date and time when the scene was last updated.