BillingandCostManagementDashboards / Paginator / ListScheduledReports

ListScheduledReports¶

class BillingandCostManagementDashboards.Paginator.ListScheduledReports¶

paginator = client.get_paginator('list_scheduled_reports')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from BillingandCostManagementDashboards.Client.list_scheduled_reports().

Request Syntax

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

Parameters:

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

{
    'scheduledReports': [
        {
            'arn': 'string',
            'name': 'string',
            'dashboardArn': 'string',
            'scheduleExpression': 'string',
            'state': 'ENABLED'|'DISABLED',
            'healthStatus': {
                'statusCode': 'HEALTHY'|'UNHEALTHY',
                'lastRefreshedAt': datetime(2015, 1, 1),
                'statusReasons': [
                    'DATA_SOURCE_ACCESS_DENIED'|'EXECUTION_ROLE_ASSUME_FAILED'|'EXECUTION_ROLE_INSUFFICIENT_PERMISSIONS'|'DASHBOARD_NOT_FOUND'|'DASHBOARD_ACCESS_DENIED'|'INTERNAL_FAILURE'|'WIDGET_ID_NOT_FOUND',
                ]
            },
            'scheduleExpressionTimeZone': 'string',
            'widgetIds': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- scheduledReports (list) –
  
  An array of scheduled report summaries, containing basic information about each scheduled report.
  - (dict) –
    
    Contains summary information for a scheduled report.
    - arn (string) –
      
      The ARN of the scheduled report.
    - name (string) –
      
      The name of the scheduled report.
    - dashboardArn (string) –
      
      The ARN of the dashboard associated with the scheduled report.
    - scheduleExpression (string) –
      
      The schedule expression that defines when the report runs.
    - state (string) –
      
      The state of the schedule: ENABLED or DISABLED.
    - healthStatus (dict) –
      
      The health status of the scheduled report as of its last refresh time.
      - statusCode (string) –
        
        The health status code. HEALTHY indicates the scheduled report is configured properly and has all required permissions to execute. UNHEALTHY indicates the scheduled report is unable to deliver the notification to the default Amazon EventBridge EventBus in your account and your action is needed. The reason for the unhealthy state is captured in the health status reasons.
      - lastRefreshedAt (datetime) –
        
        The timestamp when the health status was last refreshed.
      - statusReasons (list) –
        
        The list of reasons for the current health status. Only present when the status is UNHEALTHY.
        
        (string) –
    - scheduleExpressionTimeZone (string) –
      
      The time zone for the schedule expression, for example, UTC.
    - widgetIds (list) –
      
      The list of widget identifiers included in the scheduled report.
      - (string) –
- NextToken (string) –
  
  A token to resume pagination.