QuickSight API で Amazon QuickSight 分析のデフォルトテーマを設定する

API を使用してデフォルトのテーマを設定するには

1. デフォルトとして使用するカスタムテーマを特定し、テーマ ID を検索します。QuickSight スターターテーマのいずれかを使用する場合は、この手順を省略してください。

   カスタムテーマのテーマ ID を取得するには、そのテーマがあるリージョンの ListThemes API オペレーションを使用します。テーマが、そのテーマを使用する必要があるユーザーまたはグループと同じリージョンにあることを確認します。

   AWS CLI で list-themes コマンドを実行するシェルスクリプトの例を以下に示します。これは、変数として AWS アカウント ID と AWS リージョン を変数として設定します。以前、リージョンのデフォルトの設定に aws configure を使用していた場合は、--region 変数をコマンドに追加すると、デフォルトの設定が上書きされます。

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

2. ListUsers または ListGroups API オペレーションを使用して、テーマをデフォルトとして使用する必要があるユーザーまたはグループ向けの Amazon リソースネーム (ARN) を収集します。トップレベルの ARN のみが必要です。すべてのユーザーが同じグループに属している場合は、グループ ARN を使用します。

   QuickSight ARN の詳細については、「Amazon QuickSight API Reference」(Amazon QuickSight API リファレンス) の「ARN formats」(ARN 形式) を参照してください。

3. カスタムテーマを使用している場合は、前のステップで収集した ARN のテーマへのアクセス権を付与します。スターターテーマを使用している場合は、すべてのユーザーがスターターテーマにアクセスできるため、この手順をスキップしてください。

   update-theme-permissions コマンドを使用するシェルスクリプトの例を以下に示します。grant-permissions パラメータは、短縮構文を使用して表示されます。代わりに JSON または YAML を使用できます。詳細については、「AWS Command Line Interface ユーザーガイド」の「パラメータ値の指定」を参照してください。

   #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. 同じ ARN または ARN のデフォルトとしてテーマを割り当てます。

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