Usar ListDashboards com o AWS SDK ou a CLI

Os exemplos de código a seguir mostram como usar o ListDashboards.

.NET

AWS SDK for .NET

nota

Há mais no GitHub. Encontre o exemplo completo e saiba como configurar e executar no AWS Code Examples Repository.

    /// <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;
    }

• Para obter detalhes da API, consulte ListDashboards na Referência da API AWS SDK for .NET.

CLI

AWS CLI

Para recuperar uma lista de painéis

O exemplo list-dashboards a seguir lista todos os painéis na conta especificada.

aws cloudwatch list-dashboards

Saída:

{
    "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
        }
    ]
}

Para obter mais informações, consulte Painéis do Amazon CloudWatch no Guiado usuário do Amazon CloudWatch.

• Para obter detalhes da API, consulte ListDashboards na Referência de comandos da AWS CLI.

Java

SDK para Java 2.x

nota

Há mais no GitHub. Encontre o exemplo completo e saiba como configurar e executar no Repositório de exemplos de código da 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);
        });
    }

• Para obter detalhes da API, consulte ListDashboards na Referência da API AWS SDK for Java 2.x.

Kotlin

SDK para Kotlin

nota

Há mais no GitHub. Encontre o exemplo completo e saiba como configurar e executar no Repositório de exemplos de código da 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}")
            }
    }
}

• Para obter detalhes da API, consulte ListDashboards, na Referência da API AWS SDK para Kotlin.

PowerShell

Ferramentas para PowerShell

Exemplo 1: retorna a coleção de painéis para sua conta.

Get-CWDashboardList

Saída:

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

Exemplo 2: retorna a coleção de painéis para sua conta cujos nomes começam com o prefixo “dev”.

Get-CWDashboardList -DashboardNamePrefix dev

• Para obter detalhes da API, consulte ListDashboards na Referência de cmdlet do Ferramentas da AWS para PowerShell.

Para ver uma lista completa dos Guias do AWS desenvolvedor de SDK e exemplos de código, consulte Como usar o CloudWatch com um AWS SDK. Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.