IoTSiteWise / Client / create_dashboard

create_dashboard

IoTSiteWise.Client.create_dashboard(**kwargs)

Warning

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Creates a dashboard in an IoT SiteWise Monitor project.

See also: AWS API Documentation

Request Syntax

response = client.create_dashboard(
    projectId='string',
    dashboardName='string',
    dashboardDescription='string',
    dashboardDefinition='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • projectId (string) –

    [REQUIRED]

    The ID of the project in which to create the dashboard.

  • dashboardName (string) –

    [REQUIRED]

    A friendly name for the dashboard.

  • dashboardDescription (string) – A description for the dashboard.

  • dashboardDefinition (string) –

    [REQUIRED]

    The dashboard definition specified in a JSON literal.

    in the IoT SiteWise User Guide

  • clientToken (string) –

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

  • tags (dict) –

    A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'dashboardId': 'string',
    'dashboardArn': 'string'
}

Response Structure

  • (dict) –

    • dashboardId (string) –

      The ID of the dashboard.

    • dashboardArn (string) –

      The ARN of the dashboard, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

Exceptions