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 de QuickSight Q usando a Amazon QuickSight CLI
| Aplica-se a: Enterprise Edition |
| Público-alvo: QuickSight desenvolvedores da Amazon |
Use esta seção para aprender a trabalhar com tópicos do QuickSight Q usando a interface de linha de QuickSight comando (CLI) da Amazon.
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 QuickSight API. 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 do tópico Q, adicione todas as permissões listadas na tabela.
| Operação de API | Política do IAM |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
O exemplo a seguir mostra uma política do IAM que permite que um usuário use a operação de API ListTopics.
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "quicksight:ListTopics" ], "Resource": "*" } ] }
Trabalhe com tópicos de QuickSight Q usando a QuickSight CLI
O exemplo a seguir cria um novo tópico Q.
aws quicksight create-topic --aws-account-idAWSACCOUNTID--topic-idTOPICID--topicTOPIC
Você também pode criar um tópico Q usando um arquivo de esqueleto da 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 Amazon Developer Guide. QuickSight
aws quicksight create-topic --cli-input-json file://createtopic.json
Quando você cria um novo tópico Q, 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 Configurar agendas de atualização de tópicos do Q com a CLI QuickSight .
Depois de criar seu primeiro tópico Q, você pode atualizar, excluir, listar ou solicitar um resumo de um tópico Q.
O exemplo a seguir atualiza um tópico Q.
aws quicksight update-topic --aws-account-idAWSACCOUNTID--topic-idTOPICID--topicTOPIC
Você também pode atualizar um tópico Q usando um arquivo de esqueleto da 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 Amazon Developer Guide. QuickSight
aws quicksight update-topic --cli-input-json file://updatetopic.json
O exemplo a seguir fornece uma lista de todos os tópicos Q em uma QuickSight conta.
aws quicksight list-topics --aws-account-idAWSACCOUNTID
O exemplo a seguir exclui um tópico Q.
aws quicksight delete-topic --aws-account-idAWSACCOUNTID--topic-idTOPICID
O exemplo a seguir fornece informações sobre como um tópico Q foi configurado.
aws quicksight describe-topic --aws-account-idAWSACCOUNTID--topic-idTOPICID
O comando a seguir atualiza as permissões de um tópico 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
Use o grant-permissions parâmetro para conceder permissões de leitura e autor aos usuários QuickSight da conta. 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 Q.
aws quicksight describe-topic-permissions --aws-account-idAWSACCOUNTID--topic-idTOPICID
Configurar agendas de atualização de tópicos do Q com a CLI QuickSight
O comando a seguir cria uma programação de atualização de um tópico Q.
aws quicksight create-topic-refresh-schedule --aws-account-idAWSACCOUNTID--topic-idTOPICID--dataset-arnDATASETARN--refresh-scheduleREFRESHSCHEDULE
Depois de criar uma programação de atualização para um tópico Q, você pode atualizar, excluir, listar ou solicitar um resumo da programação de atualização do tópico.
O comando a seguir atualiza a programação de atualização de um tópico Q.
aws quicksight update-topic-refresh-schedule --aws-account-idAWSACCOUNTID--topic-idTOPICID--dataset-idDATASETID--refresh-scheduleREFRESHSCHEDULE
O exemplo a seguir fornece uma lista de todas as programações de atualização configuradas para um tópico Q.
aws quicksight list-topic-refresh-schedules --aws-account-idAWSACCOUNTID--topic-idTOPICID
O exemplo a seguir exclui uma programação de atualização de tópicos.
aws quicksight delete-topic-refresh-schedule --aws-account-idAWSACCOUNTID--topic-idTOPICID--dataset-idDATASETID
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-idAWSACCOUNTID--topic-idTOPICID--dataset-idDATASETID
Copie e migre tópicos do QuickSight Q dentro e entre Contas da AWS
Você pode migrar seus tópicos do QuickSight Q de uma conta para outra com a interface de linha de QuickSight comando (CLI). Em vez de replicar manualmente o mesmo tópico em vários painéis, namespaces ou contas, você pode usar a QuickSight CLI para reutilizar o mesmo tópico repetidamente. Esse recurso economiza tempo QuickSight dos autores e cria uma experiência de tópico padronizada para leitores de painéis em vários painéis.
Para migrar tópicos do Q com a QuickSight CLI, use o procedimento a seguir
Migrar um tópico Q para outra conta
-
Primeiro, identifique o tópico que você deseja migrar. Você pode ver uma lista de todos os tópicos do Q em sua QuickSight conta com um comando de
list-topicsAPI.aws quicksight list-topics --aws-account-idAWSACCOUNTID -
Depois de ter uma lista de tópicos Q, localize o tópico que você deseja migrar e faça uma chamada
describe-topicpara receber uma estrutura JSON da configuração do tópico.aws quicksight describe-topic --aws-account-idAWSACCOUNTID--topic-idTOPICIDVeja 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" } -
Use a resposta JSON para criar um arquivo esqueleto que você pode inserir em uma nova
create-topicchamada em sua outra QuickSight conta. Antes de fazer uma chamada de API com o arquivo de esqueleto, certifique-se de alterar o ID da Conta da AWS e o ID do conjunto de dados no arquivo de esqueleto para que correspondam ao ID da Conta da AWS e ao ID do conjunto de dados aos quais você está adicionando o novo tópico Q. Para obter mais informações sobre arquivos de esqueleto de CLI, consulte Como usar arquivos de esqueleto de CLI no Amazon Developer Guide. QuickSightaws quicksight create-topic --aws-account-idAWSACCOUNTID\ --cli-input-jsonfile://./create-topic-cli-input.json
Depois de fazer uma create-topic chamada para a QuickSight API, o novo tópico aparece na sua conta. Para confirmar que o novo tópico existe, faça uma list-topics chamada para a QuickSight API. 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.
