Work with Quick Sight Topics using the Amazon Quick Sight APIs

Use this section to learn how to work with Quick Sight Topics using the Amazon Quick Sight 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 Quick Sight API operations. The following table shows which permissions must be added to the IAM policy to use specific API operations.

The following example creates a new Topic.

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

The following example updates a Topic.

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

The following example provides a list of all Topics in an account.

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

The following example deletes a Topic.

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

The following example provides information about how a Topic was configured.

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