CreateDashboard -

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.

CreateDashboard

Crea un panel a partir de una plantilla Para crear primero una plantilla, consulte la operación API CreateTemplate .

Un panel es una entidad de QuickSight que identifica los informes de QuickSight creados a partir de análisis. Puede compartir paneles de QuickSight. Con los permisos adecuados, puede crear informes de correo electrónico programados a partir de ellos. Si tiene los permisos correctos, puede crear un panel a partir de una plantilla que exista en una cuenta de AWS diferente.

Sintaxis de la solicitud

POST /accounts/AwsAccountId/dashboards/DashboardId HTTP/1.1 Content-type: application/json { "DashboardPublishOptions": { "AdHocFilteringOption": { "AvailabilityStatus": "string" }, "ExportToCSVOption": { "AvailabilityStatus": "string" }, "SheetControlsOption": { "VisibilityState": "string" } }, "Name": "string", "Parameters": { "DateTimeParameters": [ { "Name": "string", "Values": [ number ] } ], "DecimalParameters": [ { "Name": "string", "Values": [ number ] } ], "IntegerParameters": [ { "Name": "string", "Values": [ number ] } ], "StringParameters": [ { "Name": "string", "Values": [ "string" ] } ] }, "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "SourceEntity": { "SourceTemplate": { "Arn": "string", "DataSetReferences": [ { "DataSetArn": "string", "DataSetPlaceholder": "string" } ] } }, "Tags": [ { "Key": "string", "Value": "string" } ], "ThemeArn": "string", "VersionDescription": "string" }

Parámetros de solicitud URI

La solicitud utiliza los siguientes parámetros URI.

AwsAccountId

El ID de la cuenta de AWS en la que desea crear el panel.

Restricciones de longitud: Longitud fija de 12.

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

: obligatorio Sí

DashboardId

El ID del panel, también se agregó a la política de IAM.

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

Patrón: [\w\-]+

: obligatorio Sí

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

Nombre

El nombre para mostrar del panel.

Tipo: Cadena

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

: obligatorio Sí

SourceEntity

Entidad que está utilizando como origen al crear el panel. EnSourceEntity, especifique el tipo de objeto que está utilizando como origen. Solo puede crear un panel a partir de una plantilla, por lo que utiliza unaSourceTemplateEntidad. Si necesita crear un panel a partir de un análisis, primero convierta el análisis en una plantilla utilizando la herramientaCreateTemplateOperación de la API ParaSourceTemplate, especifique el nombre de recurso de Amazon (ARN) de la plantilla de origen. LaSourceTemplateARN puede contener cualquier cuenta de AWS y cualquier región de AWS compatible con QuickSight.

UsarDataSetReferencesentidad dentro deSourceTemplatepara enumerar los datasets de reemplazo de los marcadores de posición enumerados en el original. El esquema de cada dataset debe coincidir con su marcador de posición.

Tipo: objeto DashboardSourceEntity

: obligatorio Sí

DashboardPublishOptions

Opciones para publicar el panel al crearlo:

  • AvailabilityStatus: paraAdHocFilteringOption- Este estado puede serENABLEDorDISABLED. Cuando se ha establecido enDISABLED, QuickSight deshabilita el panel de filtro izquierdo del panel publicado, que se puede utilizar para el filtrado ad hoc (de una sola vez). Esta opción esENABLEDDe forma predeterminada.

  • AvailabilityStatus: paraExportToCSVOption- Este estado puede serENABLEDorDISABLED. La opción visual para exportar datos al formato.CSV no está habilitada cuando se establece enDISABLED. Esta opción esENABLEDDe forma predeterminada.

  • VisibilityState: paraSheetControlsOption- Este estado de visibilidad puede serCOLLAPSEDorEXPANDED. Esta opción esCOLLAPSEDDe forma predeterminada.

Tipo: objeto DashboardPublishOptions

: obligatorio No

Parámetros

Parámetros para la creación del panel, que desea utilizar para anular la configuración predeterminada. Un panel puede tener cualquier tipo de parámetros, y algunos parámetros pueden aceptar varios valores.

Tipo: objeto Parameters

: obligatorio No

Permisos

: una estructura que contiene los permisos del panel. Puede utilizar esta estructura para conceder permisos proporcionando una lista de información de acciones de IAM para cada ARN principal.

Para especificar ningún permiso, omita la lista de permisos.

Tipo: Array deResourcePermissionobjects

Miembros de matrices Número mínimo de 1 elemento. Número máximo de 64 elementos.

: obligatorio No

Etiquetas

Contiene un mapa de los pares clave-valor para la etiqueta o etiquetas de recurso asignadas al panel.

Tipo: Array deTagobjects

Miembros de matrices Número mínimo de 1 elemento. Número máximo de 200 elementos.

: obligatorio No

ThemeArn

El nombre de recurso de Amazon (ARN) del tema que se utiliza para este panel. Si agrega un valor para este campo, reemplaza el valor que se utiliza en la entidad de origen. El ARN del tema debe existir en la misma cuenta de AWS en la que crea el panel.

Tipo: Cadena

: obligatorio No

VersionDescription

Una descripción de la primera versión del panel que se está creando.

Tipo: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es 512.

: obligatorio No

Sintaxis de la respuesta

HTTP/1.1 Status Content-type: application/json { "Arn": "string", "CreationStatus": "string", "DashboardId": "string", "RequestId": "string", "VersionArn": "string" }

Elementos de respuesta

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

Estado

El estado HTTP de la solicitud.

El servicio devuelve los datos siguientes en formato JSON.

Arn

El ARN del panel de.

Tipo: Cadena

Estado de creación

El estado de la solicitud de creación del panel de.

Tipo: Cadena

Valores válidos: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

DashboardId

El identificador del panel.

Tipo: Cadena

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

Patrón: [\w\-]+

RequestId

ID de solicitud de AWS de esta operación.

Tipo: Cadena

VersionArn

El ARN del panel, incluido el número de versión de la primera versión que se crea.

Tipo: Cadena

Errors

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

ConflictExcepción

La actualización o eliminación de un recurso puede provocar un estado incoherente.

Código de estado HTTP: 409

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

ResourceExistsException

El recurso especificado ya existe.

Código de estado HTTP: 409

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 en una suscripción de Amazon QuickSight en la que la edición no admite esa operación. Las ediciones actuales de Amazon QuickSight son 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: