Lavora con argomenti QuickSight Q utilizzando l'Amazon QuickSight CLI

Si applica a: Enterprise Edition

Destinatari: QuickSight sviluppatori Amazon

Usa questa sezione per imparare a lavorare con gli argomenti QuickSight Q utilizzando l'interfaccia a riga di QuickSight comando (CLI) di Amazon.

Prerequisiti

Prima di iniziare, assicurati di disporre di un ruolo AWS Identity and Access Management (IAM) che conceda all'utente della CLI l'accesso per chiamare QuickSight le operazioni API. La tabella seguente mostra quali autorizzazioni devono essere aggiunte alla policy IAM per utilizzare operazioni API specifiche. Per utilizzare tutte le operazioni API dell'argomento Q, aggiungi tutte le autorizzazioni elencate nella tabella.

Operazione API	Policy 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

L'esempio seguente mostra una policy IAM che consente a un utente di utilizzare l'operazione API ListTopics.

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

Lavora con gli argomenti QuickSight Q usando la QuickSight CLI

Il seguente esempio crea un nuovo argomento Q.

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

È inoltre possibile aggiornare un nuovo argomento Q utilizzando un file scheletro della CLI con il seguente comando. Per ulteriori informazioni sui file scheletro della CLI, consulta Using CLI skeleton files nella Amazon Developer Guide. QuickSight

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

Quando crei un nuovo argomento Q, la configurazione di aggiornamento del set di dati non viene copiata nell'argomento. Per impostare una pianificazione di aggiornamento per il nuovo argomento, puoi effettuare una chiamata API create-topic-refresh-schedule. Per ulteriori informazioni sulla configurazione delle pianificazioni dell'aggiornamento degli argomenti con la CLI, consulta Configura le pianificazioni di aggiornamento degli argomenti Q con la CLI QuickSight .

Dopo aver creato il primo argomento Q, potrai aggiornare, eliminare, elencare o richiedere un riepilogo di un argomento Q.

Nell'esempio seguente viene aggiornato un argomento Q.

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

È inoltre possibile aggiornare un argomento Q utilizzando un file scheletro della CLI con il seguente comando. Per ulteriori informazioni sui file scheletro della CLI, consulta Using CLI skeleton files nella Amazon Developer Guide. QuickSight

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

L'esempio seguente fornisce un elenco di tutti gli argomenti Q in un account. QuickSight

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

L'esempio seguente mostra come eliminare un argomento Q.

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

L'esempio seguente fornisce informazioni su come è stata configurata la pianificazione dell'aggiornamento di un argomento.

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

Il comando seguente aggiorna le autorizzazioni di un argomento 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

Utilizzate il grant-permissions parametro per concedere le autorizzazioni di lettura e di autore agli utenti QuickSight dell'account. Per assegnare le autorizzazioni a un utente dell'account, immetti il seguente valore: "quicksight:DescribeTopic". Per assegnare le autorizzazioni a un utente dell'account, immetti i seguenti valori:

• "quicksight:DescribeTopic"

• "quicksight:DescribeTopicRefresh"

• "quicksight:ListTopicRefreshSchedules"

• "quicksight:DescribeTopicRefreshSchedule"

• "quicksight:DeleteTopic"

• "quicksight:UpdateTopic"

• "quicksight:CreateTopicRefreshSchedule"

• "quicksight:DeleteTopicRefreshSchedule"

• "quicksight:UpdateTopicRefreshSchedule"

• "quicksight:DescribeTopicPermissions"

• "quicksight:UpdateTopicPermissions"

Il parametro RevokePermissions revoca tutte le autorizzazioni concesse a un utente dell'account.

Il comando seguente descrive tutte le autorizzazioni da un argomento Q.

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

Configura le pianificazioni di aggiornamento degli argomenti Q con la CLI QuickSight

Il comando seguente crea una pianificazione di aggiornamento di un argomento Q.

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

Dopo aver creato una pianificazione di aggiornamento per un argomento Q, è possibile aggiornare, eliminare, elencare o richiedere un riepilogo della pianificazione di aggiornamento dell'argomento.

Il comando seguente aggiorna la pianificazione di aggiornamento di un argomento Q.

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

L'esempio seguente fornisce un elenco di tutte le pianificazioni di aggiornamento configurate per un argomento Q.

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

L'esempio seguente mostra come eliminare una pianificazione di aggiornamento degli argomenti.

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

L'esempio seguente fornisce informazioni su come è stata configurata la pianificazione dell'aggiornamento di un argomento.

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

Copia e migra gli argomenti QuickSight Q all'interno e tra Account AWS

Puoi migrare i tuoi argomenti QuickSight Q da un account all'altro con l'interfaccia a riga di QuickSight comando (CLI). Invece di replicare manualmente lo stesso argomento su più dashboard, namespace o account, puoi utilizzare la QuickSight CLI per riutilizzare lo stesso argomento più volte. Questa funzionalità consente QuickSight agli autori di risparmiare tempo e crea un'esperienza tematica standardizzata per i lettori dei dashboard su più dashboard.

Per migrare gli argomenti Q con la QuickSight CLI, utilizzare la seguente procedura

Migrazione di un argomento Q a un altro account

1. Innanzitutto, identifica l'argomento che desideri migrare. Puoi visualizzare un elenco di tutti gli argomenti Q del tuo QuickSight account con un comando list-topics API.

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

2. Dopo aver ottenuto un elenco di argomenti Q, individua l'argomento che desideri migrare ed effettua una chiamata describe-topic per ricevere una struttura JSON della configurazione dell'argomento.

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

   Di seguito è riportata un esempio di risposta API di describe-topic.

   {
       "Status": 200,
       "TopicId": "TopicExample", 
       "Arn": "string",
       "Topic": [
           {
               "Name": "{}",
               "DataSets": [
               {
               "DataSetArn": "{}",
               "DataSetName": "{}",
               "DataSetDescription": "{}",
               "DataAggregation": "{}",
               "Filters": [],
               "Columns": [],
               "CalculatedFields": [],
               "NamedEntities": []
               }
               ]
           }
       ],
       "RequestId": "requestId"
       }

3. Usa la risposta JSON per creare un file scheletro che puoi inserire in una nuova create-topic chiamata nell'altro QuickSight account. Prima di effettuare una chiamata API con il file scheletro, assicurati di modificare l'IDAccount AWS e l'ID del set di dati nel file scheletro in modo che corrispondano all'ID Account AWS e all'ID del set di dati a cui stai aggiungendo il nuovo argomento Q. Per ulteriori informazioni sui file scheletro della CLI, consulta Using CLI skeleton files nella Amazon Developer Guide. QuickSight

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

Dopo aver effettuato una create-topic chiamata all' QuickSight API, il nuovo argomento viene visualizzato nel tuo account. Per confermare l'esistenza del nuovo argomento, effettua una list-topics chiamata all' QuickSight API. Se l'argomento di origine che è stato duplicato contiene risposte verificate, le risposte non vengono migrate al nuovo argomento. Per visualizzare un elenco di tutte le risposte verificate configurate in base all'argomento originale, utilizza una chiamata API describe-topic.