翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # 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 オペレーションを使用するには、表に記載されているすべてのアクセス許可を追加します。 | API オペレーション: | IAM ポリシー | | --- | --- | | `CreateTopic` | `quicksight:CreateTopic` `quicksight:PassDataSet` | | `ListTopics` | `quicksight:ListTopics` | | `DescribeTopic` | `quicksight:DescribeTopic` | | `DescribeTopicPermissions` | `quicksight:DescribeTopicPermissions` | | `DescribeTopicRefresh` | `quicksight:DescribeTopicRefresh` | | `DeleteTopic` | `quicksight:DeleteTopic` | | `UpdateTopic` | `quicksight:UpdateTopic` `quicksight:PassDataSet` | | `UpdateTopicPermissions` | `quicksight:UpdateTopicPermissions` | | `CreateTopicRefreshSchedule` | `quicksight:CreateTopicRefreshSchedule` | | `ListTopicRefreshSchedules` | `quicksight:ListTopicRefreshSchedules` | | `DescribeTopicRefreshSchedule` | `quicksight:DescribeTopicRefreshSchedule` | | `UpdateTopicRefreshSchedule` | `quicksight:UpdateTopicRefreshSchedule` | | `DeleteTopicRefreshSchedule` | `quicksight:DeleteTopicRefreshSchedule` | | `BatchCreateTopicReviewedAnswer` | `quicksight:BatchCreateTopicReviewedAnswer` | | `BatchDeleteTopicReviewedAnswer` | `quicksight:BatchDeleteTopicReviewedAnswer` | | `ListTopicReviewedAnswers` | `quicksight:ListTopicReviewedAnswers` | 次の例では、ユーザーに `ListTopics` API オペレーションの使用を許可する IAM ポリシーを示します。 ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "quicksight:ListTopics" ], "Resource": "*" } ] } ``` ------ Quick Sight APIs を使用して Quick Sight トピックを作成するアクセス許可を設定したら、次のトピックを使用して Quick Sight トピック APIs。 **Topics** + [Quick Sight APIs](topic-cli-examples.md) + [Quick Sight CLI を使用して Quick Sight トピックの更新スケジュールを設定する](topic-refresh-apis.md) + [Quick Sight トピックを 内および 間でコピーして移行する AWS アカウント](topic-cli-walkthroughs.md) + [Quick Sight APIs](topic-reviewed-answer-apis.md) # Quick Sight APIs 次の の例では、新しいトピックを作成します。 ``` aws quicksight create-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC ``` 次のコマンドで CLI スケルトンファイルを使用して、新しいトピックを作成することもできます。CLI スケルトンファイルの詳細については、*Amazon Quick Sight デベロッパーガイド*[の「CLI スケルトンファイル](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html)の使用」を参照してください。 ``` aws quicksight create-topic --cli-input-json file://createtopic.json ``` 新しいトピックを作成すると、データセットの更新設定はトピックにコピーされません。新しいトピックのトピック更新スケジュールを設定するために、`create-topic-refresh-schedule` API 呼び出しを実行できます。CLI を使用したトピック更新スケジュールの設定の詳細については、「[Quick Sight CLI を使用して Quick Sight トピックの更新スケジュールを設定する](topic-refresh-apis.md)」を参照してください。 最初のトピックを作成したら、トピックの概要を更新、削除、一覧表示、またはリクエストできます。 次の の例では、トピックを更新します。 ``` aws quicksight update-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC ``` 次のコマンドで CLI スケルトンファイルを使用してトピックを更新することもできます。CLI スケルトンファイルの詳細については、*Amazon Quick Sight デベロッパーガイド*[の「CLI スケルトンファイル](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html)の使用」を参照してください。 ``` aws quicksight update-topic --cli-input-json file://updatetopic.json ``` 次の の例では、クイックアカウントのすべてのトピックのリストを示します。 ``` 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 ``` 次のコマンドは、トピックのアクセス許可を更新します。 ``` 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:DescribeTopic"` アカウントユーザーにアクセス許可を付与するには、次の値を入力します: + `"quicksight:DescribeTopic"` + `"quicksight:DescribeTopicRefresh"` + `"quicksight:ListTopicRefreshSchedules"` + `"quicksight:DescribeTopicRefreshSchedule"` + `"quicksight:DeleteTopic"` + `"quicksight:UpdateTopic"` + `"quicksight:CreateTopicRefreshSchedule"` + `"quicksight:DeleteTopicRefreshSchedule"` + `"quicksight:UpdateTopicRefreshSchedule"` + `"quicksight:DescribeTopicPermissions"` + `"quicksight:UpdateTopicPermissions"` `RevokePermissions` パラメータは、アカウントユーザーに付与されているすべての許可を取り消します。 次のコマンドは、トピックからのすべてのアクセス許可を記述します。 ``` aws quicksight describe-topic-permissions --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` Quick Sight トピックを作成したら、Amazon Quick Sight APIs を使用して[トピックの更新スケジュールを設定し](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-refresh-apis)、[Quick Sight トピックをアカウント内またはアカウント間で移行](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-cli-walkthroughs)し、[レビュー済みの回答を作成できます](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-reviewed-answer-apis)。 # Quick Sight CLI を使用して Quick Sight トピックの更新スケジュールを設定する 次のコマンドは、トピックの更新スケジュールを作成します。 ``` aws quicksight create-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-arn DATASETARN --refresh-schedule REFRESHSCHEDULE ``` トピックの更新スケジュールを作成したら、トピックの更新スケジュールの更新、削除、一覧表示、または概要のリクエストを行うことができます。 次のコマンドは、トピックの更新スケジュールを更新します。 ``` aws quicksight update-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID --refresh-schedule REFRESHSCHEDULE ``` 次の の例では、トピックに設定されたすべての更新スケジュールのリストを示します。 ``` aws quicksight list-topic-refresh-schedules --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` 次の例では、トピック更新スケジュールを削除します。 ``` aws quicksight delete-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID ``` 次の例では、トピック更新スケジュールの設定方法に関する情報を提供します。 ``` aws quicksight describe-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID ``` # Quick Sight トピックを 内および 間でコピーして移行する AWS アカウント Quick Sight コマンドラインインターフェイス (CLI) を使用して、Quick Sight トピックをあるアカウントから別のアカウントに移行できます。複数のダッシュボード、名前空間、またはアカウントに同じトピックを手動でレプリケートする代わりに、Quick Sight CLI を使用して同じトピックを繰り返し再利用できます。この機能を使用すると、Quick Sight 作成者の時間を節約し、複数のダッシュボードにまたがるダッシュボードリーダー向けに標準化されたトピックエクスペリエンスを作成できます。 Quick Sight CLI を使用してトピックを移行するには、次の手順を使用します。 **トピックを別のアカウントに移行するには** 1. まず、移行するトピックを特定します。`list-topics` API コマンドを使用して、クイックアカウント内のすべてのトピックのリストを表示できます。 ``` aws quicksight list-topics --aws-account-id AWSACCOUNTID ``` 1. トピックのリストを取得したら、移行するトピックを見つけ、トピックの設定の JSON 構造を受信するための`describe-topic`呼び出しを行います。 ``` aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` `describe-topic` API レスポンスの例を次に示します。 ``` { "Status": 200, "TopicId": "TopicExample", "Arn": "string", "Topic": [ { "Name": "{}", "DataSets": [ { "DataSetArn": "{}", "DataSetName": "{}", "DataSetDescription": "{}", "DataAggregation": "{}", "Filters": [], "Columns": [], "CalculatedFields": [], "NamedEntities": [] } ] } ], "RequestId": "requestId" } ``` 1. JSON レスポンスを使用して、他のクイックアカウントの新しい`create-topic`呼び出しに入力できるスケルトンファイルを作成します。スケルトンファイルを使用して API コールを行う前に、新しいトピックを追加する AWS アカウント ID とデータセット ID と一致するように、スケルトンファイルの AWS アカウント ID とデータセット ID を変更してください。CLI スケルトンファイルの詳細については、*Amazon Quick Sight デベロッパーガイド*[の「CLI スケルトンファイル](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html)の使用」を参照してください。 ``` aws quicksight create-topic --aws-account-id AWSACCOUNTID \ --cli-input-json file://./create-topic-cli-input.json ``` Quick Sight API を`create-topic`呼び出すと、新しいトピックがアカウントに表示されます。新しいトピックが存在することを確認するには、Quick Sight API を`list-topics`呼び出します。複製されたソーストピックに検証済みの回答が含まれている場合、その回答は新しいトピックに移行されません。元のトピックに設定されている検証済みの回答すべてのリストを表示するには、`describe-topic` API コールを使用します。 # Quick Sight APIs Quick Sight トピックを作成したら、Quick Sight APIs を使用して、トピックの再開された回答を作成、一覧表示、更新、削除できます。 以下のコマンドは、Quick Sight トピックに対して最大 100 個のレビュー済み回答を作成します。 ``` aws quicksight batch-create-topic-reviewed-answer \ --topic-id TOPICID \ --aws-account-id AWSACCOUNTID \ —answers ANSWERS ``` 次のコマンドを使用して、CLI スケルトンファイルから複数のレビュー済みの回答を一括作成することもできます。CLI スケルトンファイルの詳細については、*Amazon Quick Sight デベロッパーガイド*[の「CLI スケルトンファイル](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html)の使用」を参照してください。 ``` aws quicksight batch-create-topic-reviewed-answer \ --cli-input-json file://createTopicReviewedAnswer.json ``` 以下のコマンドは、Quick Sight トピックでレビューされたすべての回答を一覧表示します。 ``` aws quicksight list-topic-reviewed-answers \ --aws-account-id AWSACCOUNTID \ --topic-id TOPICID \ ``` 次のバッチ例では、1 つのトピックから最大 100 件のレビュー済みの回答を削除します。 ``` aws quicksight batch-delete-topic-reviewed-answer \ --topic-id TOPICID \ --aws-account-id AWSACCOUNTID \ —answer-ids: ["AnswerId1, AnswerId2…"] ``` 次のコマンドを使用して、CLI スケルトンファイルから複数のレビュー済みの回答を一括作成することもできます。CLI スケルトンファイルの詳細については、*Amazon Quick Sight デベロッパーガイド*[の「CLI スケルトンファイル](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html)の使用」を参照してください。 ``` aws quicksight batch-delete-topic-reviewed-answer \ --cli-input-json file://deleteTopicReviewedAnswer.json ``` レビュー済みの回答を更新するには、 `batch-delete-topic-reviewed-answer` API を使用してトピックから既存の回答を削除します。次に、 `batch-create-topic-reviewed-answer` API を使用して、更新されたレビュー済みの回答をトピックに追加します。