Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés. # Trabaje con temas de Quick Sight con Amazon Quick Sight APIs | | | --- | |  Se aplica a: Enterprise Edition  | | | | --- | |    Público objetivo: desarrolladores de Amazon Quick  | Utilice esta sección para aprender a trabajar con los temas de Quick Sight mediante la interfaz de línea de comandos (CLI) de Amazon Quick Sight. **Requisitos previos** Antes de empezar, asegúrese de tener una función AWS Identity and Access Management (IAM) que conceda al usuario de CLI acceso para llamar a las operaciones de la API Quick Sight. En la siguiente tabla, se muestran los permisos que se deben añadir a la política de IAM para utilizar operaciones de API específicas. Para utilizar todas las operaciones de la API del tema, añada todos los permisos que aparecen en la tabla. | Operación de la API | Política de 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` | En el siguiente ejemplo, se muestra una política de IAM que permite al usuario usar la operación `ListTopics` de la API. ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "quicksight:ListTopics" ], "Resource": "*" } ] } ``` ------ Después de configurar los permisos para crear temas de Quick Sight con Quick Sight APIs, utilice los siguientes temas para crear y trabajar con el tema Quick Sight APIs. **Topics** + [Trabaje con los temas de Quick Sight mediante Quick Sight APIs](topic-cli-examples.md) + [Configure los programas de actualización de temas de Quick Sight con la CLI de Quick Sight](topic-refresh-apis.md) + [Copie y migre temas de Quick Sight dentro y entre Cuentas de AWS](topic-cli-walkthroughs.md) + [Cree y modifique las respuestas revisadas en los temas de Vista rápida con Vista rápida APIs](topic-reviewed-answer-apis.md) # Trabaje con los temas de Quick Sight mediante Quick Sight APIs El siguiente ejemplo crea un tema nuevo. ``` aws quicksight create-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC ``` También puede crear un tema nuevo mediante un archivo básico de CLI con el siguiente comando. Para obtener más información sobre los archivos de esqueleto de CLI, consulte [Uso de archivos de esqueleto de CLI](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) en la *Guía para desarrolladores de Amazon Quick Sight*. ``` aws quicksight create-topic --cli-input-json file://createtopic.json ``` Al crear un tema nuevo, la configuración de actualización del conjunto de datos no se copia en el tema. Para establecer una programación de actualización del tema para su nuevo tema, puede realizar una llamada a la API `create-topic-refresh-schedule`. Para obtener más información acerca de la configuración de las programaciones de actualización de temas con la CLI, consulte [Configure los programas de actualización de temas de Quick Sight con la CLI de Quick Sight](topic-refresh-apis.md). Después de crear el primer tema, puedes actualizarlo, eliminarlo, incluirlo en una lista o solicitar un resumen del tema. En el siguiente ejemplo, se actualiza un tema. ``` aws quicksight update-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC ``` También puede actualizar un tema mediante un archivo básico de CLI con el siguiente comando. Para obtener más información sobre los archivos de esqueleto de CLI, consulte [Uso de archivos de esqueleto de CLI](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) en la *Guía para desarrolladores de Amazon Quick Sight*. ``` aws quicksight update-topic --cli-input-json file://updatetopic.json ``` El siguiente ejemplo proporciona una lista de todos los temas de una cuenta Quick. ``` aws quicksight list-topics --aws-account-id AWSACCOUNTID ``` En el siguiente ejemplo, se elimina un tema. ``` aws quicksight delete-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` El siguiente ejemplo proporciona información sobre cómo se configuró un tema. ``` aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` El siguiente comando actualiza los permisos de un tema. ``` 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 ``` Utilice el `grant-permissions` parámetro para conceder permisos de lectura y autor a los usuarios de la cuenta Quick. Para conceder permisos de lectura a un usuario de cuenta, introduzca el siguiente valor: `"quicksight:DescribeTopic"`. Para conceder permisos a un usuario de cuenta, introduzca los siguientes valores: + `"quicksight:DescribeTopic"` + `"quicksight:DescribeTopicRefresh"` + `"quicksight:ListTopicRefreshSchedules"` + `"quicksight:DescribeTopicRefreshSchedule"` + `"quicksight:DeleteTopic"` + `"quicksight:UpdateTopic"` + `"quicksight:CreateTopicRefreshSchedule"` + `"quicksight:DeleteTopicRefreshSchedule"` + `"quicksight:UpdateTopicRefreshSchedule"` + `"quicksight:DescribeTopicPermissions"` + `"quicksight:UpdateTopicPermissions"` El parámetro `RevokePermissions` revoca todos los permisos concedidos a un usuario de cuenta. El siguiente comando describe todos los permisos de un tema. ``` aws quicksight describe-topic-permissions --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` Después de crear un tema de Quick Sight, puede usar Amazon Quick Sight APIs para [configurar un programa de actualización de temas](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-refresh-apis), [migrar temas de Quick Sight dentro de las cuentas o entre](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-cli-walkthroughs) ellas y [crear respuestas revisadas](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-reviewed-answer-apis). # Configure los programas de actualización de temas de Quick Sight con la CLI de Quick Sight El siguiente comando crea un programa de actualización de un tema. ``` aws quicksight create-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-arn DATASETARN --refresh-schedule REFRESHSCHEDULE ``` Tras crear un programa de actualización para un tema, puede actualizar, eliminar, enumerar o solicitar un resumen del programa de actualización del tema. El siguiente comando actualiza el programa de actualización de un tema. ``` aws quicksight update-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID --refresh-schedule REFRESHSCHEDULE ``` El siguiente ejemplo proporciona una lista de todos los programas de actualización configurados para un tema. ``` aws quicksight list-topic-refresh-schedules --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` En el siguiente ejemplo, se elimina una programación de actualización de un tema. ``` aws quicksight delete-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID ``` En el siguiente ejemplo, se proporciona información sobre cómo se configuró una programación de actualización de un tema. ``` aws quicksight describe-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID ``` # Copie y migre temas de Quick Sight dentro y entre Cuentas de AWS Puede migrar los temas de Quick Sight de una cuenta a otra con la interfaz de línea de comandos (CLI) de Quick Sight. En lugar de replicar manualmente el mismo tema en varios paneles, espacios de nombres o cuentas, puede usar la CLI de Quick Sight para reutilizar el mismo tema repetidamente. Esta función ahorra tiempo a los autores de Quick Sight y crea una experiencia temática estandarizada para los lectores de varios paneles. Para migrar temas con la CLI de Quick Sight, utilice el siguiente procedimiento **Para migrar un tema a otra cuenta** 1. En primer lugar, identifique el tema que desea migrar. Puedes ver una lista de todos los temas de tu cuenta Quick con un comando de `list-topics` API. ``` aws quicksight list-topics --aws-account-id AWSACCOUNTID ``` 1. Cuando tengas una lista de temas, busca el tema que deseas migrar y realiza una `describe-topic` llamada para recibir una estructura JSON de la configuración del tema. ``` aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` A continuación se muestra un ejemplo de una respuesta de la API `describe-topic`. ``` { "Status": 200, "TopicId": "TopicExample", "Arn": "string", "Topic": [ { "Name": "{}", "DataSets": [ { "DataSetArn": "{}", "DataSetName": "{}", "DataSetDescription": "{}", "DataAggregation": "{}", "Filters": [], "Columns": [], "CalculatedFields": [], "NamedEntities": [] } ] } ], "RequestId": "requestId" } ``` 1. Usa la respuesta JSON para crear un archivo básico que puedas introducir en una nueva `create-topic` llamada en tu otra cuenta de Quick. Antes de realizar una llamada a la API con tu archivo básico, asegúrate de cambiar el Cuenta de AWS ID y el ID del conjunto de datos del archivo básico para que coincidan con el Cuenta de AWS ID y el ID del conjunto de datos a los que vas a añadir el nuevo tema. Para obtener más información sobre los archivos de esqueleto de CLI, consulte [Uso de archivos de esqueleto de CLI](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) en la *Guía para desarrolladores de Amazon Quick Sight*. ``` aws quicksight create-topic --aws-account-id AWSACCOUNTID \ --cli-input-json file://./create-topic-cli-input.json ``` Tras realizar una `create-topic` llamada a la API Quick Sight, el nuevo tema aparecerá en su cuenta. Para confirmar que el tema nuevo existe, realiza una `list-topics` llamada a la API Quick Sight. Si el tema de origen que se duplicó contiene respuestas verificadas, las respuestas no se migran al tema nuevo. Para ver una lista de todas las respuestas verificadas que están configuradas para el tema original, use una llamada a la API `describe-topic`. # Cree y modifique las respuestas revisadas en los temas de Vista rápida con Vista rápida APIs Tras crear un tema de vista rápida, puede utilizarla APIs para crear, enumerar, actualizar y eliminar las respuestas revisadas de los temas. El siguiente comando por lotes crea hasta 100 respuestas revisadas para un tema de vista rápida. ``` aws quicksight batch-create-topic-reviewed-answer \ --topic-id TOPICID \ --aws-account-id AWSACCOUNTID \ —answers ANSWERS ``` También puede crear respuestas revisadas a partir de un archivo de esqueleto de la CLI con el siguiente comando. Para obtener más información sobre los archivos de esqueleto de CLI, consulte [Uso de archivos de esqueleto de CLI](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) en la *Guía para desarrolladores de Amazon Quick Sight*. ``` aws quicksight batch-create-topic-reviewed-answer \ --cli-input-json file://createTopicReviewedAnswer.json ``` El siguiente comando muestra todas las respuestas revisadas en un tema de Quick Sight. ``` aws quicksight list-topic-reviewed-answers \ --aws-account-id AWSACCOUNTID \ --topic-id TOPICID \ ``` El siguiente ejemplo elimina por lotes hasta 100 respuestas revisadas de un tema. ``` aws quicksight batch-delete-topic-reviewed-answer \ --topic-id TOPICID \ --aws-account-id AWSACCOUNTID \ —answer-ids: ["AnswerId1, AnswerId2…"] ``` También puede crear por lotes respuestas revisadas del tema a partir de un archivo de esqueleto de la CLI con el siguiente comando. Para obtener más información sobre los archivos de esqueleto de CLI, consulte [Uso de archivos de esqueleto de CLI](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) en la *Guía para desarrolladores de Amazon Quick Sight*. ``` aws quicksight batch-delete-topic-reviewed-answer \ --cli-input-json file://deleteTopicReviewedAnswer.json ``` Para actualizar una respuesta revisada, elimine la respuesta existente del tema con la API de `batch-delete-topic-reviewed-answer`. Luego, use la API de `batch-create-topic-reviewed-answer` para agregar la respuesta revisada actualizada al tema.