Work with QuickSight Q topics using the Amazon QuickSight APIs - Amazon QuickSight

Work with QuickSight Q topics using the Amazon QuickSight APIs

 Applies to: Enterprise Edition 
   Intended audience: Amazon QuickSight developers 

Use this section to learn how to work with QuickSight Q topics using the Amazon QuickSight command line interface (CLI).

Prerequisites

Before you begin, make sure that you have an AWS Identity and Access Management (IAM) role that grants the CLI user access to call the QuickSight API operations. The following table shows which permissions must be added to the IAM policy to use specific API operations. To use all of the Q topic API operations, add all of the permissions listed in the table.

API operation IAM policy

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

The following example shows an IAM policy that allows a user to use the ListTopics API operation.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "quicksight:ListTopics"
            ],
            "Resource": "*"
        }
    ]
}

After you configure the permissions to create QuickSight Q topics with the QuickSight APIs, use the following topics to create and work with QuickSight Q topic APIs.

Topics