Amazon QuickSight CLI를 사용하여 QuickSight Q 주제로 작업하기 - 아마존 QuickSight

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

Amazon QuickSight CLI를 사용하여 QuickSight Q 주제로 작업하기

 적용 대상: Enterprise Edition 
   대상 사용자: Amazon QuickSight 개발자 

이 섹션에서는 Amazon QuickSight 명령줄 인터페이스 (CLI) 를 사용하여 QuickSight Q 주제를 다루는 방법을 알아보십시오.

사전 조건

시작하기 전에 CLI 사용자에게 API 작업을 QuickSight 호출할 수 있는 액세스 권한을 부여하는 AWS Identity and Access Management (IAM) 역할이 있는지 확인하십시오. 다음 표에는 특정 API 작업을 사용하기 위해 IAM 정책에 추가해야 하는 권한이 나와 있습니다. Q 주제 API 작업을 모두 사용하려면 표에 나열된 모든 권한을 추가하세요.

API 작업 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

다음 예에서는 사용자가 ListTopics API 작업을 사용할 수 있도록 허용하는 IAM 정책을 보여줍니다.

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "quicksight:ListTopics" ], "Resource": "*" } ] }

QuickSight QuickSightCLI를 사용하여 Q 주제로 작업하기

다음 예에서는 새 Q 주제를 생성합니다.

aws quicksight create-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC

다음 명령으로 CLI 스켈레톤 파일을 사용하여 새 Q 주제를 생성할 수도 있습니다. CLI 스켈레톤 파일에 대한 자세한 내용은 Amazon 개발자 안내서의 CLI 스켈레톤 파일 사용을 참조하십시오. QuickSight

aws quicksight create-topic --cli-input-json file://createtopic.json

새 Q 주제를 생성할 때 데이터 세트 새로 고침 구성은 주제에 복사되지 않습니다. 새 주제에 대한 주제 새로 고침 일정을 설정하려면 create-topic-refresh-schedule API 호출을 만듭니다. CLI를 사용하여 주제 새로 고침 일정을 구성하는 방법에 대한 자세한 내용은 QuickSight CLI를 사용하여 Q 주제 새로 고침 일정 구성 섹션을 참조하세요.

첫 번째 Q 주제를 생성한 후 Q 주제를 업데이트, 삭제, 나열 또는 요약을 요청할 수 있습니다.

다음 예에서는 Q 주제를 업데이트합니다.

aws quicksight update-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC

다음 명령으로 CLI 스켈레톤 파일을 사용하여 Q 주제를 업데이트할 수도 있습니다. CLI 스켈레톤 파일에 대한 자세한 내용은 Amazon 개발자 안내서의 CLI 스켈레톤 파일 사용을 참조하십시오. QuickSight

aws quicksight update-topic --cli-input-json file://updatetopic.json

다음 예시는 계정의 모든 Q 주제 목록을 제공합니다. QuickSight

aws quicksight list-topics --aws-account-id AWSACCOUNTID

다음 예에서는 Q 주제를 삭제합니다.

aws quicksight delete-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID

다음 예에서는 Q 주제가 구성된 방법에 대한 정보를 제공합니다.

aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID

다음 명령은 Q 주제의 권한을 업데이트합니다.

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

grant-permissions파라미터를 사용하여 QuickSight 계정 사용자에게 읽기 및 작성자 권한을 부여할 수 있습니다. 계정 사용자에게 읽기 권한을 부여하려면 다음 "quicksight:DescribeTopic" 값을 입력합니다. 계정 사용자에게 권한을 부여하려면 다음 값을 입력합니다.

  • "quicksight:DescribeTopic"

  • "quicksight:DescribeTopicRefresh"

  • "quicksight:ListTopicRefreshSchedules"

  • "quicksight:DescribeTopicRefreshSchedule"

  • "quicksight:DeleteTopic"

  • "quicksight:UpdateTopic"

  • "quicksight:CreateTopicRefreshSchedule"

  • "quicksight:DeleteTopicRefreshSchedule"

  • "quicksight:UpdateTopicRefreshSchedule"

  • "quicksight:DescribeTopicPermissions"

  • "quicksight:UpdateTopicPermissions"

RevokePermissions 파라미터는 계정 사용자에게 부여된 모든 권한을 취소합니다.

다음 명령은 Q 주제의 모든 권한을 설명합니다.

aws quicksight describe-topic-permissions --aws-account-id AWSACCOUNTID --topic-id TOPICID

QuickSight CLI를 사용하여 Q 주제 새로 고침 일정 구성

다음 명령은 Q 주제의 새로 고침 일정을 생성합니다.

aws quicksight create-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-arn DATASETARN --refresh-schedule REFRESHSCHEDULE

Q 주제에 대한 새로 고침 일정을 만든 후에는 해당 주제의 새로 고침 일정을 업데이트, 삭제, 나열 또는 요약을 요청할 수 있습니다.

다음 명령은 Q 주제의 새로 고침 스케줄을 업데이트합니다.

aws quicksight update-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID --refresh-schedule REFRESHSCHEDULE

다음 예에서는 Q 주제에 구성된 모든 새로 고침 일정 목록을 제공합니다.

aws quicksight list-topic-refresh-schedules --aws-account-id AWSACCOUNTID --topic-id TOPICID

다음 예에서는 주제 새로 고침 일정을 삭제합니다.

aws quicksight delete-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID

다음 예에서는 주제 새로 고침 일정이 구성된 방법에 대한 정보를 제공합니다.

aws quicksight describe-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID

QuickSight Q 주제 내에서 또는 그 사이에서 Q 주제를 복사하고 마이그레이션할 수 있습니다. AWS 계정

QuickSight 명령줄 인터페이스 (CLI) 를 사용하여 한 계정에서 다른 계정으로 QuickSight Q 주제를 마이그레이션할 수 있습니다. 여러 대시보드, 네임스페이스 또는 계정에서 동일한 주제를 수동으로 복제하는 대신 QuickSight CLI를 사용하여 동일한 주제를 반복적으로 재사용할 수 있습니다. 이 기능을 사용하면 QuickSight 작성자의 시간이 절약되고 여러 대시보드의 대시보드 리더에게 표준화된 주제 환경을 제공할 수 있습니다.

QuickSight CLI를 사용하여 Q 토픽을 마이그레이션하려면 다음 절차를 사용하십시오.

Q 주제를 다른 계정으로 마이그레이션하려면
  1. 먼저 마이그레이션하려는 주제를 식별합니다. list-topicsAPI 명령으로 QuickSight 계정의 모든 Q 주제 목록을 볼 수 있습니다.

    aws quicksight list-topics --aws-account-id AWSACCOUNTID
  2. Q 주제 목록이 생성되면 마이그레이션하려는 주제를 찾아 해당 주제 구성의 JSON 구조를 받기 위해 describe-topic을 직접 호출하세요.

    aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID

    다음은 describe-topic API 응답의 예입니다.

    { "Status": 200, "TopicId": "TopicExample", "Arn": "string", "Topic": [ { "Name": "{}", "DataSets": [ { "DataSetArn": "{}", "DataSetName": "{}", "DataSetDescription": "{}", "DataAggregation": "{}", "Filters": [], "Columns": [], "CalculatedFields": [], "NamedEntities": [] } ] } ], "RequestId": "requestId" }
  3. JSON 응답을 사용하여 다른 계정의 새 create-topic 호출에 입력할 수 있는 스켈레톤 파일을 만드세요. QuickSight 스켈레톤 파일로 API를 호출하기 전에 스켈레톤 파일의 AWS 계정 ID 및 데이터 세트 ID를 새 Q 주제를 추가할 ID 및 데이터 세트 AWS 계정 ID와 일치하도록 변경했는지 확인합니다. CLI 스켈레톤 파일에 대한 자세한 내용은 Amazon 개발자 안내서의 CLI 스켈레톤 파일 사용을 참조하십시오. QuickSight

    aws quicksight create-topic --aws-account-id AWSACCOUNTID \ --cli-input-json file://./create-topic-cli-input.json

QuickSight API를 create-topic 호출하면 새 주제가 계정에 나타납니다. 새 주제가 존재하는지 확인하려면 QuickSight API를 list-topics 호출하세요. 복제된 원본 항목에 검증된 답변이 포함된 경우 답변은 새 주제로 마이그레이션되지 않습니다. 원래 주제에 대해 구성된 모든 검증된 답변 목록을 보려면 describe-topic API 호출을 사용하세요.