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

CreateTemplate

Crea un modello da un'Amazon esistente QuickSight analisi o modello. È possibile utilizzare il modello risultante per creare un dashboard.

UNmodelloè un'entità in Amazon QuickSight che incapsula i metadati necessari per creare un'analisi e che è possibile utilizzare per creare il dashboard. Un modello aggiunge un livello di astrazione utilizzando i segnaposto per sostituire il set di dati associato all'analisi. È possibile utilizzare i modelli per creare dashboard sostituendo i segnaposto del set di dati con set di dati che seguono lo stesso schema utilizzato per creare l'analisi e il modello di origine.

Sintassi della richiesta

POST /accounts/AwsAccountId/templates/TemplateId HTTP/1.1
Content-type: application/json

{
   "Name": "string",
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "SourceEntity": { 
      "SourceAnalysis": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      },
      "SourceTemplate": { 
         "Arn": "string"
      }
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VersionDescription": "string"
}

Parametri della richiesta URI:

La richiesta utilizza i seguenti parametri URI.

AwsAccountId

L'ID delAWSconto in cui si trova il gruppo. Si utilizza l'ID perAWSaccount che contiene il tuo Amazon QuickSight conto.

Vincoli di lunghezza: Lunghezza fissa di 12.

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

Campo obbligatorio: Sì

TemplateId

Un ID per il modello da creare. Questo modello è unico perRegione AWS; in ciascunaAWSconto.

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.

SourceEntity

L'entità che si utilizza come origine quando si crea il modello. Nello statoSourceEntity, si specifica il tipo di oggetto che si sta utilizzando come origine:SourceTemplateper un modello oSourceAnalysisper un'analisi in. Entrambi richiedono l'Amazon Resource Name (ARN). PerSourceTemplate, specificare l'ARN del modello di origine. PerSourceAnalysis, specificare l'ARN dell'analisi dell'origine. LaSourceTemplateL'ARN può contenere qualsiasiAWSaccount e qualsiasi Amazon QuickSight-supportatoRegione AWS.

Utilizzo dell'DataSetReferencesentità all'internoSourceTemplateoSourceAnalysisper 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: TemplateSourceEntity oggetto

Campo obbligatorio: Sì

Name

Il nome visualizzato per il modello.

Type: Stringa

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

Campo obbligatorio: No

Permissions

Un elenco di autorizzazioni per le risorse da impostare sul modello.

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

Type: Matrice diTagoggetti

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

Campo obbligatorio: No

VersionDescription

Una descrizione della versione del modello corrente in fase di creazione. Questa operazione API crea la prima versione del modello. Ogni voltaUpdateTemplatesi chiama, viene creata una nuova versione. Ogni versione del modello conserva una descrizione della versione nellaVersionDescription.

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",
   "RequestId": "string",
   "TemplateId": "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 per il modello.

Type: Stringa

CreationStatus

Lo stato di creazione del modello.

Type: Stringa

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

RequestId

LaAWSID della richiesta per questa operazione.

Type: Stringa

TemplateId

L'ID del modello.

Type: Stringa

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

Modello: [\w\-]+

VersionArn

L'ARN per il modello, comprese le informazioni sulla versione della prima versione.

Type: Stringa

Errori

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

AccessDeniedException

Non hai l'accesso. Le credenziali fornite non possono essere convalidate. È possibile che non sei autorizzato a effettuare la richiesta. Assicurati che il tuo account sia autorizzato a utilizzare Amazon QuickSight , che le policy abbiano le autorizzazioni corrette e che siano utilizzate le chiavi di accesso corrette.

Codice di stato HTTP: 401

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

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