Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Travaillez avec des sujets QuickSight Q à l'aide d'Amazon QuickSight CLI
S'applique à : édition Enterprise |
Public cible : QuickSight développeurs Amazon |
Utilisez cette section pour apprendre à travailler avec les sujets QuickSight Q à l'aide de l'interface de ligne de QuickSight commande Amazon (CLI).
Prérequis
Avant de commencer, assurez-vous que vous disposez d'un rôle AWS Identity and Access Management (IAM) qui autorise l'CLIutilisateur à appeler les QuickSight API opérations. Le tableau suivant indique les autorisations qui doivent être ajoutées à la IAM politique pour utiliser des API opérations spécifiques. Pour utiliser toutes les API opérations du sujet Q, ajoutez toutes les autorisations répertoriées dans le tableau.
APIopération | IAMpolitique |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
L'exemple suivant montre une IAM politique qui permet à un utilisateur d'utiliser l'ListTopics
APIopération.
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "quicksight:ListTopics" ], "Resource": "*" } ] }
Travaillez avec les sujets QuickSight Q à l'aide du QuickSight CLI
L'exemple suivant crée une nouvelle rubrique Q.
aws quicksight create-topic --aws-account-id
AWSACCOUNTID
--topic-idTOPICID
--topicTOPIC
Vous pouvez également créer un nouveau sujet Q en utilisant un fichier CLI squelette avec la commande suivante. Pour plus d'informations sur les fichiers CLI squelettes, consultez la section Utilisation des fichiers CLI squelettes dans le manuel Amazon QuickSight Developer Guide.
aws quicksight create-topic --cli-input-json file://createtopic.json
Lorsque vous créez une nouvelle rubrique Q, la configuration de rafraîchissement du jeu de données n'est pas copiée dans la rubrique. Pour définir un calendrier d'actualisation pour votre nouveau sujet, vous pouvez passer un create-topic-refresh-schedule
API appel. Pour plus d'informations sur la configuration des programmes d'actualisation des rubriques à l'aide duCLI, consultezConfigurez les programmes d'actualisation des rubriques Q à l'aide du QuickSight CLI.
Après avoir créé votre première rubrique Q, vous pouvez mettre à jour, supprimer, répertorier ou demander un résumé d'une rubrique Q.
L'exemple suivant met à jour une rubrique Q.
aws quicksight update-topic --aws-account-id
AWSACCOUNTID
--topic-idTOPICID
--topicTOPIC
Vous pouvez également mettre à jour une rubrique Q en utilisant un fichier CLI squelette à l'aide de la commande suivante. Pour plus d'informations sur les fichiers CLI squelettes, consultez la section Utilisation des fichiers CLI squelettes dans le manuel Amazon QuickSight Developer Guide.
aws quicksight update-topic --cli-input-json file://updatetopic.json
L'exemple suivant fournit une liste de tous les sujets Q d'un QuickSight compte.
aws quicksight list-topics --aws-account-id
AWSACCOUNTID
L'exemple suivant supprime une rubrique Q.
aws quicksight delete-topic --aws-account-id
AWSACCOUNTID
--topic-idTOPICID
L'exemple suivant fournit des informations sur la configuration d'une rubrique Q.
aws quicksight describe-topic --aws-account-id
AWSACCOUNTID
--topic-idTOPICID
La commande suivante met à jour les autorisations d'une rubrique Q.
aws quicksight update-topic-permissions --aws-account-id
AWSACCOUNTID
--topic-idTOPICID
--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
Utilisez le grant-permissions
paramètre pour accorder des autorisations de lecture et de création aux utilisateurs QuickSight du compte. Pour accorder des autorisations de lecture à un utilisateur de compte, saisissez la valeur suivante : "quicksight:DescribeTopic"
. Pour accorder des autorisations à un utilisateur de compte, entrez les valeurs suivantes :
-
"quicksight:DescribeTopic"
-
"quicksight:DescribeTopicRefresh"
-
"quicksight:ListTopicRefreshSchedules"
-
"quicksight:DescribeTopicRefreshSchedule"
-
"quicksight:DeleteTopic"
-
"quicksight:UpdateTopic"
-
"quicksight:CreateTopicRefreshSchedule"
-
"quicksight:DeleteTopicRefreshSchedule"
-
"quicksight:UpdateTopicRefreshSchedule"
-
"quicksight:DescribeTopicPermissions"
-
"quicksight:UpdateTopicPermissions"
Le paramètre RevokePermissions
révoque toutes les autorisations accordées à un utilisateur de compte.
La commande suivante décrit toutes les autorisations d'une rubrique Q.
aws quicksight describe-topic-permissions --aws-account-id
AWSACCOUNTID
--topic-idTOPICID
Configurez les programmes d'actualisation des rubriques Q à l'aide du QuickSight CLI
La commande suivante crée une planification de rafraîchissement d'une rubrique Q.
aws quicksight create-topic-refresh-schedule --aws-account-id
AWSACCOUNTID
--topic-idTOPICID
--dataset-arnDATASETARN
--refresh-scheduleREFRESHSCHEDULE
Après avoir créé une planification de rafraîchissement pour une rubrique Q, vous pouvez mettre à jour, supprimer, répertorier ou demander un résumé du programme d'actualisation de la rubrique.
La commande suivante met à jour le programme d'actualisation d'une rubrique Q.
aws quicksight update-topic-refresh-schedule --aws-account-id
AWSACCOUNTID
--topic-idTOPICID
--dataset-idDATASETID
--refresh-scheduleREFRESHSCHEDULE
L'exemple suivant fournit une liste de tous les programmes d'actualisation configurés pour une rubrique Q.
aws quicksight list-topic-refresh-schedules --aws-account-id
AWSACCOUNTID
--topic-idTOPICID
L'exemple suivant supprime un programme d'actualisation d'une rubrique.
aws quicksight delete-topic-refresh-schedule --aws-account-id
AWSACCOUNTID
--topic-idTOPICID
--dataset-idDATASETID
L'exemple suivant fournit des informations sur la configuration d'un programme d'actualisation de rubrique.
aws quicksight describe-topic-refresh-schedule --aws-account-id
AWSACCOUNTID
--topic-idTOPICID
--dataset-idDATASETID
Copier et migrer les sujets QuickSight Q dans et entre Comptes AWS
Vous pouvez migrer vos sujets QuickSight Q d'un compte à un autre à l'aide de l'interface de ligne de QuickSight commande (CLI). Au lieu de répliquer manuellement le même sujet sur plusieurs tableaux de bord, espaces de noms ou comptes, vous pouvez utiliser le QuickSight CLI pour réutiliser le même sujet à plusieurs reprises. Cette fonctionnalité permet aux QuickSight auteurs de gagner du temps et de créer une expérience thématique standardisée pour les lecteurs de tableaux de bord sur plusieurs tableaux de bord.
Pour migrer les sujets Q avec le QuickSight CLI, procédez comme suit
Pour migrer une rubrique Q vers un autre compte
-
Commencez par identifier la rubrique que vous voulez migrer. Vous pouvez consulter la liste de tous les sujets Q de votre QuickSight compte à l'aide d'une
list-topics
API commande.aws quicksight list-topics --aws-account-id
AWSACCOUNTID
-
Une fois que vous avez une liste de sujets Q, localisez le sujet que vous souhaitez migrer et passez un
describe-topic
appel pour recevoir une JSON structure de configuration du sujet.aws quicksight describe-topic --aws-account-id
AWSACCOUNTID
--topic-idTOPICID
Voici un exemple de
describe-topic
API réponse.{ "Status": 200, "TopicId": "TopicExample", "Arn": "string", "Topic": [ { "Name": "{}", "DataSets": [ { "DataSetArn": "{}", "DataSetName": "{}", "DataSetDescription": "{}", "DataAggregation": "{}", "Filters": [], "Columns": [], "CalculatedFields": [], "NamedEntities": [] } ] } ], "RequestId": "requestId" }
-
Utilisez la JSON réponse pour créer un fichier squelette que vous pouvez saisir lors d'un nouvel
create-topic
appel dans votre autre QuickSight compte. Avant de passer un API appel avec votre fichier squelette, assurez-vous de modifier l' Compte AWS ID et l'ID du jeu de données dans le fichier squelette pour qu'ils correspondent à l' Compte AWS ID et à l'ID du jeu de données auxquels vous ajoutez la nouvelle rubrique Q. Pour plus d'informations sur les fichiers CLI squelettes, consultez la section Utilisation des fichiers CLI squelettes dans le manuel Amazon QuickSight Developer Guide.aws quicksight create-topic --aws-account-id
AWSACCOUNTID
\ --cli-input-jsonfile://./create-topic-cli-input.json
Après avoir create-topic
appelé le QuickSight API, le nouveau sujet apparaît dans votre compte. Pour vérifier que le nouveau sujet existe, list-topics
appelez le QuickSight API. Si la rubrique source qui a été dupliquée contient des réponses vérifiées, celles-ci ne sont pas migrées vers la nouvelle rubrique. Pour voir la liste de toutes les réponses vérifiées configurées pour le sujet d'origine, utilisez un describe-topic
API appel.