CloudWatchOmni / Paginator / ListOmniDashboards

ListOmniDashboards

class CloudWatchOmni.Paginator.ListOmniDashboards

paginator = client.get_paginator('list_omni_dashboards')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchOmni.Client.list_omni_dashboards().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• spaceId (string) –

  [REQUIRED]

  The unique ID of the space.

• namePrefix (string) – Filter to dashboards whose name starts with this prefix.

• 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

{
    'items': [
        {
            'dashboardId': 'string',
            'arn': 'string',
            'name': 'string',
            'createdBy': 'string',
            'description': 'string',
            'tags': {
                'string': 'string'
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The list of dashboard summaries.

    • (dict) –

      Summary of a dashboard. Call GetOmniDashboard for the full dashboard.

      • dashboardId (string) –

        The unique ID of the dashboard.

      • arn (string) –

        The Amazon Resource Name (ARN) of the dashboard.

      • name (string) –

        A name that identifies the dashboard.

      • createdBy (string) –

        The principal that created the dashboard.

      • description (string) –

        An optional description of the dashboard.

      • tags (dict) –

        The tags associated with the dashboard.

        • (string) –

          Tag key. Must be non-empty; AWS-standard maximum length. Constraining the key (rather than a bare String) rejects empty-key payloads at the edge with a 400 ValidationException instead of faulting downstream as a 500.

          • (string) –

            Tag value. AWS-standard maximum length; may be empty.

      • createdAt (datetime) –

        The timestamp when the dashboard was created.

      • updatedAt (datetime) –

        The timestamp when the dashboard was last updated.

  • NextToken (string) –

    A token to resume pagination.