Einstellen eines Standarddesigns für Amazon-QuickSight-Analysen mit den QuickSight-APIs

Festlegen eines Standard-Themes mithilfe der API

1. Identifizieren Sie das benutzerdefinierte Theme, das Sie als Standard verwenden möchten, und suchen Sie nach seiner Theme-ID. Wenn Sie eines der QuickSight-Starter-Themes verwenden möchten, überspringen Sie diesen Schritt.

   Um die Theme-ID eines benutzerdefinierten Themes abzurufen, verwenden Sie den ListThemes-API-Vorgang für die Region, in der sich das Theme befindet. Stellen Sie sicher, dass sich das Theme in derselben Region befindet wie die Benutzer oder Gruppen, die es verwenden müssen.

   Das folgende Beispiel zeigt ein Shell-Skript, das den list-themes-Befehl in der AWS CLI verwendet. Es legt die AWS-Konto-ID und die AWS-Region als Variablen fest. Wenn Sie zuvor aws configure verwendet haben, um eine Standardregion festzulegen, setzt das Hinzufügen der Variable --region zu Ihrem Befehl Ihre Standardeinstellung außer Kraft.

   #declare variables
   awsacct1='111122223333'
   region='us-west-2'
   
   aws quicksight list-themes \
   --region $region \
   --aws-account-id $awsacct1 \
   --type 'CUSTOM'

2. Verwenden Sie den API-Vorgang ListUsers oder ListGroups, um die Amazon-Ressourcennamen (ARNs) für Benutzer oder Gruppen zu sammeln, die das Theme als Standard verwenden müssen. Sie benötigen nur den ARN der obersten Ebene. Wenn alle Ihre Benutzer derselben Gruppe angehören, verwenden Sie den Gruppen-ARN.

   Weitere Informationen zu QuickSight-ARNs finden Sie unter ARN-Formate in der Amazon-QuickSight-API-Referenz.

3. Wenn Sie ein benutzerdefiniertes Theme verwenden, gewähren Sie dem Theme Zugriff auf die ARNs, die Sie im vorherigen Schritt gesammelt haben. Wenn Sie ein Starter-Theme verwenden, überspringen Sie diesen Schritt, da alle Benutzer Zugriff auf Starter-Themes haben.

   Das folgende Beispiel zeigt ein Shell-Skript, das den Befehl update-theme-permissions verwendet. Der grant-permissions-Parameter wird in Kurzsyntax angezeigt. Sie können stattdessen JSON oder YAML verwenden. Weitere Informationen finden Sie unter Festlegen von Parameterwerten im AWS Command Line Interface-Benutzerleitfaden.

   #declare variables
   awsacct1='111122223333'
   namespace='default'
   region='us-west-2'
   theme-id='bdb844d0-0fe9-4d9d-b520-0fe602d93639' #Find this with list-themes
   
   aws quicksight update-theme-permissions \
   #Specify region if necessary: --region $region \
   --aws-account-id $awsacct1 \
   --theme-id $theme-id \
   --grant-permissions Principal="arn:aws:quicksight:$region:$awsacct1:group/$namespace/QuickSight_Group_Name",Actions="quicksight:DescribeTheme","quicksight:ListThemeVersions","quicksight:ListThemeAliases","quicksight:DescribeThemeAlias" 

4. Weisen Sie das Theme als Standard für denselben ARN oder dieselben ARNs zu.

   #declare variables
   awsacct1='111122223333'
   namespace='default'
   region='us-west-2'
   theme-id='bdb844d0-0fe9-4d9d-b520-0fe602d93639'
   
   aws quicksight create-account-customization \
   #Specify region if necessary: --region $region \
   --aws-account-id $awsacct1 \
   --namespace $namespace \
   --account-customization DefaultTheme="arn:aws:quicksight:$region:$awsacct1:theme/$theme-id"