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

CreateTheme

Crée un thème.

Un thème est un ensemble d'options de configuration pour la couleur et la mise en page. Les thèmes s'appliquent aux analyses et aux tableaux de bord. Pour de plus amples informations, veuillez consulterUtilisation de thèmes dans Amazon QuickSightdans leAmazon QuickSight Guide de l'utilisateur.

Syntaxe de la demande

POST /accounts/AwsAccountId/themes/ThemeId HTTP/1.1
Content-type: application/json

{
   "BaseThemeId": "string",
   "Configuration": { 
      "DataColorPalette": { 
         "Colors": [ "string" ],
         "EmptyFillColor": "string",
         "MinMaxGradient": [ "string" ]
      },
      "Sheet": { 
         "Tile": { 
            "Border": { 
               "Show": boolean
            }
         },
         "TileLayout": { 
            "Gutter": { 
               "Show": boolean
            },
            "Margin": { 
               "Show": boolean
            }
         }
      },
      "UIColorPalette": { 
         "Accent": "string",
         "AccentForeground": "string",
         "Danger": "string",
         "DangerForeground": "string",
         "Dimension": "string",
         "DimensionForeground": "string",
         "Measure": "string",
         "MeasureForeground": "string",
         "PrimaryBackground": "string",
         "PrimaryForeground": "string",
         "SecondaryBackground": "string",
         "SecondaryForeground": "string",
         "Success": "string",
         "SuccessForeground": "string",
         "Warning": "string",
         "WarningForeground": "string"
      }
   },
   "Name": "string",
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VersionDescription": "string"
}

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AwsAccountId

ID duAWScompte dans lequel vous souhaitez stocker le nouveau thème.

Contraintes de longueur : Longueur fixe : 12.

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

Obligatoire : Oui

ThemeId

Un ID pour le thème que vous souhaitez créer. L'ID du thème est unique parRégion AWSdans chaqueAWS.

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.

BaseThemeId

ID du thème duquel un thème personnalisé hérite. Tous les thèmes héritent de l'un des thèmes de départ définis par Amazon QuickSight. Pour obtenir la liste des thèmes de départ, utilisezListThemesou choisissezThemesdepuis l'intérieur d'une analyse.

Type : Chaîne

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

Modèle : [\w\-]+

Obligatoire : Oui

Configuration

Configuration du thème, qui contient les propriétés d'affichage du thème.

Type : objet ThemeConfiguration

Obligatoire : Oui

Name

Un nom complet pour le thème.

Type : Chaîne

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

Obligatoire : Oui

Permissions

Un groupe valide d'autorisations de ressources à appliquer au nouveau thème.

Type : Tableau deResourcePermissionobjets

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

Obligatoire : Non

Tags

Carte des paires clé-valeur pour la ou les balises de ressource que vous souhaitez ajouter à la ressource.

Type : Tableau deTagobjets

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

Obligatoire : Non

VersionDescription

Une description de la première version du thème que vous créez. À chaque foisUpdateThemeest appelée, une nouvelle version est créée. Chaque version du thème possède une description de la version dans leVersionDescription.

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",
   "RequestId": "string",
   "ThemeId": "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

ARN (Amazon Resource Name) du thème.

Type : Chaîne

CreationStatus

Le statut de création du thème.

Type : Chaîne

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

RequestId

LeAWSID de demande pour cette opération.

Type : Chaîne

ThemeId

ID du thème.

Type : Chaîne

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

Modèle : [\w\-]+

VersionArn

ARN (Amazon Resource Name) du nouveau thème.

Type : Chaîne

Erreurs

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

AccessDeniedException

Vous n'avez pas accès à cet élément. Les informations d'identification fournies n'ont pas pu être validées. Il est possible que vous ne soyez pas autorisé à effectuer la demande. Assurez-vous que votre compte est autorisé à utiliser Amazon QuickSight , que vos stratégies ont les autorisations appropriées et que vous utilisez les bonnes clés d'accès.

HTTP Status Code : 401

InternalFailureException

Une défaillance interne s'est produite.

HTTP Status Code : 500

InvalidParameterValueException

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

HTTP Status Code : 400

LimitExceededException

Une limite est dépassée.

HTTP Status Code : 409

ResourceExistsException

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

HTTP Status Code : 409

ResourceNotFoundException

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

HTTP Status Code : 404

ThrottlingException

L'accès est limité.

HTTP Status Code : 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 QuickSight est actuellement disponible pour les éditions Standard Edition et Enterprise Edition. Toutes les opérations et fonctionnalités ne sont pas disponibles dans chaque édition.

HTTP Status Code : 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 :