CloudWatch / Client / put_dashboard

put_dashboard#

CloudWatch.Client.put_dashboard(**kwargs)#

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

All dashboards in your account are global, not region-specific.

A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

See also: AWS API Documentation

Request Syntax

response = client.put_dashboard(
    DashboardName='string',
    DashboardBody='string'
)
Parameters:

  • DashboardName (string) –

    [REQUIRED]

    The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, “-”, and “_”. This parameter is required.

  • DashboardBody (string) –

    [REQUIRED]

    The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.

    For more information about the syntax, see Dashboard Body Structure and Syntax.

Return type:

dict

Returns:

Response Syntax

{
    'DashboardValidationMessages': [
        {
            'DataPath': 'string',
            'Message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • DashboardValidationMessages (list) –

      If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty.

      If this result includes only warning messages, then the input was valid enough for the dashboard to be created or modified, but some elements of the dashboard might not render.

      If this result includes error messages, the input was not valid and the operation failed.

      • (dict) –

        An error or warning for the operation.

        • DataPath (string) –

          The data path related to the message.

        • Message (string) –

          A message describing the error or warning.

Exceptions

  • CloudWatch.Client.exceptions.DashboardInvalidInputError

  • CloudWatch.Client.exceptions.InternalServiceFault