QuickSight API を使用して QuickSight Q トピックを使用する

次の例では、新しい Q トピックを作成します。

aws quicksight create-topic
--aws-account-id AWSACCOUNTID
--topic-id TOPICID
--topic TOPIC

CLI スケルトンファイルと以下のコマンドを使用して、新しい Q トピックを作成することもできます。CLI スケルトンファイルの詳細については、「Amazon QuickSight デベロッパーガイド」の「Using CLI skeleton files」を参照してください。

aws quicksight create-topic
--cli-input-json file://createtopic.json

新しい Q トピックを作成する場合、データセットの更新設定はトピックにコピーされません。新しいトピックのトピック更新スケジュールを設定するために、create-topic-refresh-schedule API 呼び出しを実行できます。CLI を使用したトピック更新スケジュールの設定の詳細については、「QuickSight CLI を使用して QuickSight Q トピックの更新スケジュールを設定する」を参照してください。

最初の Q トピックを作成すると、Q トピックの更新、削除、一覧表示、または概要のリクエストを行うことができます。

次の例では、Q トピックを更新します。

aws quicksight update-topic
--aws-account-id AWSACCOUNTID
--topic-id TOPICID
--topic TOPIC

CLI スケルトンファイルと以下のコマンドを使用して、Q トピックを更新することもできます。CLI スケルトンファイルの詳細については、「Amazon QuickSight デベロッパーガイド」の「Using CLI skeleton files」を参照してください。

aws quicksight update-topic
--cli-input-json file://updatetopic.json

次の例では、QuickSight アカウント内のすべての Q トピックのリストを提供します。

aws quicksight list-topics 
--aws-account-id AWSACCOUNTID

次の例では、Q トピックを削除します。

aws quicksight delete-topic 
--aws-account-id AWSACCOUNTID 
--topic-id TOPICID

次の例では、Q トピックの設定方法に関する情報を提供します。

aws quicksight describe-topic 
--aws-account-id AWSACCOUNTID 
--topic-id TOPICID

次のコマンドは、Q トピックのアクセス許可を更新します。

aws quicksight update-topic-permissions
--aws-account-id AWSACCOUNTID
--topic-id TOPICID
--grant-permissions Principal=arn:aws:quicksight:us-east-1:AWSACCOUNTID:user/default/USERNAME,Actions=quicksight:DescribeTopic
--revoke-permissions Principal=arn:aws:quicksight:us-east-1:AWSACCOUNTID:user/default/USERNAME,Actions=quicksight:DescribeTopic

grant-permissions パラメータを使用して、QuickSight アカウントユーザーに読み取りと作成者の許可を付与します。アカウントユーザーに読み取り許可を付与するには、次の値を入力します: "quicksight:DescribeTopic" アカウントユーザーにアクセス許可を付与するには、次の値を入力します:

RevokePermissions パラメータは、アカウントユーザーに付与されているすべての許可を取り消します。

次のコマンドは、Q トピックのすべてのアクセス許可を記述します:

aws quicksight describe-topic-permissions 
--aws-account-id AWSACCOUNTID
--topic-id TOPICID

QuickSight Q トピックを作成したら、Amazon QuickSight API を使用してトピックの更新スケジュールの設定、アカウント内またはアカウント間での QuickSight Q トピックの移行、レビュー済みの回答の作成を行います。