Utilisation de ListDashboards avec un kit AWS SDK ou une interface de ligne de commande - Exemples de code de kit AWS SDK

D’autres exemples de kits AWS SDK sont disponibles dans le référentiel GitHub AWS Doc SDK Examples.

Utilisation de ListDashboards avec un kit AWS SDK ou une interface de ligne de commande

Les exemples de code suivants illustrent comment utiliser ListDashboards.

.NET
SDK pour .NET
Note

Il y en a plus sur GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le référentiel d’exemples de code AWS.

/// <summary> /// Get a list of dashboards. /// </summary> /// <returns>A list of DashboardEntry objects.</returns> public async Task<List<DashboardEntry>> ListDashboards() { var results = new List<DashboardEntry>(); var paginateDashboards = _amazonCloudWatch.Paginators.ListDashboards( new ListDashboardsRequest()); // Get the entire list using the paginator. await foreach (var data in paginateDashboards.DashboardEntries) { results.Add(data); } return results; }
  • Pour obtenir plus de détails sur l’API, consultez la section ListDashboards de la référence d’API AWS SDK pour .NET.

CLI
AWS CLI

Pour extraire une liste de tableaux de bord

L’exemple list-dashboards suivant répertorie tous les tableaux de bord du compte spécifié.

aws cloudwatch list-dashboards

Sortie :

{ "DashboardEntries": [ { "DashboardName": "Dashboard-A", "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-A", "LastModified": "2024-10-11T18:40:11+00:00", "Size": 271 }, { "DashboardName": "Dashboard-B", "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-B", "LastModified": "2024-10-11T18:44:41+00:00", "Size": 522 } ] }

Pour plus d’informations, consultez Tableaux de bord Amazon CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez ListDashboards dans la Référence des commandes AWS CLI.

Java
SDK pour Java 2.x
Note

Il y en a plus sur GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le référentiel d’exemples de code AWS.

/** * Lists the available dashboards. * * @return a {@link CompletableFuture} that completes when the operation is finished. * The future will complete exceptionally if an error occurs while listing the dashboards. */ public CompletableFuture<Void> listDashboardsAsync() { ListDashboardsRequest listDashboardsRequest = ListDashboardsRequest.builder().build(); ListDashboardsPublisher paginator = getAsyncClient().listDashboardsPaginator(listDashboardsRequest); return paginator.subscribe(response -> { response.dashboardEntries().forEach(entry -> { logger.info("Dashboard name is: {} ", entry.dashboardName()); logger.info("Dashboard ARN is: {} ", entry.dashboardArn()); }); }).exceptionally(ex -> { logger.info("Failed to list dashboards: {} ", ex.getMessage()); throw new RuntimeException("Error occurred while listing dashboards", ex); }); }
  • Pour obtenir plus de détails sur l’API, consultez la section ListDashboards de la référence d’API AWS SDK for Java 2.x.

Kotlin
SDK pour Kotlin
Note

Il y en a plus sur GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le référentiel d’exemples de code AWS.

suspend fun listDashboards() { CloudWatchClient { region = "us-east-1" }.use { cwClient -> cwClient .listDashboardsPaginated({}) .transform { it.dashboardEntries?.forEach { obj -> emit(obj) } } .collect { obj -> println("Name is ${obj.dashboardName}") println("Dashboard ARN is ${obj.dashboardArn}") } } }
  • Pour plus de détails sur l’API, consultez ListDashboards dans la Référence d’API du kit SDK AWS pour Kotlin.

PowerShell
Outils pour PowerShell V4

Exemple 1 : renvoie la collection de tableaux de bord pour votre compte.

Get-CWDashboardList

Sortie :

DashboardArn DashboardName LastModified Size ------------ ------------- ------------ ---- arn:... Dashboard1 7/6/2017 8:14:15 PM 252

Exemple 2 : renvoie la collection de tableaux de bord de votre compte dont le nom commence par le préfixe « dev ».

Get-CWDashboardList -DashboardNamePrefix dev
  • Pour plus de détails sur l’API, consultez ListDashboards dans la Référence des applets de commande pour les Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5

Exemple 1 : renvoie la collection de tableaux de bord pour votre compte.

Get-CWDashboardList

Sortie :

DashboardArn DashboardName LastModified Size ------------ ------------- ------------ ---- arn:... Dashboard1 7/6/2017 8:14:15 PM 252

Exemple 2 : renvoie la collection de tableaux de bord de votre compte dont le nom commence par le préfixe « dev ».

Get-CWDashboardList -DashboardNamePrefix dev
  • Pour plus de détails sur l’API, consultez ListDashboards dans la Référence des applets de commande pour les Outils AWS pour PowerShell (V5).