DescribeDashboard - Amazon QuickSight

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

DescribeDashboard

Proporciona un resumen para un panel.

Sintaxis de la solicitud

GET /accounts/AwsAccountId/dashboards/DashboardId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

AliasName

El nombre del alias.

Restricciones de longitud Longitud mínima de 1. La longitud máxima es de 2048 caracteres.

Patrón: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

AwsAccountId

El ID de laAWScuenta que contiene el panel que estás describiendo.

Restricciones de longitud Longitud fija de 12.

Patrón: ^[0-9]{12}$

Obligatorio: Sí

DashboardId

El ID del panel.

Restricciones de longitud Longitud mínima de 1. La longitud máxima es de 2048 caracteres.

Patrón: [\w\-]+

Obligatorio: Sí

VersionNumber

El número de la versión del panel. Si no se pasa un número de versión, se describe la última versión del panel publicada.

Rango válido: Valor mínimo de 1.

Cuerpo de la solicitud

La solicitud no tiene un cuerpo de la solicitud.

Sintaxis de la respuesta

HTTP/1.1 Status Content-type: application/json { "Dashboard": { "Arn": "string", "CreatedTime": number, "DashboardId": "string", "LastPublishedTime": number, "LastUpdatedTime": number, "Name": "string", "Version": { "Arn": "string", "CreatedTime": number, "DataSetArns": [ "string" ], "Description": "string", "Errors": [ { "Message": "string", "Type": "string" } ], "Sheets": [ { "Name": "string", "SheetId": "string" } ], "SourceEntityArn": "string", "Status": "string", "ThemeArn": "string", "VersionNumber": number } }, "RequestId": "string" }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve la siguiente respuesta HTTP.

Status

El estado HTTP de esta solicitud.

El servicio devuelve los datos siguientes en formato JSON.

Dashboard

Información sobre el panel de control.

Tipo: objeto Dashboard

RequestId

LaAWSID de solicitud de esta operación.

Type: Cadena

Errores

Para obtener información sobre errores que son comunes a todas las acciones, consulteErrores comunes.

AccessDeniedException

No tiene permiso de acceso. La credenciales proporcionadas no se pudieron validar. Es posible que no tenga autorización para realizar la solicitud. Asegúrese de que su cuenta esté autorizada para usar Amazon QuickSight , que sus políticas tienen los permisos correctos y que está utilizando las claves de acceso correctas.

Código de estado HTTP: 401

InternalFailureException

Se produjo un error interno.

Código de estado HTTP: 500

InvalidParameterValueException

Uno o más parámetros tienen un valor que no es válido.

Código de estado HTTP: 400

ResourceNotFoundException

No se encontraron uno o varios recursos.

Código de estado HTTP: 404

ThrottlingException

El acceso está limitado.

Código de estado HTTP: 429

UnsupportedUserEditionException

Este error indica que está llamando a una operación de Amazon QuickSighten la que la edición no incluye soporte para esa operación. Amazon Amazon QuickSight actualmente tiene la Standard Edition y Enterprise Edition. No todas las operaciones y funciones están disponibles en todas las ediciones.

Código de estado HTTP: 403

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: