CreateDashboard - 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à.

CreateDashboard

Crea un dashboard da un modello. Per creare un nuovo modello, vedere l'operazione API CreateTemplate .

Una dashboard è un'entità in Amazon QuickSight che identifica Amazon QuickSight report, creati dalle analisi. Puoi condividere Amazon QuickSight pannelli di controllo. Se si dispone delle autorizzazioni corrette, è possibile creare report e-mail pianificati a partire da essi. Se si dispone delle autorizzazioni corrette, è possibile creare un dashboard da un modello esistente in unAWSconto.

Sintassi della richiesta

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

Parametri della richiesta URI:

La richiesta utilizza i seguenti parametri URI.

AwsAccountId

L'ID delAWSaccount in cui desideri creare il pannello di controllo.

Vincoli di lunghezza: Lunghezza fissa di 12.

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

Campo obbligatorio: Sì

DashboardId

L'ID del dashboard, anch'esso aggiunto alla policy IAM.

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

Type: Stringa

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

Campo obbligatorio: Sì

SourceEntity

L'entità che stai utilizzando come origine quando crei il pannello di controllo. Nello statoSourceEntity, si specifica il tipo di oggetto che si sta utilizzando come origine. È possibile creare un pannello di controllo solo da un modello, quindi si utilizza unSourceTemplateEntità. Se è necessario creare un dashboard da un'analisi, convertire innanzitutto l'analisi in un modello utilizzando il CreateTemplate Operazione. 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 è impostatoDISABLED, 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 default.

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

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

Tipo: DashboardPublishOptions oggetto

Campo obbligatorio: No

Parameters

I parametri per la creazione della dashboard, che si desidera utilizzare per sovrascrivere le impostazioni predefinite. Una dashboard può avere qualsiasi tipo di parametro e alcuni parametri possono accettare più valori.

Tipo: Parameters oggetto

Campo obbligatorio: No

Permissions

Una struttura contenente le autorizzazioni del dashboard. È possibile utilizzare questa struttura per concedere le autorizzazioni fornendo un elenco di informazioni sulle azioni IAM per ogni ARN principale.

Per non specificare alcuna autorizzazione, omettere l'elenco delle autorizzazioni.

Type: Matrice diResourcePermissionoggetti

Membri dell'array: Numero minimo di 1 elemento. Numero massimo di 64 elementi.

Campo obbligatorio: No

Tags

Contiene una mappa delle coppie chiave-valore per il tag o i tag di risorsa assegnati alla dashboard.

Type: Matrice diTagoggetti

Membri dell'array: Numero minimo di 1 elemento. Numero massimo di 200 elementi.

Campo obbligatorio: No

ThemeArn

Amazon Resource Name (ARN) del tema utilizzato per questo dashboard. Se si aggiunge un valore per questo campo, il valore specificato sostituisce il valore utilizzato nell'entità di origine. 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 dashboard 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 Status
Content-type: application/json

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

Elementi di risposta

Se l'operazione riesce, il servizio restituisce la seguente risposta HTTP.

Status

Lo stato HTTP della richiesta.

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

Arn

L'ARN del dashboard.

Type: Stringa

CreationStatus

Stato della richiesta di creazione del dashboard.

Type: Stringa

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

DashboardId

L'ID del dashboard.

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

VersionArn

L'ARN della dashboard, incluso il numero di versione della prima versione creata.

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

ResourceExistsException

La risorsa specificata esiste già.

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 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: