IoTSiteWise / Client / list_dashboards

list_dashboards#

IoTSiteWise.Client.list_dashboards(**kwargs)#

Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.

See also: AWS API Documentation

Request Syntax

response = client.list_dashboards(
    projectId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • projectId (string) –

    [REQUIRED]

    The ID of the project.

  • nextToken (string) – The token to be used for the next set of paginated results.

  • maxResults (integer) –

    The maximum number of results to return for each paginated request.

    Default: 50

Return type:

dict

Returns:

Response Syntax

{
    'dashboardSummaries': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • dashboardSummaries (list) –

      A list that summarizes each dashboard in the project.

      • (dict) –

        Contains a dashboard summary.

        • id (string) –

          The ID of the dashboard.

        • name (string) –

          The name of the dashboard

        • description (string) –

          The dashboard’s description.

        • creationDate (datetime) –

          The date the dashboard was created, in Unix epoch time.

        • lastUpdateDate (datetime) –

          The date the dashboard was last updated, in Unix epoch time.

    • nextToken (string) –

      The token for the next set of results, or null if there are no additional results.

Exceptions

  • IoTSiteWise.Client.exceptions.InvalidRequestException

  • IoTSiteWise.Client.exceptions.InternalFailureException

  • IoTSiteWise.Client.exceptions.ThrottlingException