Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich. # Arbeiten Sie mit Quick Sight-Themen mithilfe von Amazon Quick Sight APIs | | | --- | |  Gilt für: Enterprise Edition  | | | | --- | |    Zielgruppe: Amazon Quick-Entwickler  | In diesem Abschnitt erfahren Sie, wie Sie mithilfe der Amazon Quick Sight-Befehlszeilenschnittstelle (CLI) mit Quick Sight-Themen arbeiten. **Voraussetzungen** Bevor Sie beginnen, stellen Sie sicher, dass Sie über eine AWS Identity and Access Management (IAM-) Rolle verfügen, die dem CLI-Benutzer Zugriff zum Aufrufen der Quick Sight-API-Operationen gewährt. Die folgende Tabelle zeigt, welche Berechtigungen zur IAM-Richtlinie hinzugefügt werden müssen, um bestimmte API-Operationen verwenden zu können. Um alle API-Operationen des Themas zu verwenden, fügen Sie alle in der Tabelle aufgeführten Berechtigungen hinzu. | API-Operation | IAM-Richtlinie | | --- | --- | | `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` | Das folgende Beispiel zeigt eine IAM-Richtlinie, die es einem Benutzer erlaubt, dass die IAM-Rolle die `ListTopics`-API-Operation zu verwenden. ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "quicksight:ListTopics" ], "Resource": "*" } ] } ``` ------ Nachdem Sie die Berechtigungen zum Erstellen von Quick Sight-Themen mit Quick Sight konfiguriert haben APIs, verwenden Sie die folgenden Themen, um Quick Sight-Themen zu erstellen und damit zu arbeiten APIs. **Topics** + [Arbeiten Sie mit Quick Sight-Themen mithilfe von Quick Sight APIs](topic-cli-examples.md) + [Konfigurieren Sie Zeitpläne für die Aktualisierung von Quick Sight-Themen mit der Quick Sight CLI](topic-refresh-apis.md) + [Kopieren und migrieren Sie Quick Sight-Themen innerhalb und zwischen AWS-Konten](topic-cli-walkthroughs.md) + [Erstellen und ändern Sie überprüfte Antworten in Quick Sight-Themen mit Quick Sight APIs](topic-reviewed-answer-apis.md) # Arbeiten Sie mit Quick Sight-Themen mithilfe von Quick Sight APIs Das folgende Beispiel erstellt ein neues Thema. ``` aws quicksight create-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC ``` Sie können auch ein neues Thema erstellen, indem Sie eine CLI-Skelettdatei mit dem folgenden Befehl verwenden. Weitere Informationen zu CLI-Skelettdateien finden Sie unter [Verwenden von CLI-Skelettdateien](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) im *Amazon Quick Sight Developer Guide*. ``` aws quicksight create-topic --cli-input-json file://createtopic.json ``` Wenn Sie ein neues Thema erstellen, wird die Konfiguration für die Aktualisierung des Datensatzes nicht in das Thema kopiert. Um einen Zeitplan für die Aktualisierung des Themas für Ihr neues Thema festzulegen, können Sie einen `create-topic-refresh-schedule`-API-Aufruf durchführen. Weitere Informationen zum Konfigurieren von Zeitplänen für Themenaktualisierungen mit der CLI finden Sie unter [Konfigurieren Sie Zeitpläne für die Aktualisierung von Quick Sight-Themen mit der Quick Sight CLI](topic-refresh-apis.md). Nachdem Sie Ihr erstes Thema erstellt haben, können Sie ein Thema aktualisieren, löschen, auflisten oder eine Zusammenfassung anfordern. Im folgenden Beispiel wird ein Thema aktualisiert. ``` aws quicksight update-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC ``` Sie können ein Thema auch aktualisieren, indem Sie eine CLI-Skelettdatei mit dem folgenden Befehl verwenden. Weitere Informationen zu CLI-Skelettdateien finden Sie unter [Verwenden von CLI-Skelettdateien](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) im *Amazon Quick Sight Developer Guide*. ``` aws quicksight update-topic --cli-input-json file://updatetopic.json ``` Das folgende Beispiel enthält eine Liste aller Themen in einem Quick-Konto. ``` aws quicksight list-topics --aws-account-id AWSACCOUNTID ``` Im folgenden Beispiel wird ein Thema gelöscht. ``` aws quicksight delete-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` Das folgende Beispiel enthält Informationen darüber, wie ein Thema konfiguriert wurde. ``` aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` Der folgende Befehl aktualisiert die Berechtigungen eines Themas. ``` 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 ``` Verwenden Sie den `grant-permissions` Parameter, um Quick Account-Benutzern Lese- und Autorenberechtigungen zu gewähren. Um einem Kontobenutzer Leserechte zu gewähren, geben Sie den folgenden Wert ein: `"quicksight:DescribeTopic"`. Um Berechtigungen für einen Kontobenutzer zu erteilen, geben Sie die folgenden Werte ein: + `"quicksight:DescribeTopic"` + `"quicksight:DescribeTopicRefresh"` + `"quicksight:ListTopicRefreshSchedules"` + `"quicksight:DescribeTopicRefreshSchedule"` + `"quicksight:DeleteTopic"` + `"quicksight:UpdateTopic"` + `"quicksight:CreateTopicRefreshSchedule"` + `"quicksight:DeleteTopicRefreshSchedule"` + `"quicksight:UpdateTopicRefreshSchedule"` + `"quicksight:DescribeTopicPermissions"` + `"quicksight:UpdateTopicPermissions"` Der `RevokePermissions`-Parameter widerruft alle einem Kontonutzer erteilten Berechtigungen. Der folgende Befehl beschreibt alle Berechtigungen für ein Thema. ``` aws quicksight describe-topic-permissions --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` Nachdem Sie ein Quick Sight-Thema erstellt haben, können Sie Amazon Quick Sight verwenden, APIs um [einen Zeitplan für die Themenaktualisierung zu konfigurieren](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-refresh-apis), [Quick Sight-Themen innerhalb oder zwischen Konten zu migrieren](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-cli-walkthroughs) und [überprüfte Antworten zu erstellen](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-reviewed-answer-apis). # Konfigurieren Sie Zeitpläne für die Aktualisierung von Quick Sight-Themen mit der Quick Sight CLI Der folgende Befehl erstellt einen Aktualisierungsplan für ein Thema. ``` aws quicksight create-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-arn DATASETARN --refresh-schedule REFRESHSCHEDULE ``` Nachdem Sie einen Aktualisierungszeitplan für ein Thema erstellt haben, können Sie den Aktualisierungszeitplan des Themas aktualisieren, löschen, auflisten oder eine Zusammenfassung anfordern. Mit dem folgenden Befehl wird der Aktualisierungszeitplan eines Themas aktualisiert. ``` aws quicksight update-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID --refresh-schedule REFRESHSCHEDULE ``` Das folgende Beispiel enthält eine Liste aller Aktualisierungszeitpläne, die für ein Thema konfiguriert sind. ``` aws quicksight list-topic-refresh-schedules --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` Im folgenden Beispiel wird ein Zeitplan für die Aktualisierung eines Themas gelöscht. ``` aws quicksight delete-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID ``` Das folgende Beispiel enthält Informationen darüber, wie ein Zeitplan für die Themenaktualisierung konfiguriert wurde. ``` aws quicksight describe-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID ``` # Kopieren und migrieren Sie Quick Sight-Themen innerhalb und zwischen AWS-Konten Sie können Ihre Quick Sight-Themen mit der Quick Sight-Befehlszeilenschnittstelle (CLI) von einem Konto zu einem anderen migrieren. Anstatt dasselbe Thema manuell über mehrere Dashboards, Namespaces oder Konten hinweg zu replizieren, können Sie die Quick Sight-CLI verwenden, um dasselbe Thema wiederholt wiederzuverwenden. Diese Funktion spart Quick Sight-Autoren Zeit und schafft eine standardisierte Themenerfahrung für Dashboard-Leser auf mehreren Dashboards. Gehen Sie wie folgt vor, um Themen mit der Quick Sight CLI zu migrieren **Um ein Thema zu einem anderen Konto zu migrieren** 1. Identifizieren Sie zunächst das Thema, das Sie migrieren möchten. Sie können mit einem `list-topics` API-Befehl eine Liste aller Themen in Ihrem Quick-Konto anzeigen. ``` aws quicksight list-topics --aws-account-id AWSACCOUNTID ``` 1. Nachdem Sie eine Themenliste erstellt haben, suchen Sie das Thema, das Sie migrieren möchten, und `describe-topic` rufen Sie an, um eine JSON-Struktur der Konfiguration des Themas zu erhalten. ``` aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` Nachfolgend finden Sie ein Beispielfür eine `describe-topic`-API-Antwort. ``` { "Status": 200, "TopicId": "TopicExample", "Arn": "string", "Topic": [ { "Name": "{}", "DataSets": [ { "DataSetArn": "{}", "DataSetName": "{}", "DataSetDescription": "{}", "DataAggregation": "{}", "Filters": [], "Columns": [], "CalculatedFields": [], "NamedEntities": [] } ] } ], "RequestId": "requestId" } ``` 1. Verwenden Sie die JSON-Antwort, um eine Skelettdatei zu erstellen, die Sie in einen neuen `create-topic` Anruf in Ihrem anderen Quick-Konto eingeben können. Bevor Sie einen API-Aufruf mit Ihrer Skelettdatei durchführen, stellen Sie sicher, dass Sie die AWS-Konto ID und die Datensatz-ID in der Skelettdatei so ändern, dass sie mit der AWS-Konto ID und der Datensatz-ID übereinstimmen, zu der Sie das neue Thema hinzufügen. Weitere Informationen zu CLI-Skelettdateien finden Sie unter [Verwenden von CLI-Skelettdateien](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) im *Amazon Quick Sight Developer Guide*. ``` aws quicksight create-topic --aws-account-id AWSACCOUNTID \ --cli-input-json file://./create-topic-cli-input.json ``` Nachdem Sie die Quick Sight-API `create-topic` aufgerufen haben, erscheint das neue Thema in Ihrem Konto. `list-topics`Rufen Sie die Quick Sight-API auf, um zu bestätigen, dass das neue Thema existiert. Wenn das duplizierte Quellthema verifizierte Antworten enthält, werden die Antworten nicht in das neue Thema migriert. Um eine Liste aller verifizierten Antworten zu sehen, die für das ursprüngliche Thema konfiguriert sind, führen Sie einen `describe-topic`-API-Aufruf durch. # Erstellen und ändern Sie überprüfte Antworten in Quick Sight-Themen mit Quick Sight APIs Nachdem Sie ein Quick Sight-Thema erstellt haben, können Sie Quick Sight verwenden, APIs um überprüfte Antworten zu Themen zu erstellen, aufzulisten, zu aktualisieren und zu löschen. Mit dem folgenden Batch-Befehl werden bis zu 100 überprüfte Antworten für ein Quick Sight-Thema erstellt. ``` aws quicksight batch-create-topic-reviewed-answer \ --topic-id TOPICID \ --aws-account-id AWSACCOUNTID \ —answers ANSWERS ``` Sie können mit dem folgenden Befehl auch überprüfte Antworten aus einer CLI-Skelettdatei erstellen. Weitere Informationen zu CLI-Skelettdateien finden Sie unter [Verwenden von CLI-Skelettdateien](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) im *Amazon Quick Sight Developer Guide*. ``` aws quicksight batch-create-topic-reviewed-answer \ --cli-input-json file://createTopicReviewedAnswer.json ``` Der folgende Befehl listet alle überprüften Antworten in einem Quick Sight-Thema auf. ``` aws quicksight list-topic-reviewed-answers \ --aws-account-id AWSACCOUNTID \ --topic-id TOPICID \ ``` Das folgende Beispiel löscht stapelweise bis zu 100 überprüfte Antworten aus einem Thema. ``` aws quicksight batch-delete-topic-reviewed-answer \ --topic-id TOPICID \ --aws-account-id AWSACCOUNTID \ —answer-ids: ["AnswerId1, AnswerId2…"] ``` Sie können mit dem folgenden Befehl auch Antworten zu überprüften Themen aus einer CLI-Skelettdatei stapelweise erstellen. Weitere Informationen zu CLI-Skelettdateien finden Sie unter [Verwenden von CLI-Skelettdateien](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) im *Amazon Quick Sight Developer Guide*. ``` aws quicksight batch-delete-topic-reviewed-answer \ --cli-input-json file://deleteTopicReviewedAnswer.json ``` Um eine überprüfte Antwort zu aktualisieren, löschen Sie die vorhandene Antwort mit der `batch-delete-topic-reviewed-answer`-API aus dem Thema. Verwenden Sie dann die `batch-create-topic-reviewed-answer`-API, um die aktualisierte überprüfte Antwort zum Thema hinzuzufügen.