Bekerja dengan topik QuickSight Q menggunakan Amazon QuickSight CLI - Amazon QuickSight

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Bekerja dengan topik QuickSight Q menggunakan Amazon QuickSight CLI

 Berlaku untuk: Enterprise Edition 
   Pemirsa yang dituju: QuickSight Pengembang Amazon 

Gunakan bagian ini untuk mempelajari cara bekerja dengan topik QuickSight Q menggunakan antarmuka baris QuickSight perintah Amazon (CLI).

Prasyarat

Sebelum memulai, pastikan bahwa Anda memiliki peran AWS Identity and Access Management (IAM) yang memberikan akses CLI pengguna untuk memanggil QuickSight API operasi. Tabel berikut menunjukkan izin mana yang harus ditambahkan ke IAM kebijakan untuk menggunakan API operasi tertentu. Untuk menggunakan semua API operasi topik Q, tambahkan semua izin yang tercantum dalam tabel.

APIoperasi IAMkebijakan

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

Contoh berikut menunjukkan IAM kebijakan yang memungkinkan pengguna untuk menggunakan ListTopics API operasi.

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

Bekerja dengan topik QuickSight Q menggunakan QuickSight CLI

Contoh berikut menciptakan topik Q baru.

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

Anda juga dapat membuat topik Q baru dengan menggunakan file CLI kerangka dengan perintah berikut. Untuk informasi selengkapnya tentang file CLI kerangka, lihat Menggunakan file CLI kerangka di Panduan QuickSight Pengembang Amazon.

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

Saat Anda membuat topik Q baru, konfigurasi penyegaran kumpulan data tidak disalin ke topik. Untuk mengatur jadwal penyegaran topik untuk topik baru, Anda dapat melakukan create-topic-refresh-schedule API panggilan. Untuk informasi selengkapnya tentang mengonfigurasi jadwal penyegaran topik denganCLI, lihat. Konfigurasikan jadwal penyegaran topik Q dengan QuickSight CLI

Setelah Anda membuat topik Q pertama Anda, Anda dapat memperbarui, menghapus, daftar, atau meminta ringkasan topik Q.

Contoh berikut memperbarui topik Q.

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

Anda juga dapat memperbarui topik Q dengan menggunakan file CLI kerangka dengan perintah berikut. Untuk informasi selengkapnya tentang file CLI kerangka, lihat Menggunakan file CLI kerangka di Panduan QuickSight Pengembang Amazon.

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

Contoh berikut menyediakan daftar semua topik Q dalam QuickSight akun.

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

Contoh berikut menghapus topik Q.

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

Contoh berikut memberikan informasi tentang bagaimana topik Q dikonfigurasi.

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

Perintah berikut memperbarui izin topik 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

Gunakan grant-permissions parameter untuk memberikan izin baca dan penulis kepada pengguna QuickSight akun. Untuk memberikan izin baca kepada pengguna akun, masukkan nilai berikut:"quicksight:DescribeTopic". Untuk memberikan izin kepada pengguna akun, masukkan nilai berikut:

  • "quicksight:DescribeTopic"

  • "quicksight:DescribeTopicRefresh"

  • "quicksight:ListTopicRefreshSchedules"

  • "quicksight:DescribeTopicRefreshSchedule"

  • "quicksight:DeleteTopic"

  • "quicksight:UpdateTopic"

  • "quicksight:CreateTopicRefreshSchedule"

  • "quicksight:DeleteTopicRefreshSchedule"

  • "quicksight:UpdateTopicRefreshSchedule"

  • "quicksight:DescribeTopicPermissions"

  • "quicksight:UpdateTopicPermissions"

RevokePermissionsParameter mencabut semua izin yang diberikan kepada pengguna akun.

Perintah berikut menjelaskan semua izin dari topik Q.

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

Konfigurasikan jadwal penyegaran topik Q dengan QuickSight CLI

Perintah berikut membuat jadwal penyegaran topik Q.

aws quicksight create-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-arn DATASETARN --refresh-schedule REFRESHSCHEDULE

Setelah membuat jadwal penyegaran untuk topik Q, Anda dapat memperbarui, menghapus, membuat daftar, atau meminta ringkasan jadwal penyegaran topik.

Perintah berikut memperbarui jadwal penyegaran topik Q.

aws quicksight update-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID --refresh-schedule REFRESHSCHEDULE

Contoh berikut menyediakan daftar semua jadwal refresh yang dikonfigurasi ke topik Q.

aws quicksight list-topic-refresh-schedules --aws-account-id AWSACCOUNTID --topic-id TOPICID

Contoh berikut menghapus jadwal penyegaran topik.

aws quicksight delete-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID

Contoh berikut memberikan informasi tentang bagaimana jadwal penyegaran topik dikonfigurasi.

aws quicksight describe-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID

Menyalin dan memigrasikan topik QuickSight Q di dalam dan di antara Akun AWS

Anda dapat memigrasikan topik QuickSight Q Anda dari satu akun ke akun lainnya dengan antarmuka baris QuickSight perintah (CLI). Alih-alih mereplikasi topik yang sama secara manual di beberapa dasbor, ruang nama, atau akun, Anda dapat menggunakannya QuickSight CLI untuk menggunakan kembali topik yang sama berulang kali. Kemampuan ini menghemat waktu QuickSight penulis dan menciptakan pengalaman topik standar untuk pembaca dasbor di beberapa dasbor.

Untuk memigrasikan topik Q dengan QuickSight CLI, gunakan prosedur berikut

Untuk memigrasikan topik Q ke akun lain
  1. Pertama, identifikasi topik yang ingin Anda migrasikan. Anda dapat melihat daftar setiap topik Q di QuickSight akun Anda dengan list-topics API perintah.

    aws quicksight list-topics --aws-account-id AWSACCOUNTID
  2. Setelah Anda memiliki daftar topik Q, cari topik yang ingin Anda migrasi dan lakukan describe-topic panggilan untuk menerima JSON struktur konfigurasi topik.

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

    Berikut ini adalah contoh describe-topic API respon.

    { "Status": 200, "TopicId": "TopicExample", "Arn": "string", "Topic": [ { "Name": "{}", "DataSets": [ { "DataSetArn": "{}", "DataSetName": "{}", "DataSetDescription": "{}", "DataAggregation": "{}", "Filters": [], "Columns": [], "CalculatedFields": [], "NamedEntities": [] } ] } ], "RequestId": "requestId" }
  3. Gunakan JSON respons untuk membuat file kerangka yang dapat Anda masukkan ke dalam create-topic panggilan baru di QuickSight akun Anda yang lain. Sebelum Anda melakukan API panggilan dengan file kerangka Anda, pastikan untuk mengubah Akun AWS ID dan ID kumpulan data dalam file kerangka agar sesuai dengan Akun AWS ID dan ID kumpulan data yang Anda tambahkan topik Q baru. Untuk informasi selengkapnya tentang file CLI kerangka, lihat Menggunakan file CLI kerangka di Panduan QuickSight Pengembang Amazon.

    aws quicksight create-topic --aws-account-id AWSACCOUNTID \ --cli-input-json file://./create-topic-cli-input.json

Setelah Anda melakukan create-topic panggilan ke QuickSight API, topik baru muncul di akun Anda. Untuk mengonfirmasi bahwa topik baru ada, lakukan list-topics panggilan ke QuickSight API. Jika topik sumber yang diduplikasi berisi jawaban terverifikasi, jawaban tidak dimigrasikan ke topik baru. Untuk melihat daftar semua jawaban terverifikasi yang dikonfigurasi ke topik asli, gunakan describe-topic API panggilan.