BillingandCostManagementDashboards / Client / list_dashboards

list_dashboards¶

BillingandCostManagementDashboards.Client.list_dashboards(**kwargs)¶

Returns a list of all dashboards in your account.

Request Syntax

response = client.list_dashboards(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return in a single call. The default value is 20.
nextToken (string) – The token for the next page of results. Use the value returned in the previous response.

Return type:

dict

Returns:

Response Syntax

{
    'dashboards': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'type': 'CUSTOM',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- dashboards (list) –
  
  An array of dashboard references, containing basic information about each dashboard.
  - (dict) –
    
    Contains basic information about a dashboard, including its ARN, name, type, and timestamps.
    - arn (string) –
      
      The ARN of the referenced dashboard.
    - name (string) –
      
      The name of the referenced dashboard.
    - description (string) –
      
      The description of the referenced dashboard.
    - type (string) –
      
      The dashboard type.
    - createdAt (datetime) –
      
      The timestamp when the dashboard was created.
    - updatedAt (datetime) –
      
      The timestamp when the dashboard was last modified.
- nextToken (string) –
  
  The token to use to retrieve the next page of results. Not returned if there are no more results to retrieve.

Exceptions

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