View a markdown version of this page

Uso de GetDashboard con un SDK de AWS o la CLI - Amazon CloudWatch

Uso de GetDashboard con un SDK de AWS o la CLI

Los siguientes ejemplos de código muestran cómo utilizar GetDashboard.

Los ejemplos de acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Puede ver esta acción en contexto en los siguientes ejemplos de código:

.NET
SDK para .NET (v4)
nota

Hay más en GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el Repositorio de ejemplos de código de AWS. 

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

  • Para obtener información sobre las API, consulte GetDashboard en la Referencia de la API de AWS SDK para .NET.

CLI
AWS CLI

Recuperación de información sobre un panel

En el siguiente ejemplo de get-dashboard se muestra información acerca del panel denominado Dashboard-A en la cuenta especificada.

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

Salida:

{
    "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 obtener más información, consulte Paneles de Amazon CloudWatch en la Guía del usuario de Amazon CloudWatch.

  • Para obtener información sobre la API, consulte GetDashboard en la Referencia de comandos de la AWS CLI.

PowerShell
Herramientas para PowerShell V4

Ejemplo 1: devuelve el arn al cuerpo del panel especificado.

Get-CWDashboard -DashboardName Dashboard1

Salida:

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

  • Para obtener información sobre la API, consulte GetDashboard en la Referencia de Cmdlet de las Herramientas de AWS para PowerShell (V4).

Herramientas para PowerShell V5

Ejemplo 1: devuelve el arn al cuerpo del panel especificado.

Get-CWDashboard -DashboardName Dashboard1

Salida:

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

  • Para obtener información sobre la API, consulte GetDashboard en la Referencia de Cmdlet de las Herramientas de AWS para PowerShell (V5).

Para obtener una lista completa de las guías para desarrolladores de AWS SDK y ejemplos de código, consulte Uso de CloudWatch con SDK de AWS. En este tema también se incluye información sobre cómo comenzar a utilizar el SDK y detalles sobre sus versiones anteriores.