QuickSight API を使用して QuickSight スケーリングフォルダを作成する

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon QuickSight API を使用して、最大 3000 個の名前空間と共有できる特別なスケーリングフォルダを作成できます。フォルダに追加される各名前空間には、最大 100 のプリンシパルを含めることができます。プリンシパルはユーザーまたはユーザーグループです。スケーリングフォルダを作成し、必要なプリンシパルを追加すると、あらゆる QuickSight アセットをそのフォルダに追加できます。その後、フォルダプリンシパルが割り当てられている名前空間のすべてのプリンシパルと共有できます。これにより、QuickSight アセットを何千人ものユーザーと共有するプロセスが効率化されます。

スケーリングフォルダは、QuickSight API でのみ作成できます。スケーリングフォルダを作成すると、同じ名前空間の最大 100 のプリンシパルとフォルダを共有できます。UpdateFolderPermissions API 呼び出しを使用して、別の名前空間に属するプリンシパルを追加できます。フォルダを作成後、QuickSight API または QuickSight コンソールを使用してフォルダにアセットを追加することや、フォルダからアセットを削除することができます。

Amazon QuickSight の各アカウントには、スケーリングフォルダが 100 個あります。スケーリングフォルダには、最大 100 個のアセットを追加することができます。スケーリングフォルダを 3000 を超える名前空間と共有したい場合は、AWS サポートにお問い合わせください。

例

以下の例は、QuickSight API でスケーリングフォルダを作成する方法を示しています。

前提条件

開始する前に、API ユーザーに QuickSight API オペレーションを呼び出すためのアクセス権を付与する AWS Identity and Access Management ロールがあることを確認します。次の例は、スケーリングフォルダを作成、削除、または変更するために既存の IAM ロールに追加できる IAM ポリシーを示しています。サンプルポリシーを使用すると、ユーザーはダッシュボード、分析、データセットをスケーリングフォルダに追加できます。

{
    "Version": "2012-10-17",
    "Statement": [
        {
        "Effect": "Allow",
        "Action": [
            "quicksight:CreateFolder",
            "quicksight:CreateFolderMembership",
            "quicksight:DeleteFolderMembership",
            "quicksight:DeleteFolder",
            "quicksight:DescribeFolderPermissions",
            "quicksight:DescribeFolderResolvedPermissions",
            "quicksight:UpdateFolderPermissions",
            "quicksight:UpdateDashboardPermissions",
            "quicksight:UpdateAnalysisPermissions",
            "quicksight:UpdateDataSetPermissions"
        ],
        "Resource": "*"
        }
    ]
}

次の例では、スケーリングフォルダを作成する方法を示します。

aws quicksight create-folder \
--aws-account-id "AWSACCOUNTID" \
--region "us-east-1" \
--name "eastcoast-users" \
--sharing-model "NAMESPACE" \
--folder-id "eastcoast-users"

スケーリングフォルダを作成したら、そのフォルダをアカウントのプリンシパルと共有します。各 API 呼び出しでは、同じ名前空間内のユーザーとグループにのみ権限を付与または取り消すことができます。次の例では、スケーリングフォルダを、そのフォルダが存在する同じアカウントのユーザーと共有しています。

aws quicksight update-folder-permissions \
--aws-account-id "AWSACCOUNTID" \
--region "us-east-1" \
--folder-id "eastcoast-users" \
--grant-permissions \
    '[
        {"Actions":
            ["quicksight:DescribeFolder",
            "quicksight:UpdateFolder",
            "quicksight:DeleteFolder",
            "quicksight:DescribeFolderPermissions",
            "quicksight:UpdateFolderPermissions",
            "quicksight:CreateFolderMembership",
            "quicksight:DeleteFolderMembership",
            "quicksight:CreateFolder"
            ],
        "Principal":"arn:aws:quicksight:us-east-1:AWSACCOUNTID:user/default/my-user"
        }
    ]'

新しいプリンシパルとフォルダを共有後、describe-folder-permissions API 呼び出しで新しいフォルダの権限を検証します。

aws quicksight describe-folder-permissions \
--aws-account-id "AWSACCOUNTID" \
--region "us-east-1" \
--folder-id "eastcoast-users" \
--namespace "default"

新しいフォルダの権限を検証したら、スケーリングフォルダ内にサブフォルダを作成します。サブフォルダは、作成されたスケーリングフォルダの権限を継承します。

aws quicksight create-folder \
--aws-account-id "AWSACCOUNTID" \
--region "us-east-1" \
--name "new-york-users" \
--sharing-model "NAMESPACE" \
--folder-id "new-york-users" \
--parent-folder-arn "arn:aws:quicksight:us-east-1:AWSACCOUNTID:folder/eastcoast-users"

次の例では、新しいサブフォルダに継承された権限を検証します。

aws quicksight describe-folder-resolved-permissions \
--aws-account-id "AWSACCOUNTID" \
--region "us-east-1" \
--folder-id "new-york-users" \
--namespace "default"

サブフォルダの権限を検証後、共有するアセットをフォルダに追加します。サブフォルダにアセットを追加すると、そのアセットはサブフォルダを共有しているすべてのプリンシパルと共有されます。次の例では、ダッシュボードをサブフォルダに追加します。

aws quicksight create-folder-membership \
--aws-account-id "AWSACCOUNTID" \
--folder-id "new-york-users" \
--member-id "my-dashboard" \
--member-type "DASHBOARD" \
--region "us-east-1"