View a markdown version of this page

Amazon Quick Sight APIs - Amazon Quick

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

Amazon Quick Sight APIs

 適用対象: Enterprise Edition 
   対象者: Amazon Quick デベロッパー 

このセクションでは、Amazon Quick Sight コマンドラインインターフェイス (CLI) を使用して Quick Sight トピックを操作する方法について説明します。

前提条件

開始する前に、Quick Sight API オペレーションを呼び出すためのアクセスを CLI ユーザーに許可する AWS Identity and Access Management (IAM) ロールがあることを確認してください。次の表は、特定の API オペレーションを使用するために、IAM ポリシーに追加するべきアクセス許可を示しています。

API オペレーション: IAM ポリシー

CreateTopic

quicksight:CreateTopic

quicksight:PassDataSet

ListTopics

quicksight:ListTopics

DescribeTopic

quicksight:DescribeTopic

UpdateTopic

quicksight:UpdateTopic

quicksight:PassDataSet

DeleteTopic

quicksight:DeleteTopic

UpdateTopicPermissions

quicksight:UpdateTopicPermissions

DescribeTopicPermissions

quicksight:DescribeTopicPermissions

CreateTopicRefreshSchedule

quicksight:CreateTopicRefreshSchedule

ListTopicRefreshSchedules

quicksight:ListTopicRefreshSchedules

DescribeTopicRefreshSchedule

quicksight:DescribeTopicRefreshSchedule

UpdateTopicRefreshSchedule

quicksight:UpdateTopicRefreshSchedule

DeleteTopicRefreshSchedule

quicksight:DeleteTopicRefreshSchedule

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

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

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

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

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

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

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

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

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

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