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 preguntas QuickSight frecuentes mediante Amazon QuickSight CLI
| Se aplica a: Enterprise Edition |
| Público objetivo: QuickSight desarrolladores de Amazon |
Utilice esta sección para aprender a trabajar con los temas de QuickSight Q mediante la interfaz de línea de QuickSight comandos (CLI) de Amazon.
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 QuickSight API. 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 de Q, añada todos los permisos que se muestran en la tabla.
| Operación de la API | Política de IAM |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
En el siguiente ejemplo, se muestra una política de IAM que permite al usuario usar la operación ListTopics de la API.
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "quicksight:ListTopics" ], "Resource": "*" } ] }
Trabaje con temas de QuickSight Q mediante la QuickSight CLI
En el siguiente ejemplo, se crea un nuevo tema de Q.
aws quicksight create-topic --aws-account-idAWSACCOUNTID--topic-idTOPICID--topicTOPIC
También puede crear un tema de Q nuevo mediante 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 en la Guía para QuickSight desarrolladores de Amazon.
aws quicksight create-topic --cli-input-json file://createtopic.json
Al crear un tema de Q 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 los temas Q con la QuickSight CLI.
Tras crear el primer tema de Q, puede actualizarlo, eliminarlo, incluirlo en una lista o solicitar un resumen de este.
En el siguiente ejemplo, se actualiza un tema de Q.
aws quicksight update-topic --aws-account-idAWSACCOUNTID--topic-idTOPICID--topicTOPIC
También puede actualizar un tema de Q utilizando 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 en la Guía para QuickSight desarrolladores de Amazon.
aws quicksight update-topic --cli-input-json file://updatetopic.json
El siguiente ejemplo proporciona una lista de todos los temas Q de una QuickSight cuenta.
aws quicksight list-topics --aws-account-idAWSACCOUNTID
En el siguiente ejemplo, se borra un tema de Q.
aws quicksight delete-topic --aws-account-idAWSACCOUNTID--topic-idTOPICID
En el siguiente ejemplo, se proporciona información sobre cómo se configuró un tema de Q.
aws quicksight describe-topic --aws-account-idAWSACCOUNTID--topic-idTOPICID
El siguiente comando actualiza los permisos de un tema de Q.
aws quicksight update-topic-permissions --aws-account-idAWSACCOUNTID--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
Utilice el grant-permissions parámetro para conceder permisos de lectura y autor a los usuarios de la QuickSight cuenta. 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 de Q.
aws quicksight describe-topic-permissions --aws-account-idAWSACCOUNTID--topic-idTOPICID
Configure los programas de actualización de los temas Q con la QuickSight CLI
El siguiente comando crea una programación de actualización de un tema de Q.
aws quicksight create-topic-refresh-schedule --aws-account-idAWSACCOUNTID--topic-idTOPICID--dataset-arnDATASETARN--refresh-scheduleREFRESHSCHEDULE
Tras crear una programación de actualización para un tema de Q, puede actualizar, eliminar, enumerar o solicitar un resumen de la programación de actualización del tema.
El siguiente comando actualiza la programación de actualización de un tema de Q.
aws quicksight update-topic-refresh-schedule --aws-account-idAWSACCOUNTID--topic-idTOPICID--dataset-idDATASETID--refresh-scheduleREFRESHSCHEDULE
En el siguiente ejemplo, proporciona una lista de todas las programaciones de actualización configuradas para un tema de Q.
aws quicksight list-topic-refresh-schedules --aws-account-idAWSACCOUNTID--topic-idTOPICID
En el siguiente ejemplo, se elimina una programación de actualización de un tema.
aws quicksight delete-topic-refresh-schedule --aws-account-idAWSACCOUNTID--topic-idTOPICID--dataset-idDATASETID
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-idAWSACCOUNTID--topic-idTOPICID--dataset-idDATASETID
Copie y migre los temas de QuickSight Q dentro y entre ellos Cuentas de AWS
Puede migrar sus temas de QuickSight Q de una cuenta a otra con la interfaz de línea de QuickSight comandos (CLI). En lugar de replicar manualmente el mismo tema en varios paneles, espacios de nombres o cuentas, puede usar la QuickSight CLI para reutilizar el mismo tema repetidamente. Esta capacidad ahorra tiempo a QuickSight los autores y crea una experiencia temática estandarizada para los lectores de varios paneles.
Para migrar los temas de Q con la QuickSight CLI, utilice el siguiente procedimiento
Migración de un tema de Q a otra cuenta
-
En primer lugar, identifique el tema que desea migrar. Puedes ver una lista de todos los temas de Q de tu QuickSight cuenta con un comando de
list-topicsAPI.aws quicksight list-topics --aws-account-idAWSACCOUNTID -
Cuando tenga una lista de los temas de Q, busque el tema que desea migrar y realice una llamada
describe-topicpara recibir una estructura JSON de la configuración del tema.aws quicksight describe-topic --aws-account-idAWSACCOUNTID--topic-idTOPICIDA 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" } -
Usa la respuesta JSON para crear un archivo básico que puedas introducir en una nueva
create-topicllamada en tu otra QuickSight cuenta. Antes de realizar una llamada a la API con el archivo de esqueleto, asegúrese de cambiar el ID de la Cuenta de AWS y el ID del conjunto de datos del archivo de esqueleto para que coincidan con el ID de la Cuenta de AWS y el ID del conjunto de datos a los que va a añadir el nuevo tema de Q. Para obtener más información sobre los archivos de esqueleto de CLI, consulte Uso de archivos de esqueleto de CLI en la Guía para QuickSight desarrolladores de Amazon.aws quicksight create-topic --aws-account-idAWSACCOUNTID\ --cli-input-jsonfile://./create-topic-cli-input.json
Tras realizar una create-topic llamada a la QuickSight API, el nuevo tema aparecerá en su cuenta. Para confirmar que el tema nuevo existe, realiza una list-topics llamada a la QuickSight API. 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.
