UpdateDashboard - Amazon QuickSight
Sintassi della richiestaParametri della richiesta URI:Corpo della richiestaSintassi della rispostaElementi di rispostaErroriVedi anche

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

UpdateDashboard

Aggiorna un pannello di controllo in unAWSconto.

Nota

L'aggiornamento di un dashboard crea una nuova versione del dashboard ma non pubblica immediatamente la nuova versione. È possibile aggiornare la versione pubblicata di un pannello di controllo utilizzando il UpdateDashboardPublishedVersion Operazione API.

Sintassi della richiesta

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"
}

Parametri della richiesta URI:

La richiesta utilizza i seguenti parametri URI.

AwsAccountId

L'ID delAWSaccount che contiene la dashboard che stai aggiornando.

Vincoli di lunghezza: Lunghezza fissa di 12.

Modello: ^[0-9]{12}$

Campo obbligatorio: Sì

DashboardId

L'ID del pannello di controllo.

Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 2048 caratteri.

Modello: [\w\-]+

Campo obbligatorio: Sì

Corpo della richiesta

La richiesta accetta i seguenti dati in formato JSON.

Name

Il nome visualizzato del pannello di controllo.

Type: Stringa

Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 2048 caratteri.

Campo obbligatorio: Sì

SourceEntity

L'entità che si utilizza come origine quando si aggiorna il dashboard. Nello statoSourceEntity, si specifica il tipo di oggetto che si sta utilizzando come origine. Puoi aggiornare una dashboard solo da un modello, quindi utilizzi unSourceTemplateEntità. Se è necessario aggiornare un dashboard da un'analisi, convertire innanzitutto l'analisi in un modello utilizzando il CreateTemplate Operazione API. PerSourceTemplate, specifica l'Amazon Resource Name (ARN) del modello di origine. LaSourceTemplateL'ARN può contenere qualsiasiAWSaccount e qualsiasi Amazon QuickSight-supportatoRegione AWS.

Utilizzo dell'DataSetReferencesentità all'internoSourceTemplateper elencare i set di dati sostitutivi per i segnaposto elencati nell'originale. Lo schema in ogni set di dati deve corrispondere al relativo segnaposto.

Tipo: DashboardSourceEntity oggetto

Campo obbligatorio: Sì

DashboardPublishOptions

Opzioni per la pubblicazione della dashboard quando la si crea:

  • AvailabilityStatusperAdHocFilteringOption- questo stato può essereENABLEDoDISABLED. Quando questo è impostato suDISABLED, Amazon QuickSight disabilita il riquadro dei filtri sinistro sulla dashboard pubblicata, che può essere utilizzato per il filtraggio ad hoc (una tantum). Questa opzione èENABLEDper impostazione predefinita.

  • AvailabilityStatusperExportToCSVOption- questo stato può essereENABLEDoDISABLED. L'opzione visiva per esportare i dati nel formato .CSV non è abilitata quando è impostata suDISABLED. Questa opzione èENABLEDper impostazione predefinita.

  • VisibilityStateperSheetControlsOption- Questo stato di visibilità può essereCOLLAPSEDoEXPANDED. Questa opzione èCOLLAPSEDper impostazione predefinita.

Tipo: DashboardPublishOptions oggetto

Campo obbligatorio: No

Parameters

Una struttura che contiene i parametri del cruscotto. Si tratta di sostituzioni dei parametri per una dashboard. Una dashboard può avere qualsiasi tipo di parametro e alcuni parametri possono accettare più valori.

Tipo: Parameters oggetto

Campo obbligatorio: No

ThemeArn

L'Amazon Resource Name (ARN) del tema utilizzato per questo pannello di controllo. Se si aggiunge un valore per questo campo, il valore originariamente associato all'Entità sostituisce il valore originariamente associato all'Entità. Il tema ARN deve esistere nello stessoAWSaccount in cui si crea la dashboard.

Type: Stringa

Campo obbligatorio: No

VersionDescription

Una descrizione per la prima versione del pannello di controllo in fase di creazione.

Type: Stringa

Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 512 caratteri.

Campo obbligatorio: No

Sintassi della risposta

HTTP/1.1 200
Content-type: application/json

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

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

Arn

Il nome della risorsa Amazon (ARN) della risorsa .

Type: Stringa

CreationStatus

Lo stato della creazione della richiesta.

Type: Stringa

Valori validi: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

DashboardId

L'ID del pannello di controllo.

Type: Stringa

Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 2048 caratteri.

Modello: [\w\-]+

RequestId

LaAWSID della richiesta per questa operazione.

Type: Stringa

Status

Lo stato HTTP della richiesta.

Type: Numero intero

VersionArn

L'ARN del dashboard, incluso il numero di versione.

Type: Stringa

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

ConflictException

L'aggiornamento o l'eliminazione di una risorsa può causare uno stato incoerente.

Codice di stato HTTP: 409

InternalFailureException

Si è verificato un errore interno.

Codice di stato HTTP: 500

InvalidParameterValueException

Uno o più parametri hanno un valore non valido.

Codice di stato HTTP: 400

LimitExceededException

È stato superato un limite.

Codice di stato HTTP: 409

ResourceNotFoundException

Uno o più risorse non sono state trovate.

Codice di stato HTTP: 404

ThrottlingException

L'accesso è limitato.

Codice di stato HTTP: 429

UnsupportedUserEditionException

Questo errore indica che si sta chiamando un'operazione su Amazon QuickSightabbonamento in cui l'edizione non include il supporto per tale operazione. Amazon Amazon QuickSight attualmente ha Standard Edition ed Enterprise Edition. Non tutte le operazioni e funzionalità sono disponibili in ogni edizione.

Codice di stato HTTP: 403

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli SDK AWS specifici della lingua, consulta quanto segue: