As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá. # Trabalhe com tópicos do Quick Sight usando o Amazon Quick Sight APIs | | | --- | |  Aplica-se a: Enterprise Edition  | | | | --- | |    Público-alvo: desenvolvedores do Amazon Quick  | Use esta seção para aprender a trabalhar com tópicos do Quick Sight usando a interface de linha de comando (CLI) do Amazon Quick Sight. **Pré-requisitos** Antes de começar, verifique se você tem uma função AWS Identity and Access Management (IAM) que conceda ao usuário da CLI acesso para chamar as operações da API Quick Sight. A tabela a seguir mostra quais permissões devem ser adicionadas à política do IAM para usar operações de API específicas. Para usar todas as operações de API de tópicos, adicione todas as permissões listadas na tabela. | Operação de API | Política do 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` | O exemplo a seguir mostra uma política do IAM que permite que um usuário use a operação de API `ListTopics`. ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "quicksight:ListTopics" ], "Resource": "*" } ] } ``` ------ Depois de configurar as permissões para criar tópicos do Quick Sight com o Quick Sight APIs, use os tópicos a seguir para criar e trabalhar com o tópico do Quick Sight APIs. **Topics** + [Trabalhe com tópicos do Quick Sight usando o Quick Sight APIs](topic-cli-examples.md) + [Configure os cronogramas de atualização de tópicos do Quick Sight com a CLI do Quick Sight](topic-refresh-apis.md) + [Copie e migre tópicos do Quick Sight dentro e entre Contas da AWS](topic-cli-walkthroughs.md) + [Crie e modifique respostas revisadas em tópicos do Quick Sight com o Quick Sight APIs](topic-reviewed-answer-apis.md) # Trabalhe com tópicos do Quick Sight usando o Quick Sight APIs O exemplo a seguir cria um novo tópico. ``` aws quicksight create-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC ``` Você também pode criar um novo tópico usando um arquivo de esqueleto CLI com o comando a seguir. Para obter mais informações sobre arquivos de esqueleto de CLI, consulte Como usar arquivos de esqueleto de [CLI no Guia](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) do desenvolvedor do *Amazon* Quick Sight. ``` aws quicksight create-topic --cli-input-json file://createtopic.json ``` Quando você cria um novo tópico, a configuração de atualização do conjunto de dados não é copiada para o tópico. Para definir uma programação de atualização para seu novo tópico, você pode fazer uma chamada de API `create-topic-refresh-schedule`. Para obter mais informações sobre a configuração de programações de atualização de tópicos com a CLI, consulte [Configure os cronogramas de atualização de tópicos do Quick Sight com a CLI do Quick Sight](topic-refresh-apis.md). Depois de criar seu primeiro tópico, você pode atualizar, excluir, listar ou solicitar um resumo de um tópico. O exemplo a seguir atualiza um tópico. ``` aws quicksight update-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC ``` Você também pode atualizar um tópico usando um arquivo de esqueleto CLI com o comando a seguir. Para obter mais informações sobre arquivos de esqueleto de CLI, consulte Como usar arquivos de esqueleto de [CLI no Guia](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) do desenvolvedor do *Amazon* Quick Sight. ``` aws quicksight update-topic --cli-input-json file://updatetopic.json ``` O exemplo a seguir fornece uma lista de todos os tópicos em uma conta rápida. ``` aws quicksight list-topics --aws-account-id AWSACCOUNTID ``` O exemplo a seguir exclui um tópico. ``` aws quicksight delete-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` O exemplo a seguir fornece informações sobre como um tópico foi configurado. ``` aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` O comando a seguir atualiza as permissões de um tópico. ``` 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 ``` Use o `grant-permissions` parâmetro para conceder permissões de leitura e autor aos usuários da conta rápida. Para conceder permissões de leitura a um usuário da conta, insira o seguinte valor: `"quicksight:DescribeTopic"`. Para conceder permissões a um usuário da conta, insira os seguintes valores: + `"quicksight:DescribeTopic"` + `"quicksight:DescribeTopicRefresh"` + `"quicksight:ListTopicRefreshSchedules"` + `"quicksight:DescribeTopicRefreshSchedule"` + `"quicksight:DeleteTopic"` + `"quicksight:UpdateTopic"` + `"quicksight:CreateTopicRefreshSchedule"` + `"quicksight:DeleteTopicRefreshSchedule"` + `"quicksight:UpdateTopicRefreshSchedule"` + `"quicksight:DescribeTopicPermissions"` + `"quicksight:UpdateTopicPermissions"` O parâmetro `RevokePermissions` revoga todas as permissões concedidas a um usuário da conta. O comando a seguir descreve todas as permissões de um tópico. ``` aws quicksight describe-topic-permissions --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` Depois de criar um tópico do Quick Sight, você pode usar o Amazon Quick Sight APIs para [configurar um cronograma de atualização de tópicos](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-refresh-apis), [migrar tópicos do Quick Sight dentro ou entre contas](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-cli-walkthroughs) e [criar respostas revisadas](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-reviewed-answer-apis). # Configure os cronogramas de atualização de tópicos do Quick Sight com a CLI do Quick Sight O comando a seguir cria uma agenda de atualização de um tópico. ``` aws quicksight create-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-arn DATASETARN --refresh-schedule REFRESHSCHEDULE ``` Depois de criar uma agenda de atualização para um tópico, você pode atualizar, excluir, listar ou solicitar um resumo da agenda de atualização do tópico. O comando a seguir atualiza o cronograma de atualização de um tópico. ``` aws quicksight update-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID --refresh-schedule REFRESHSCHEDULE ``` O exemplo a seguir fornece uma lista de todas as agendas de atualização configuradas para um tópico. ``` aws quicksight list-topic-refresh-schedules --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` O exemplo a seguir exclui uma programação de atualização de tópicos. ``` aws quicksight delete-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID ``` O exemplo a seguir fornece informações sobre como a programação de atualização de um tópico Q foi configurada. ``` aws quicksight describe-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID ``` # Copie e migre tópicos do Quick Sight dentro e entre Contas da AWS Você pode migrar seus tópicos do Quick Sight de uma conta para outra com a interface de linha de comando (CLI) do Quick Sight. Em vez de replicar manualmente o mesmo tópico em vários painéis, namespaces ou contas, você pode usar a CLI do Quick Sight para reutilizar o mesmo tópico repetidamente. Esse recurso economiza tempo dos autores do Quick Sight e cria uma experiência de tópico padronizada para leitores de painéis em vários painéis. Para migrar tópicos com a CLI do Quick Sight, use o procedimento a seguir **Para migrar um tópico para outra conta** 1. Primeiro, identifique o tópico que você deseja migrar. Você pode ver uma lista de todos os tópicos em sua conta Quick com um comando de `list-topics` API. ``` aws quicksight list-topics --aws-account-id AWSACCOUNTID ``` 1. Depois de ter uma lista de tópicos, localize o tópico que você deseja migrar e faça uma `describe-topic` chamada para receber uma estrutura JSON da configuração do tópico. ``` aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID ``` Veja um exemplo de resposta da API `describe-topic`. ``` { "Status": 200, "TopicId": "TopicExample", "Arn": "string", "Topic": [ { "Name": "{}", "DataSets": [ { "DataSetArn": "{}", "DataSetName": "{}", "DataSetDescription": "{}", "DataAggregation": "{}", "Filters": [], "Columns": [], "CalculatedFields": [], "NamedEntities": [] } ] } ], "RequestId": "requestId" } ``` 1. Use a resposta JSON para criar um arquivo esqueleto que você pode inserir em uma nova `create-topic` chamada em sua outra conta do Quick. Antes de fazer uma chamada de API com seu arquivo esqueleto, certifique-se de alterar o Conta da AWS ID e o ID do conjunto de dados no arquivo esqueleto para que correspondam ao Conta da AWS ID e ao ID do conjunto de dados aos quais você está adicionando o novo tópico. Para obter mais informações sobre arquivos de esqueleto de CLI, consulte Como usar arquivos de esqueleto de [CLI no Guia](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) do desenvolvedor do *Amazon* Quick Sight. ``` aws quicksight create-topic --aws-account-id AWSACCOUNTID \ --cli-input-json file://./create-topic-cli-input.json ``` Depois de fazer uma `create-topic` chamada para a API do Quick Sight, o novo tópico aparece na sua conta. Para confirmar que o novo tópico existe, faça uma `list-topics` chamada para a API Quick Sight. Se o tópico de origem que foi duplicado contiver respostas verificadas, as respostas não serão migradas para o novo tópico. Para visualizar uma lista de todas as respostas verificadas que estão configuradas para o tópico original, use uma chamada de API `describe-topic`. # Crie e modifique respostas revisadas em tópicos do Quick Sight com o Quick Sight APIs Depois de criar um tópico do Quick Sight, você pode usar o Quick Sight APIs para criar, listar, atualizar e excluir respostas revisadas para tópicos. O comando abaixo em lote cria até 100 respostas revisadas para um tópico do Quick Sight. ``` aws quicksight batch-create-topic-reviewed-answer \ --topic-id TOPICID \ --aws-account-id AWSACCOUNTID \ —answers ANSWERS ``` Além disso, é possível criar respostas revisadas em lote usando um arquivo de estrutura da CLI com o comando apresentado a seguir. Para obter mais informações sobre arquivos de esqueleto de CLI, consulte Como usar arquivos de esqueleto de [CLI no Guia](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) do desenvolvedor do *Amazon* Quick Sight. ``` aws quicksight batch-create-topic-reviewed-answer \ --cli-input-json file://createTopicReviewedAnswer.json ``` O comando abaixo lista todas as respostas revisadas em um tópico do Quick Sight. ``` aws quicksight list-topic-reviewed-answers \ --aws-account-id AWSACCOUNTID \ --topic-id TOPICID \ ``` O exemplo apresentado abaixo exclui até cem respostas revisadas em lote de um tópico. ``` aws quicksight batch-delete-topic-reviewed-answer \ --topic-id TOPICID \ --aws-account-id AWSACCOUNTID \ —answer-ids: ["AnswerId1, AnswerId2…"] ``` Além disso, é possível criar respostas revisadas de tópicos em lote usando um arquivo de estrutura da CLI com o comando apresentado a seguir. Para obter mais informações sobre arquivos de esqueleto de CLI, consulte Como usar arquivos de esqueleto de [CLI no Guia](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) do desenvolvedor do *Amazon* Quick Sight. ``` aws quicksight batch-delete-topic-reviewed-answer \ --cli-input-json file://deleteTopicReviewedAnswer.json ``` Para atualizar uma resposta revisada, exclua a resposta existente do tópico usando a API `batch-delete-topic-reviewed-answer`. Em seguida, use a API `batch-create-topic-reviewed-answer` para adicionar a resposta revisada atualizada ao tópico.