DescribeTheme - Amazon QuickSight
Syntaxe de la demandeParamètres de demande URICorps de la requêteSyntaxe 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.

DescribeTheme

Décrit un thème.

Syntaxe de la demande

GET /accounts/AwsAccountId/themes/ThemeId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AliasName

Alias du thème que vous voulez décrire. Si vous nommez un alias spécifique, vous décrivez la version vers laquelle pointe l'alias. Vous pouvez spécifier la dernière version du thème en fournissant le mot-clé$LATESTdans leAliasName  Paramètre . Le mot$PUBLISHEDne s'applique pas aux thèmes.

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

Modèle : [\w\-]+|(\$LATEST)|(\$PUBLISHED)

AwsAccountId

ID duAWSqui contient le thème que vous décrivez.

Modèle : ^(aws|[0-9]{12})$

Obligatoire : Oui

ThemeId

ID du thème.

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

Modèle : [\w\-]+

Obligatoire : Oui

VersionNumber

Le numéro de version de la version à décrire. Si unVersionNumberLa valeur du paramètre n'est pas fournie, la dernière version du thème est décrite.

Plage valide Valeur minimale est 1.

Corps de la requête

La demande n'a pas de corps de requête.

Syntaxe de la réponse

HTTP/1.1 Status
Content-type: application/json

{
   "RequestId": "string",
   "Theme": { 
      "Arn": "string",
      "CreatedTime": number,
      "LastUpdatedTime": number,
      "Name": "string",
      "ThemeId": "string",
      "Type": "string",
      "Version": { 
         "Arn": "string",
         "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"
            }
         },
         "CreatedTime": number,
         "Description": "string",
         "Errors": [ 
            { 
               "Message": "string",
               "Type": "string"
            }
         ],
         "Status": "string",
         "VersionNumber": number
      }
   }
}

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.

RequestId

LeAWSID de demande pour cette opération.

Type : Chaîne

Theme

Les informations sur le thème que vous décrivez.

Type : objet Theme

Erreurs

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

AccessDeniedException

Vous n'avez pas accès à cet article. 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.

Code d'état HTTP Code Code Code 401

InternalFailureException

Une défaillance interne s'est produite.

Code d'état HTTP Code Code Code 500

InvalidParameterValueException

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

Code d'état HTTP Code Code Code 400

ResourceExistsException

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

Code d'état HTTP Code Code Code 409

ResourceNotFoundException

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

Code d'état HTTP Code Code Code 404

ThrottlingException

L'accès est limité.

Code d'état HTTP Code Code Code 429

UnsupportedUserEditionException

Cette erreur indique que vous appelez une opération 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 et Enterprise Edition. Toutes les opérations et fonctionnalités ne sont pas disponibles dans chaque édition.

Code d'état HTTP Code Code 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 :