IoTSiteWise / Paginator / ListDashboards

ListDashboards

class IoTSiteWise.Paginator.ListDashboards

paginator = client.get_paginator('list_dashboards')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_dashboards().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    projectId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• projectId (string) –

  [REQUIRED]

  The ID of the project.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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

    A token to resume pagination.