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 sur des sujets Quick Sight à l'aide d'Amazon Quick Sight APIs | | | --- | |  S’applique à : édition Enterprise  | | | | --- | |    Public cible : développeurs Amazon Quick  | Utilisez cette section pour apprendre à utiliser les rubriques Quick Sight à l'aide de l'interface de ligne de commande (CLI) Amazon Quick Sight. **Conditions préalables** Avant de commencer, assurez-vous que vous disposez d'un rôle Gestion des identités et des accès AWS (IAM) qui autorise l'utilisateur de la CLI à appeler les opérations de l'API Quick Sight. Le tableau suivant indique les autorisations qui doivent être ajoutées à la politique IAM pour utiliser des opérations d’API spécifiques. Pour utiliser toutes les opérations d'API de la rubrique, ajoutez toutes les autorisations répertoriées dans le tableau. | Opération API | Politique 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` | | `BatchCreateTopicReviewedAnswer` | `quicksight:BatchCreateTopicReviewedAnswer` | | `BatchDeleteTopicReviewedAnswer` | `quicksight:BatchDeleteTopicReviewedAnswer` | | `ListTopicReviewedAnswers` | `quicksight:ListTopicReviewedAnswers` | L’exemple suivant montre une politique IAM qui permet à un utilisateur d’utiliser l’opération d’API `ListTopics`. ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "quicksight:ListTopics" ], "Resource": "*" } ] } ``` ------ Après avoir configuré les autorisations pour créer des rubriques Quick Sight avec Quick Sight APIs, utilisez les rubriques suivantes pour créer et utiliser des rubriques Quick Sight APIs. **Topics** + [Travaillez avec les sujets de Quick Sight à l'aide du Quick Sight APIs](topic-cli-examples.md) + [Configurer les programmes d'actualisation des rubriques de Quick Sight à l'aide de la CLI Quick Sight](topic-refresh-apis.md) + [Copier et migrer les rubriques Quick Sight au sein et entre les deux Comptes AWS](topic-cli-walkthroughs.md) + [Créez et modifiez des réponses révisées dans les rubriques de Quick Sight avec le Quick Sight APIs](topic-reviewed-answer-apis.md) # Travaillez avec les sujets de Quick Sight à l'aide du Quick Sight APIs L'exemple suivant crée un nouveau sujet. ``` aws quicksight create-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC ``` Vous pouvez également créer une nouvelle rubrique en utilisant un fichier squelette CLI avec la commande suivante. Pour plus d'informations sur les fichiers de squelette de la CLI, consultez la section [Utilisation des fichiers de squelette de la CLI](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) dans le manuel *Amazon Quick Sight Developer Guide*. ``` aws quicksight create-topic --cli-input-json file://createtopic.json ``` Lorsque vous créez une nouvelle rubrique, la configuration d'actualisation du jeu de données n'est pas copiée dans la rubrique. Pour définir un calendrier de rafraîchissement des rubriques pour votre nouvelle rubrique, vous pouvez effectuer un appel d’API `create-topic-refresh-schedule`. Pour plus d’informations sur la configuration des calendriers de rafraîchissement des rubriques avec la CLI, consultez la rubrique [Configurer les programmes d'actualisation des rubriques de Quick Sight à l'aide de la CLI Quick Sight](topic-refresh-apis.md). Après avoir créé votre premier sujet, vous pouvez le mettre à jour, le supprimer, le répertorier ou demander un résumé d'un sujet. L'exemple suivant met à jour une rubrique. ``` aws quicksight update-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC ``` Vous pouvez également mettre à jour une rubrique à l'aide d'un fichier squelette de la CLI avec la commande suivante. Pour plus d'informations sur les fichiers de squelette de la CLI, consultez la section [Utilisation des fichiers de squelette de la CLI](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) dans le manuel *Amazon Quick Sight Developer Guide*. ``` aws quicksight update-topic --cli-input-json file://updatetopic.json ``` L'exemple suivant fournit une liste de toutes les rubriques d'un compte Quick. ``` aws quicksight list-topics --aws-account-id AWSACCOUNTID ``` L'exemple suivant supprime une rubrique. ``` aws quicksight delete-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` L'exemple suivant fournit des informations sur la façon dont une rubrique a été configurée. ``` aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` La commande suivante met à jour les autorisations d'une rubrique. ``` 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 ``` Utilisez le `grant-permissions` paramètre pour accorder des autorisations de lecture et de création aux utilisateurs du compte Quick. 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 associées à une rubrique. ``` aws quicksight describe-topic-permissions --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` Après avoir créé un sujet Quick Sight, vous pouvez utiliser Amazon Quick Sight APIs pour [configurer un calendrier d'actualisation des sujets](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-refresh-apis), [migrer les sujets Quick Sight au sein de comptes ou entre](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-cli-walkthroughs) eux, et [créer des réponses révisées](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-reviewed-answer-apis). # Configurer les programmes d'actualisation des rubriques de Quick Sight à l'aide de la CLI Quick Sight La commande suivante crée un calendrier d'actualisation d'une rubrique. ``` aws quicksight create-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-arn DATASETARN --refresh-schedule REFRESHSCHEDULE ``` Après avoir créé un calendrier d'actualisation pour un sujet, vous pouvez le mettre à jour, le supprimer, le répertorier ou demander un résumé du calendrier d'actualisation du sujet. La commande suivante met à jour le calendrier d'actualisation d'une rubrique. ``` aws quicksight update-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID --refresh-schedule REFRESHSCHEDULE ``` L'exemple suivant fournit une liste de toutes les programmations d'actualisation configurées pour une rubrique. ``` aws quicksight list-topic-refresh-schedules --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` L’exemple suivant supprime un programme d’actualisation d’une rubrique. ``` aws quicksight delete-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID ``` 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-id TOPICID --dataset-id DATASETID ``` # Copier et migrer les rubriques Quick Sight au sein et entre les deux Comptes AWS Vous pouvez migrer vos sujets Quick Sight d'un compte à un autre à l'aide de l'interface de ligne de commande (CLI) de Quick Sight. Au lieu de répliquer manuellement le même sujet sur plusieurs tableaux de bord, espaces de noms ou comptes, vous pouvez utiliser la CLI Quick Sight pour réutiliser le même sujet à plusieurs reprises. Cette fonctionnalité permet aux auteurs de Quick Sight 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 des rubriques à l'aide de la CLI Quick Sight, procédez comme suit **Pour migrer un sujet vers un autre compte** 1. Commencez par identifier la rubrique que vous voulez migrer. Vous pouvez consulter la liste de tous les sujets de votre compte Quick à l'aide d'une commande `list-topics` API. ``` aws quicksight list-topics --aws-account-id AWSACCOUNTID ``` 1. Une fois que vous avez une liste de sujets, localisez le sujet que vous souhaitez migrer et passez un `describe-topic` appel pour recevoir une structure JSON de configuration du sujet. ``` aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` Vous trouverez ci-dessous un exemple de réponse `describe-topic` de l’API. ``` { "Status": 200, "TopicId": "TopicExample", "Arn": "string", "Topic": [ { "Name": "{}", "DataSets": [ { "DataSetArn": "{}", "DataSetName": "{}", "DataSetDescription": "{}", "DataAggregation": "{}", "Filters": [], "Columns": [], "CalculatedFields": [], "NamedEntities": [] } ] } ], "RequestId": "requestId" } ``` 1. Utilisez la réponse JSON pour créer un fichier squelette que vous pouvez saisir lors d'un nouvel `create-topic` appel dans votre autre compte Quick. Avant d'effectuer un appel d'API 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 le nouveau sujet. Pour plus d'informations sur les fichiers de squelette de la CLI, consultez la section [Utilisation des fichiers de squelette de la CLI](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) dans le manuel *Amazon Quick Sight Developer Guide*. ``` aws quicksight create-topic --aws-account-id AWSACCOUNTID \ --cli-input-json file://./create-topic-cli-input.json ``` Après avoir `create-topic` appelé l'API Quick Sight, le nouveau sujet apparaît dans votre compte. Pour vérifier que le nouveau sujet existe, `list-topics` appelez l'API Quick Sight. 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 afficher une liste de toutes les réponses vérifiées qui sont configurées pour la rubrique d'origine, utilisez un appel d'API `describe-topic`. # Créez et modifiez des réponses révisées dans les rubriques de Quick Sight avec le Quick Sight APIs Après avoir créé un sujet Quick Sight, vous pouvez utiliser le Quick Sight APIs pour créer, répertorier, mettre à jour et supprimer les réponses révisées pour les sujets. La commande ci-dessous crée par lots jusqu'à 100 réponses révisées pour un sujet de Quick Sight. ``` aws quicksight batch-create-topic-reviewed-answer \ --topic-id TOPICID \ --aws-account-id AWSACCOUNTID \ —answers ANSWERS ``` Vous pouvez également créer par lots des réponses révisées à partir d’un fichier squelette CLI à l’aide de la commande suivante. Pour plus d'informations sur les fichiers de squelette de la CLI, consultez la section [Utilisation des fichiers de squelette de la CLI](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) dans le manuel *Amazon Quick Sight Developer Guide*. ``` aws quicksight batch-create-topic-reviewed-answer \ --cli-input-json file://createTopicReviewedAnswer.json ``` La commande ci-dessous répertorie toutes les réponses révisées dans une rubrique Quick Sight. ``` aws quicksight list-topic-reviewed-answers \ --aws-account-id AWSACCOUNTID \ --topic-id TOPICID \ ``` L’exemple ci-dessous supprime par lots jusqu’à 100 réponses révisées d’une rubrique. ``` aws quicksight batch-delete-topic-reviewed-answer \ --topic-id TOPICID \ --aws-account-id AWSACCOUNTID \ —answer-ids: ["AnswerId1, AnswerId2…"] ``` Vous pouvez également créer par lots des réponses révisées à partir d’un fichier squlette CLI à l’aide de la commande suivante. Pour plus d'informations sur les fichiers de squelette de la CLI, consultez la section [Utilisation des fichiers de squelette de la CLI](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) dans le manuel *Amazon Quick Sight Developer Guide*. ``` aws quicksight batch-delete-topic-reviewed-answer \ --cli-input-json file://deleteTopicReviewedAnswer.json ``` Pour mettre à jour une réponse révisée, supprimez la réponse existante de la rubrique à l’aide de l’API `batch-delete-topic-reviewed-answer`. Utilisez ensuite l’API `batch-create-topic-reviewed-answer` pour ajouter la réponse révisée mise à jour au sujet.