UpdateDashboard - 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.

UpdateDashboard

Actualiza un panel enAWSaccount.

nota

La actualización de un panel crea una nueva versión del panel, pero no publica inmediatamente la nueva versión. Puede actualizar la versión publicada de un panel mediante UpdateDashboardPublishedVersion Operación de la API.

Sintaxis de la solicitud

PUT /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" ]
         }
      ]
   },
   "SourceEntity": { 
      "SourceTemplate": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      }
   },
   "ThemeArn": "string",
   "VersionDescription": "string"
}

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

AwsAccountId

El ID de laAWScuenta que contiene el panel que está actualizando.

Requisitos de longitud: Longitud fija de 12 caracteres.

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

Oblig: Sí

DashboardId

El identificador del panel.

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

Patrón: [\w\-]+

Oblig: Sí

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

Name

El nombre para mostrar del panel.

Type: Cadena

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

Oblig: Sí

SourceEntity

La entidad que utiliza como fuente cuando actualiza el panel. EnSourceEntity, especifica el tipo de objeto que va a utilizar como fuente. Solo puede actualizar un panel a partir de una plantilla, por lo que utiliza unSourceTemplateEntidad. Si necesita actualizar un panel a partir de un análisis, primero convierta el análisis en una plantilla mediante el comando 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-admitiRegió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

Oblig: Sí

DashboardPublishOptions

Opciones para publicar el panel al crearlo:

  • AvailabilityStatusparaAdHocFilteringOption- este estado puedeENABLEDoDISABLED. Cuando se haDISABLED, 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 forma forma forma

  • AvailabilityStatusparaExportToCSVOption- este estado puedeENABLEDoDISABLED. La opción visual para exportar datos a formato.CSV no está habilitada cuando se establece enDISABLED. Esta opción esENABLEDde forma forma forma forma

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

Tipo: objeto DashboardPublishOptions

Oblig: No

Parameters

Estructura que contiene los parámetros del panel. Se trata de anulaciones de parámetros para un panel. Un panel puede tener cualquier tipo de parámetros y algunos parámetros pueden aceptar varios valores.

Tipo: objeto Parameters

Oblig: No

ThemeArn

El nombre de recurso de Amazon (ARN) del tema que se está utilizando en este panel. Si agrega un valor para este campo, anula el valor que se asoció originalmente a la Entidad. El ARN del tema debe existir en elAWScuenta en la que se crea el panel.

Type: Cadena

Oblig: No

VersionDescription

:

Type: Cadena

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

Oblig: No

Sintaxis de la respuesta

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationStatus": "string",
   "DashboardId": "string",
   "RequestId": "string",
   "Status": number,
   "VersionArn": "string"
}

Elementos de respuesta

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

El servicio devuelve los datos siguientes en formato JSON.

Arn

El nombre de recurso de Amazon (ARN) del recurso.

Type: Cadena

CreationStatus

El estado de creación de la solicitud.

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

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

Patrón: [\w\-]+

RequestId

LaAWSID de solicitud de esta operación.

Type: Cadena

Status

El estado HTTP de la solicitud.

Type: Entero

VersionArn

El ARN del panel, incluido el número de versión.

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

LimitExceededException

Se superó un límite.

Código de estado HTTP: 409

ResourceNotFoundException

No se encuentran 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: