get_dashboard

CloudWatch.Client.get_dashboard(**kwargs)

Displays the details of the dashboard that you specify.

To copy an existing dashboard, use GetDashboard , and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

See also: AWS API Documentation

Request Syntax

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

Parameters

DashboardName (string) --

[REQUIRED]

The name of the dashboard to be described.

Return type

dict

Returns

Response Syntax

{
    'DashboardArn': 'string',
    'DashboardBody': 'string',
    'DashboardName': 'string'
}

Response Structure

• (dict) --
  • DashboardArn (string) --

    The Amazon Resource Name (ARN) of the dashboard.

  • DashboardBody (string) --

    The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the DashboardBody syntax, see Dashboard Body Structure and Syntax.

  • DashboardName (string) --

    The name of the dashboard.

Exceptions

• CloudWatch.Client.exceptions.InvalidParameterValueException
• CloudWatch.Client.exceptions.DashboardNotFoundError
• CloudWatch.Client.exceptions.InternalServiceFault