View a markdown version of this page

Usar GetDashboard com o AWS SDK ou a CLI - Amazon CloudWatch

Usar GetDashboard com o AWS SDK ou a CLI

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

Exemplos de ações são trechos de código de programas maiores e devem ser executados em contexto. É possível ver essa ação em contexto nos seguintes exemplos de código:

.NET
SDK para .NET (v4)
nota

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

    /// <summary>
    /// Get information on a dashboard.
    /// </summary>
    /// <param name="dashboardName">The name of the dashboard.</param>
    /// <returns>A JSON object with dashboard information.</returns>
    public async Task<string> GetDashboard(string dashboardName)
    {
        var dashboardResponse = await _amazonCloudWatch.GetDashboardAsync(
            new GetDashboardRequest()
            {
                DashboardName = dashboardName
            });

        return dashboardResponse.DashboardBody;
    }

  • Consulte detalhes da API em GetDashboard na Referência da API AWS SDK para .NET .

CLI
AWS CLI

Para recuperar informações sobre um painel

O exemplo get-dashboard a seguir exibe as informações sobre o painel denominado Dashboard-A na conta específica.

aws cloudwatch get-dashboard \
    --dashboard-name Dashboard-A

Resultado:

{
    "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-A",
    "DashboardBody": "{\"widgets\":[{\"type\":\"metric\",\"x\":0,\"y\":0,\"width\":6,\"height\":6,\"properties\":{\"view\":\"timeSeries\",\"stacked\":false,\"metrics\":[[\"AWS/EC2\",\"NetworkIn\",\"InstanceId\",\"i-0131f062232ade043\"],[\".\",\"NetworkOut\",\".\",\".\"]],\"region\":\"us-east-1\"}}]}",
    "DashboardName": "Dashboard-A"
}

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

  • Consulte detalhes da API em GetDashboard na Referência de comandos da AWS CLI.

PowerShell
Ferramentas para PowerShell V4

Exemplo 1: retorna o ARN do corpo do painel especificado.

Get-CWDashboard -DashboardName Dashboard1

Saída:

DashboardArn                                          DashboardBody
------------                                          -------------
arn:aws:cloudwatch::123456789012:dashboard/Dashboard1 {...

  • Consulte detalhes da API em GetDashboard na Referência de cmdlets do Ferramentas da AWS para PowerShell (V4).

Ferramentas para PowerShell V5

Exemplo 1: retorna o ARN do corpo do painel especificado.

Get-CWDashboard -DashboardName Dashboard1

Saída:

DashboardArn                                          DashboardBody
------------                                          -------------
arn:aws:cloudwatch::123456789012:dashboard/Dashboard1 {...

  • Para obter detalhes da API, consulte GetDashboard na Referência de cmdlets do Ferramentas da AWS para PowerShell (V5).

Para ver uma lista completa dos guias de desenvolvedor e exemplos de código do SDK da AWS, 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.