BillingandCostManagementDashboards / Client / get_scheduled_report

get_scheduled_report¶

BillingandCostManagementDashboards.Client.get_scheduled_report(**kwargs)¶

Retrieves the configuration and metadata of a specified scheduled report.

Request Syntax

response = client.get_scheduled_report(
    arn='string'
)

Parameters:

arn (string) –

[REQUIRED]

The ARN of the scheduled report to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'scheduledReport': {
        'arn': 'string',
        'name': 'string',
        'dashboardArn': 'string',
        'scheduledReportExecutionRoleArn': 'string',
        'scheduleConfig': {
            'scheduleExpression': 'string',
            'scheduleExpressionTimeZone': 'string',
            'schedulePeriod': {
                'startTime': datetime(2015, 1, 1),
                'endTime': datetime(2015, 1, 1)
            },
            'state': 'ENABLED'|'DISABLED'
        },
        'description': 'string',
        'widgetIds': [
            'string',
        ],
        'widgetDateRangeOverride': {
            'startTime': {
                'type': 'ABSOLUTE'|'RELATIVE',
                'value': 'string'
            },
            'endTime': {
                'type': 'ABSOLUTE'|'RELATIVE',
                'value': 'string'
            }
        },
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'lastExecutionAt': datetime(2015, 1, 1),
        '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',
            ]
        }
    }
}

Response Structure

(dict) –
- scheduledReport (dict) –
  
  The scheduled report configuration and metadata.
  - 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.
  - scheduledReportExecutionRoleArn (string) –
    
    The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.
  - scheduleConfig (dict) –
    
    The schedule configuration that defines when and how often the report is generated.
    - scheduleExpression (string) –
      
      The schedule expression that specifies when to trigger the scheduled report run. This value must be a cron expression consisting of six fields separated by white spaces: cron(minutes hours day_of_month month day_of_week year).
    - scheduleExpressionTimeZone (string) –
      
      The time zone for the schedule expression, for example, UTC.
    - schedulePeriod (dict) –
      
      The time period during which the schedule is active.
      - startTime (datetime) –
        
        The start time of the schedule period. If not specified, defaults to the time of the create or update request. The start time cannot be more than 5 minutes before the time of the request.
      - endTime (datetime) –
        
        The end time of the schedule period. If not specified, defaults to 3 years from the time of the create or update request. The maximum allowed value is 3 years from the current time. Setting an end time beyond this limit returns a ValidationException.
    - state (string) –
      
      The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.
  - description (string) –
    
    A description of the scheduled report’s purpose or contents.
  - widgetIds (list) –
    
    The list of widget identifiers included in the scheduled report.
    - (string) –
  - widgetDateRangeOverride (dict) –
    
    The date range override applied to widgets in the scheduled report.
    - startTime (dict) –
      
      The start time of the date range for querying data.
      - type (string) –
        
        The type of date/time value: ABSOLUTE for specific dates or RELATIVE for dynamic time periods.
      - value (string) –
        
        The actual date/time value.
    - endTime (dict) –
      
      The end time of the date range for querying data.
      - type (string) –
        
        The type of date/time value: ABSOLUTE for specific dates or RELATIVE for dynamic time periods.
      - value (string) –
        
        The actual date/time value.
  - createdAt (datetime) –
    
    The timestamp when the scheduled report was created.
  - updatedAt (datetime) –
    
    The timestamp when the scheduled report was last modified.
  - lastExecutionAt (datetime) –
    
    The timestamp of the most recent execution of the scheduled report.
  - healthStatus (dict) –
    
    The health status of the scheduled report at 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) –

Exceptions

BillingandCostManagementDashboards.Client.exceptions.ThrottlingException
BillingandCostManagementDashboards.Client.exceptions.AccessDeniedException
BillingandCostManagementDashboards.Client.exceptions.InternalServerException
BillingandCostManagementDashboards.Client.exceptions.ValidationException
BillingandCostManagementDashboards.Client.exceptions.ResourceNotFoundException