CloudWatch / Paginator / ListDashboards

ListDashboards#

class CloudWatch.Paginator.ListDashboards#

paginator = client.get_paginator('list_dashboards')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

DashboardNamePrefix (string) – If you specify this parameter, only the dashboards with names starting with the specified string are listed. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, “.”, “-”, and “_”.
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.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'DashboardEntries': [
        {
            'DashboardName': 'string',
            'DashboardArn': 'string',
            'LastModified': datetime(2015, 1, 1),
            'Size': 123
        },
    ],

}

Response Structure

(dict) –
- DashboardEntries (list) –
  
  The list of matching dashboards.
  - (dict) –
    
    Represents a specific dashboard.
    - DashboardName (string) –
      
      The name of the dashboard.
    - DashboardArn (string) –
      
      The Amazon Resource Name (ARN) of the dashboard.
    - LastModified (datetime) –
      
      The time stamp of when the dashboard was last modified, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
    - Size (integer) –
      
      The size of the dashboard, in bytes.