IoTTwinMaker / Client / list_scenes

list_scenes#

IoTTwinMaker.Client.list_scenes(**kwargs)#

Lists all scenes in a workspace.

See also: AWS API Documentation

Request Syntax

response = client.list_scenes(
    workspaceId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • workspaceId (string) –

    [REQUIRED]

    The ID of the workspace that contains the scenes.

  • maxResults (integer) – Specifies the maximum number of results to display.

  • nextToken (string) – The string that specifies the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'sceneSummaries': [
        {
            'sceneId': 'string',
            'contentLocation': 'string',
            'arn': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'updateDateTime': datetime(2015, 1, 1),
            'description': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • sceneSummaries (list) –

      A list of objects that contain information about the scenes.

      • (dict) –

        An object that contains information about a 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 scene description.

    • nextToken (string) –

      The string that specifies the next page of results.

Exceptions