APIサンプルについて

APIサンプルが掲載されているサイトはございますでしょうか。

公式ドキュメントは確認済みです。

例えばPrincipalのStringがなにを書けばよいのかわかりません。

@Kawaguchi さん、ご質問ありがとうございます。

APIの利用方法については参照いただいているAPIリファレンスか、各プログラミング言語向けのSDKのリファレンスをご覧いただければと思います。実例という形でのサンプルの記載はございませんが、構文の説明があるため基本的にそちらに従っていただければ問題無く利用いただけることを想定しています。

ご質問のDescribeFolderPermissionsのPrincipalについてはレスポンスの一部として返却されるものですので、リクエスト時に指定いただく必要はございません。ちなみに、Principalについては引用いただいたページのリンク先に説明されているように、ARNが返却されます。


リクエストについては、「リクエストの構文」配下に説明があるように、AwsAccountIdおよびFolderIdを記載いただくこととなります。AwsAccountIdはお使いのAWSアカウントの12桁のIDを、FolderIdについては権限を確認する対象のフォルダのIDを指定します。フォルダのIDはコンソール上で対象のフォルダを開くとURLバーで確認できます。

AWS CLIの場合には以下のようになります。

aws quicksight describe-folder-permissions --aws-account-id <AWSアカウントID 12桁> --folder-id <フォルダID>

ご回答ありがとうございます。

もう1点確認させてください。

UpdateFolderPermissions - Amazon Quick Sight のRequestのActionになにを記述したらよいのでしょうか。解説は以下となっており、わかりません。

Actions

アクセス許可を付与または取り消す対象の IAM アクション。

@Kawaguchi ご確認ありがとうございます。

フォルダに付与する権限の種別(Owner / Contributor / Viewer)に応じて以下を指定ください。

Owner

"Actions": [
    "quicksight:CreateFolder",
    "quicksight:DescribeFolder",
    "quicksight:UpdateFolder",
    "quicksight:DeleteFolder",
    "quicksight:CreateFolderMembership",
    "quicksight:DeleteFolderMembership",
    "quicksight:DescribeFolderPermissions",
    "quicksight:UpdateFolderPermissions"
]

Contributor

"Actions": [
    "quicksight:CreateFolder",
    "quicksight:DescribeFolder",
    "quicksight:CreateFolderMembership",
    "quicksight:DeleteFolderMembership",
    "quicksight:DescribeFolderPermissions"
]

Viewer

"Actions": [
    "quicksight:DescribeFolder"
]

※上記のIAMアクションの組み合わせは、手元環境でコンソールからOwner / Contributor / Viewerの権限を付与した際に自動で設定されているものを参考としています。
※各権限の違いについては以下の公式ドキュメントを参照ください。