Skip to content

CreateSceneRequest

Source code in docs_src/capo_iottwinmaker/types/create_scene_request.py
class CreateSceneRequest(TypedDict, closed=True):
    workspace_id: "capo_iottwinmaker.types.id.Id"
    """<p>The ID of the workspace that contains the scene.</p>"""
    scene_id: "capo_iottwinmaker.types.id.Id"
    """<p>The ID of the scene.</p>"""
    content_location: "capo_iottwinmaker.types.s3_url.S3Url"
    """<p>The relative path that specifies the location of the content definition file.</p>"""
    description: NotRequired["capo_iottwinmaker.types.description.Description"]
    """<p>The description for this scene.</p>"""
    capabilities: NotRequired[
        "capo_iottwinmaker.types.scene_capabilities.SceneCapabilities"
    ]
    """<p>A list of capabilities that the scene uses to render itself.</p>"""
    tags: NotRequired["capo_iottwinmaker.types.tag_map.TagMap"]
    """<p>Metadata that you can use to manage the scene.</p>"""
    scene_metadata: NotRequired[
        "capo_iottwinmaker.types.scene_metadata_map.SceneMetadataMap"
    ]
    """<p>The request metadata.</p>"""

capabilities instance-attribute

capabilities: NotRequired[SceneCapabilities]

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

content_location instance-attribute

content_location: S3Url

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

description instance-attribute

description: NotRequired[Description]

The description for this scene.

scene_id instance-attribute

scene_id: Id

The ID of the scene.

scene_metadata instance-attribute

scene_metadata: NotRequired[SceneMetadataMap]

The request metadata.

tags instance-attribute

tags: NotRequired[TagMap]

Metadata that you can use to manage the scene.

workspace_id instance-attribute

workspace_id: Id

The ID of the workspace that contains the scene.