CreateDashboard - Amazon QuickSight
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursVoir aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

CreateDashboard

Crée un tableau de bord à partir d'un modèle Pour créer d'abord un modèle, reportez-vous à l'opération d'API CreateTemplate .

Un tableau de bord est une entité d'Amazon QuickSight qui identifie Amazon QuickSight rapports, créés à partir d'analyses. Vous pouvez partager Amazon QuickSight tableaux de bord. Avec les autorisations appropriées, vous pouvez créer des rapports par e-mail planifiés à partir des tableaux de bord. Si vous disposez des autorisations appropriées, vous pouvez créer un tableau de bord à partir d'un modèle existant dans un autre.AWS.

Syntaxe de la demande

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

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AwsAccountId

ID duAWScompte dans lequel vous souhaitez créer le tableau de bord.

Contraintes de longueur : Longueur fixe de 12.

Modèle : ^[0-9]{12}$

Obligatoire. Oui

DashboardId

ID pour le tableau de bord, également ajouté à la stratégie IAM.

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.

Modèle : [\w\-]+

Obligatoire. Oui

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

Name

Nom complet du tableau de bord.

Type : Chaîne

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.

Obligatoire. Oui

SourceEntity

L'entité que vous utilisez comme source lorsque vous créez le tableau de bord. DansSourceEntity, vous spécifiez le type d'objet que vous utilisez comme source. Vous ne pouvez créer un tableau de bord qu'à partir d'un modèle. Par conséquent, vous utilisez unSourceTemplateEntité. Si vous devez créer un tableau de bord à partir d'une analyse, convertissez d'abord l'analyse en modèle à l'aide de la commande CreateTemplate Opération d'API. PourSourceTemplate, spécifiez l'ARN (Amazon Resource Name) du modèle source. LeSourceTemplateL'ARN peut contenir n'importe quelAWScompte et n'importe quel compte Amazon QuickSight-pris en chargeRégion AWS.

Utilisation de l'DataSetReferencesentité au seinSourceTemplatepour répertorier les jeux de données de remplacement pour les espaces réservés répertoriés dans l'original. Le schéma de chaque jeu de données doit correspondre à son espace réservé.

Type : objet DashboardSourceEntity

Obligatoire. Oui

DashboardPublishOptions

Options de publication du tableau de bord lors de sa création :

  • AvailabilityStatuspourAdHocFilteringOption- Ce statut peut être l'un ou l'autreENABLEDouDISABLED. Lorsque cela est défini surDISABLED, Amazon QuickSight désactive le volet de filtre de gauche sur le tableau de bord publié, qui peut être utilisé pour le filtrage ad hoc (ponctuel). Cette option estENABLEDpar défaut.

  • AvailabilityStatuspourExportToCSVOption- Ce statut peut être l'un ou l'autreENABLEDouDISABLED. L'option visuelle d'exportation des données au format .CSV n'est pas activée lorsque cette option est définie surDISABLED. Cette option estENABLEDpar défaut.

  • VisibilityStatepourSheetControlsOption- Cet état de visibilité peut être soitCOLLAPSEDouEXPANDED. Cette option estCOLLAPSEDpar défaut.

Type : objet DashboardPublishOptions

Obligatoire. Non

Parameters

Les paramètres de création du tableau de bord, que vous souhaitez utiliser pour remplacer les paramètres par défaut. Un tableau de bord peut comporter n'importe quel type de paramètres, et certains paramètres peuvent accepter plusieurs valeurs.

Type : objet Parameters

Obligatoire. Non

Permissions

Structure contenant les autorisations du tableau de bord. Vous pouvez utiliser cette structure pour accorder des autorisations en fournissant une liste d'informations d'action IAM pour chaque ARN principal.

Pour ne spécifier aucune autorisation, omettez la liste des autorisations.

Type : Tableaux deResourcePermissionobjets

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 64 éléments.

Obligatoire. Non

Tags

Contient une carte des paires clé-valeur pour la ou les balises de ressource attribuées au tableau de bord.

Type : Tableaux deTagobjets

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 200 éléments.

Obligatoire. Non

ThemeArn

Amazon Resource Name (ARN) du thème utilisé pour ce tableau de bord. Si vous ajoutez une valeur pour ce champ, elle remplace la valeur utilisée dans l'entité source. L'ARN du thème doit exister dans le mêmeAWScompte sur lequel vous créez le tableau de bord.

Type : Chaîne

Obligatoire. Non

VersionDescription

Une description pour la première version du tableau de bord en cours de création.

Type : Chaîne

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 512.

Obligatoire. Non

Syntaxe de la réponse

HTTP/1.1 Status
Content-type: application/json

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

Eléments de réponse

Si l'action aboutit, le service renvoie la réponse HTTP suivante.

Status

Le statut HTTP de la requête.

Les données suivantes sont renvoyées au format JSON par le service.

Arn

L'ARN du tableau de bord.

Type : Chaîne

CreationStatus

Statut de la requête de création de tableau de bord.

Type : Chaîne

Valeurs valides : CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

DashboardId

ID pour le tableau de bord.

Type : Chaîne

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.

Modèle : [\w\-]+

RequestId

LeAWSID de la requête pour cette opération.

Type : Chaîne

VersionArn

L'ARN du tableau de bord, y compris le numéro de version de la première version créée.

Type : Chaîne

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, consultezErreurs courantes.

ConflictException

La mise à jour ou la suppression d'une ressource peut entraîner un état incohérent.

Code d'état HTTP : 409

InternalFailureException

Une défaillance interne s'est produite.

Code d'état HTTP : 500

InvalidParameterValueException

La valeur d'un ou de plusieurs paramètres n'est pas valide.

Code d'état HTTP : 400

ResourceExistsException

La ressource spécifiée existe déjà.

Code d'état HTTP : 409

ResourceNotFoundException

Une ou plusieurs ressources n'ont pas pu être trouvées.

Code d'état HTTP : 404

ThrottlingException

L'accès est limité.

Code d'état HTTP : 429

UnsupportedUserEditionException

Cette erreur indique que vous appelez une opération portant sur Amazon QuickSightabonnement dont l'édition n'inclut pas la prise en charge de cette opération. Amazon Amazon QuickSight Les éditions actuellement disponibles pour Standard Edition. Toutes les opérations et fonctionnalités ne sont pas disponibles dans chaque édition.

Code d'état HTTP : 403

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :