CreateDashboard - Amazon QuickSight
Sintaxis de la solicitudParámetros de solicitud del URICuerpo de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

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 Amazon QuickSight que identifica a Amazon QuickSight informes, creados a partir de análisis. Puedes compartir Amazon QuickSight paneles. 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 unAWSaccount.

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 del URI

La solicitud utiliza los siguientes parámetros URI.

AwsAccountId

El ID de laAWSen la que desea crear el panel.

Restricciones de longitud Longitud fija de 12.

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

Obligatorio: Sí

DashboardId

El identificador del panel, que también se ha añadido 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.

Name

El nombre para mostrar del panel.

Type: Cadena

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

Obligatorio: Sí

SourceEntity

La entidad que utiliza como fuente cuando crea el panel. EnSourceEntity, especifica el tipo de objeto que va a utilizar como fuente. Solo puede crear un panel a partir de una plantilla, de modo que se utiliza unSourceTemplateEntidad. Si necesita crear un panel de control a partir de un análisis, primero convierta el análisis en una plantilla mediante la CreateTemplate Operación de la API. ParaSourceTemplate, especifique el nombre de recurso de Amazon (ARN) de la plantilla de origen. LaSourceTemplateEl ARN puede contener cualquierAWScuenta y cualquier Amazon QuickSight-admitidoRegión de AWS.

UsarDataSetReferencesentidad dentroSourceTemplatepara enumerar los conjuntos de datos de reemplazo para los marcadores de posición que aparecen en el original. El esquema de cada conjunto de datos debe coincidir con su marcador de posición.

Tipo: objeto DashboardSourceEntity

Obligatorio: Sí

DashboardPublishOptions

Opciones para publicar el panel al crearlo:

  • AvailabilityStatusparaAdHocFilteringOption- Este estado puede ser:ENABLEDoDISABLED. Cuando se ha establecido enDISABLED, Amazon QuickSight deshabilita el panel de filtro izquierdo en el panel publicado, que se puede usar para el filtrado ad hoc (una sola vez). Esta opción esENABLEDde forma predeterminada.

  • AvailabilityStatusparaExportToCSVOption- Este estado puede ser:ENABLEDoDISABLED. La opción visual para exportar datos a formato.CSV no está habilitada cuando se establece enDISABLED. Esta opción esENABLEDde forma predeterminada.

  • VisibilityStateparaSheetControlsOption- Este estado de visibilidad puede serCOLLAPSEDoEXPANDED. Esta opción esCOLLAPSEDde forma predeterminada.

Tipo: objeto DashboardPublishOptions

Obligatorio: No

Parameters

Los parámetros para la creación del panel, que desea usar 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

Permissions

: una estructura que contiene los permisos del panel. Puede usar esta estructura para conceder permisos si proporciona una lista de información de acción de IAM para cada ARN principal.

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

Type: Matriz deResourcePermissionobjects

Miembros de la matriz: Número mínimo de 1 elemento. Número máximo de 64 elementos.

Obligatorio: No

Tags

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

Type: Matriz deTagobjects

Miembros de la matriz: 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 está utilizando para este panel. Si agrega un valor para este campo, anula el valor que se utiliza en la entidad de origen. El ARN del tema debe existir en el mismoAWScuenta en la que se crea el panel de control.

Type: Cadena

Obligatorio: No

VersionDescription

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

Type: 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 siguiente respuesta HTTP.

Status

El estado HTTP de la solicitud.

El servicio devuelve los datos siguientes en formato JSON.

Arn

El ARN del panel.

Type: Cadena

CreationStatus

Estado de la solicitud de creación de paneles.

Type: Cadena

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

DashboardId

El identificador del panel.

Type: Cadena

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

Patrón: [\w\-]+

RequestId

LaAWSID de solicitud para esta operación.

Type: Cadena

VersionArn

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

Type: Cadena

Errores

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

ConflictException

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 Amazon. QuickSighten la que la edición no incluye soporte para esa operación. Amazon. QuickSight actualmente tiene 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: