Weitere AWS SDK-Beispiele sind im GitHub Repo [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) verfügbar.
Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
# Verwendung `PutDashboard` mit einem AWS SDK oder CLI
Die folgenden Code-Beispiele zeigen, wie `PutDashboard` verwendet wird.
Beispiele für Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Im folgenden Codebeispiel können Sie diese Aktion im Kontext sehen:
+ [Kennenlernen der Grundlagen](cloudwatch_example_cloudwatch_GetStartedMetricsDashboardsAlarms_section.md)
------
#### [ .NET ]
**SDK für .NET (v4)**
Es gibt noch mehr dazu GitHub. Hier finden Sie das vollständige Beispiel und erfahren, wie Sie das [AWS -Code-Beispiel-](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/CloudWatch#code-examples) einrichten und ausführen.
```
///
/// Set up a dashboard using a call to the wrapper class.
///
/// The metric namespace.
/// The metric name.
/// The name of the dashboard.
/// A list of validation messages.
private static async Task> SetupDashboard(
string customMetricNamespace, string customMetricName, string dashboardName)
{
// Get the dashboard model from configuration.
var newDashboard = new DashboardModel();
_configuration.GetSection("dashboardExampleBody").Bind(newDashboard);
// Add a new metric to the dashboard.
newDashboard.Widgets.Add(new Widget
{
Height = 8,
Width = 8,
Y = 8,
X = 0,
Type = "metric",
Properties = new Properties
{
Metrics = new List>
{ new() { customMetricNamespace, customMetricName } },
View = "timeSeries",
Region = "us-east-1",
Stat = "Sum",
Period = 86400,
YAxis = new YAxis { Left = new Left { Min = 0, Max = 100 } },
Title = "Custom Metric Widget",
LiveData = true,
Sparkline = true,
Trend = true,
Stacked = false,
SetPeriodToTimeRange = false
}
});
var newDashboardString = JsonSerializer.Serialize(newDashboard,
new JsonSerializerOptions
{ DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull });
var validationMessages =
await _cloudWatchWrapper.PutDashboard(dashboardName, newDashboardString);
return validationMessages;
}
///
/// Wrapper to create or add to a dashboard with metrics.
///
/// The name for the dashboard.
/// The metric data in JSON for the dashboard.
/// A list of validation messages for the dashboard.
public async Task> PutDashboard(string dashboardName,
string dashboardBody)
{
// Updating a dashboard replaces all contents.
// Best practice is to include a text widget indicating this dashboard was created programmatically.
var dashboardResponse = await _amazonCloudWatch.PutDashboardAsync(
new PutDashboardRequest()
{
DashboardName = dashboardName,
DashboardBody = dashboardBody
});
return dashboardResponse.DashboardValidationMessages ?? new List();
}
```
+ Einzelheiten zur API finden Sie [PutDashboard](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/PutDashboard)in der *AWS SDK für .NET API-Referenz*.
------
#### [ CLI ]
**AWS CLI**
**So erstellen Sie ein Dashboard**
Im folgenden Beispiel für `put-dashboard` wird ein Dashboard mit dem Namen `Dashboard-A` im angegebenen Konto erstellt.
```
aws cloudwatch put-dashboard \
--dashboard-name Dashboard-A \
--dashboard-body '{"widgets":[{"height":6,"width":6,"y":0,"x":0,"type":"metric","properties":{"view":"timeSeries","stacked":false,"metrics":[["Namespace","CPUUtilization","Environment","Prod","Type","App"]],"region":"us-east-1"}}]}'
```
Ausgabe:
```
{
"DashboardValidationMessages": []
}
```
Weitere Informationen finden Sie unter [Erstellen eines CloudWatch Dashboards](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/create_dashboard.html) im * CloudWatch Amazon-Benutzerhandbuch*.
+ Einzelheiten zur API finden Sie [PutDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-dashboard.html)in der *AWS CLI Befehlsreferenz*.
------
#### [ Java ]
**SDK für Java 2.x**
Es gibt noch mehr dazu GitHub. Hier finden Sie das vollständige Beispiel und erfahren, wie Sie das [AWS -Code-Beispiel-](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cloudwatch#code-examples) einrichten und ausführen.
```
/**
* Creates a new dashboard with the specified name and metrics from the given file.
*
* @param dashboardName the name of the dashboard to be created
* @param fileName the name of the file containing the dashboard body
* @return a {@link CompletableFuture} representing the asynchronous operation of creating the dashboard
* @throws IOException if there is an error reading the dashboard body from the file
*/
public CompletableFuture createDashboardWithMetricsAsync(String dashboardName, String fileName) throws IOException {
String dashboardBody = readFileAsString(fileName);
PutDashboardRequest dashboardRequest = PutDashboardRequest.builder()
.dashboardName(dashboardName)
.dashboardBody(dashboardBody)
.build();
return getAsyncClient().putDashboard(dashboardRequest)
.handle((response, ex) -> {
if (ex != null) {
logger.info("Failed to create dashboard: {}", ex.getMessage());
throw new RuntimeException("Dashboard creation failed", ex);
} else {
// Handle the normal response case
logger.info("{} was successfully created.", dashboardName);
List messages = response.dashboardValidationMessages();
if (messages.isEmpty()) {
logger.info("There are no messages in the new Dashboard.");
} else {
for (DashboardValidationMessage message : messages) {
logger.info("Message: {}", message.message());
}
}
return response; // Return the response for further use
}
});
}
```
+ Einzelheiten zur API finden Sie [PutDashboard](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/PutDashboard)in der *AWS SDK for Java 2.x API-Referenz*.
------
#### [ Kotlin ]
**SDK für Kotlin**
Es gibt noch mehr dazu GitHub. Hier finden Sie das vollständige Beispiel und erfahren, wie Sie das [AWS -Code-Beispiel-](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/cloudwatch#code-examples) einrichten und ausführen.
```
suspend fun createDashboardWithMetrics(
dashboardNameVal: String,
fileNameVal: String,
) {
val dashboardRequest =
PutDashboardRequest {
dashboardName = dashboardNameVal
dashboardBody = readFileAsString(fileNameVal)
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.putDashboard(dashboardRequest)
println("$dashboardNameVal was successfully created.")
val messages = response.dashboardValidationMessages
if (messages != null) {
if (messages.isEmpty()) {
println("There are no messages in the new Dashboard")
} else {
for (message in messages) {
println("Message is: ${message.message}")
}
}
}
}
}
```
+ Einzelheiten zur API finden Sie [PutDashboard](https://sdk.amazonaws.com/kotlin/api/latest/index.html)in der *API-Referenz zum AWS SDK für Kotlin*.
------
#### [ PowerShell ]
**Tools für V4 PowerShell **
**Beispiel 1: Erstellt oder aktualisiert das Dashboard mit dem Namen „Dashboard1“, sodass es zwei Metrik-Widgets nebeneinander enthält.**
```
$dashBody = @"
{
"widgets":[
{
"type":"metric",
"x":0,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345"
]
],
"period":300,
"stat":"Average",
"region":"us-east-1",
"title":"EC2 Instance CPU"
}
},
{
"type":"metric",
"x":12,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/S3",
"BucketSizeBytes",
"BucketName",
"amzn-s3-demo-bucket"
]
],
"period":86400,
"stat":"Maximum",
"region":"us-east-1",
"title":"amzn-s3-demo-bucket bytes"
}
}
]
}
"@
Write-CWDashboard -DashboardName Dashboard1 -DashboardBody $dashBody
```
**Beispiel 2: Erstellt oder aktualisiert das Dashboard und leitet den Inhalt, der das Dashboard beschreibt, an das Cmdlet weiter.**
```
$dashBody = @"
{
...
}
"@
$dashBody | Write-CWDashboard -DashboardName Dashboard1
```
+ Einzelheiten zur API finden Sie unter [PutDashboard AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet-Referenz (V4).*
**Tools für V5 PowerShell **
**Beispiel 1: Erstellt oder aktualisiert das Dashboard mit dem Namen „Dashboard1“, sodass es zwei Metrik-Widgets nebeneinander enthält.**
```
$dashBody = @"
{
"widgets":[
{
"type":"metric",
"x":0,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345"
]
],
"period":300,
"stat":"Average",
"region":"us-east-1",
"title":"EC2 Instance CPU"
}
},
{
"type":"metric",
"x":12,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/S3",
"BucketSizeBytes",
"BucketName",
"amzn-s3-demo-bucket"
]
],
"period":86400,
"stat":"Maximum",
"region":"us-east-1",
"title":"amzn-s3-demo-bucket bytes"
}
}
]
}
"@
Write-CWDashboard -DashboardName Dashboard1 -DashboardBody $dashBody
```
**Beispiel 2: Erstellt oder aktualisiert das Dashboard und leitet den Inhalt, der das Dashboard beschreibt, an das Cmdlet weiter.**
```
$dashBody = @"
{
...
}
"@
$dashBody | Write-CWDashboard -DashboardName Dashboard1
```
+ Einzelheiten zur API finden Sie unter [PutDashboard AWS -Tools für PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet-Referenz (*V5).
------