CloudTrail / Client / get_dashboard

get_dashboard¶

CloudTrail.Client.get_dashboard(**kwargs)¶

Warning

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

Returns the specified dashboard.

Request Syntax

response = client.get_dashboard(
    DashboardId='string'
)

Parameters:

DashboardId (string) –

[REQUIRED]

The name or ARN for the dashboard.

Return type:

dict

Returns:

Response Syntax

{
    'DashboardArn': 'string',
    'Type': 'MANAGED'|'CUSTOM',
    'Status': 'CREATING'|'CREATED'|'UPDATING'|'UPDATED'|'DELETING',
    'Widgets': [
        {
            'QueryAlias': 'string',
            'QueryStatement': 'string',
            'QueryParameters': [
                'string',
            ],
            'ViewProperties': {
                'string': 'string'
            }
        },
    ],
    'RefreshSchedule': {
        'Frequency': {
            'Unit': 'HOURS'|'DAYS',
            'Value': 123
        },
        'Status': 'ENABLED'|'DISABLED',
        'TimeOfDay': 'string'
    },
    'CreatedTimestamp': datetime(2015, 1, 1),
    'UpdatedTimestamp': datetime(2015, 1, 1),
    'LastRefreshId': 'string',
    'LastRefreshFailureReason': 'string',
    'TerminationProtectionEnabled': True|False
}

Response Structure

(dict) –
- DashboardArn (string) –
  
  The ARN for the dashboard.
- Type (string) –
  
  The type of dashboard.
- Status (string) –
  
  The status of the dashboard.
- Widgets (list) –
  
  An array of widgets for the dashboard.
  - (dict) –
    
    A widget on a CloudTrail Lake dashboard.
    - QueryAlias (string) –
      
      The query alias used to identify the query for the widget.
    - QueryStatement (string) –
      
      The SQL query statement for the widget.
    - QueryParameters (list) –
      
      The query parameters for the widget.
      - (string) –
    - ViewProperties (dict) –
      
      The view properties for the widget. For more information about view properties, see View properties for widgets in the CloudTrail User Guide..
      - (string) –
        
        (string) –
- RefreshSchedule (dict) –
  
  The refresh schedule for the dashboard, if configured.
  - Frequency (dict) –
    
    The frequency at which you want the dashboard refreshed.
    - Unit (string) –
      
      The unit to use for the refresh.
      
      For custom dashboards, the unit can be HOURS or DAYS.
      
      For the Highlights dashboard, the Unit must be HOURS.
    - Value (integer) –
      
      The value for the refresh schedule.
      
      For custom dashboards, the following values are valid when the unit is HOURS: 1, 6, 12, 24
      
      For custom dashboards, the only valid value when the unit is DAYS is 1.
      
      For the Highlights dashboard, the Value must be 6.
  - Status (string) –
    
    Specifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.
  - TimeOfDay (string) –
    
    The time of day in UTC to run the schedule; for hourly only refer to minutes; default is 00:00.
- CreatedTimestamp (datetime) –
  
  The timestamp that shows when the dashboard was created.
- UpdatedTimestamp (datetime) –
  
  The timestamp that shows when the dashboard was last updated.
- LastRefreshId (string) –
  
  The ID of the last dashboard refresh.
- LastRefreshFailureReason (string) –
  
  Provides information about failures for the last scheduled refresh.
- TerminationProtectionEnabled (boolean) –
  
  Indicates whether termination protection is enabled for the dashboard.