AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginPutDashboard and EndPutDashboard.
Namespace: Amazon.CloudWatch
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z
public abstract Task<PutDashboardResponse> PutDashboardAsync( PutDashboardRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the PutDashboard service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| DashboardInvalidInputErrorException | Some part of the dashboard data is invalid. |
| InternalServiceException | Request processing has failed due to some unknown error, exception, or failure. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5