

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

# Amazon Quick Sight APIs를 사용하여 Quick Sight 주제 작업
<a name="topics-cli"></a>


|  | 
| --- |
|  적용 대상: Enterprise Edition  | 


|  | 
| --- |
|    대상:  Amazon Quick 개발자  | 

이 섹션에서는 Amazon Quick Sight 명령줄 인터페이스(CLI)를 사용하여 Quick Sight 주제를 사용하는 방법을 알아봅니다.

**사전 조건**

시작하기 전에 Quick Sight API 작업을 호출할 수 있는 액세스 권한을 CLI 사용자에게 부여하는 AWS Identity and Access Management (IAM) 역할이 있는지 확인합니다. 다음 표에는 특정 API 작업을 사용하기 위해 IAM 정책에 추가해야 하는 권한이 나와 있습니다. 모든 주제 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`  | 
|  `BatchCreateTopicReviewedAnswer`  |  `quicksight:BatchCreateTopicReviewedAnswer`  | 
|  `BatchDeleteTopicReviewedAnswer`  |  `quicksight:BatchDeleteTopicReviewedAnswer`  | 
|  `ListTopicReviewedAnswers`  |  `quicksight:ListTopicReviewedAnswers`  | 

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

------
#### [ JSON ]

****  

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

------

Quick Sight APIs를 사용하여 Quick Sight 주제를 생성하도록 권한을 구성한 후 다음 주제를 사용하여 Quick Sight 주제 APIs.

**Topics**
+ [Quick Sight APIs를 사용하여 Quick Sight 주제 작업](topic-cli-examples.md)
+ [Quick Sight CLI를 사용하여 Quick Sight 주제 새로 고침 일정 구성](topic-refresh-apis.md)
+ [내부 및 사이의 Quick Sight 주제 복사 및 마이그레이션 AWS 계정](topic-cli-walkthroughs.md)
+ [Quick Sight APIs를 사용하여 Quick Sight 주제에서 검토된 답변 생성 및 수정](topic-reviewed-answer-apis.md)

# Quick Sight APIs를 사용하여 Quick Sight 주제 작업
<a name="topic-cli-examples"></a>

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

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

다음 명령과 함께 CLI 스켈레톤 파일을 사용하여 새 주제를 생성할 수도 있습니다. CLI 스켈레톤 파일에 대한 자세한 내용은 *Amazon Quick Sight 개발자 안내서*의 [CLI 스켈레톤 파일 사용을](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) 참조하세요.

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

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

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

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

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

다음 명령과 함께 CLI 스켈레톤 파일을 사용하여 주제를 업데이트할 수도 있습니다. CLI 스켈레톤 파일에 대한 자세한 내용은 *Amazon Quick Sight 개발자 안내서*의 [CLI 스켈레톤 파일 사용을](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) 참조하세요.

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

다음 예제에서는 Quick 계정의 모든 주제 목록을 제공합니다.

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

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

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

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

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

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

```
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:DescribeTopic"` 값을 입력합니다. 계정 사용자에게 권한을 부여하려면 다음 값을 입력합니다.
+ `"quicksight:DescribeTopic"`
+ `"quicksight:DescribeTopicRefresh"`
+ `"quicksight:ListTopicRefreshSchedules"`
+ `"quicksight:DescribeTopicRefreshSchedule"`
+ `"quicksight:DeleteTopic"`
+ `"quicksight:UpdateTopic"`
+ `"quicksight:CreateTopicRefreshSchedule"`
+ `"quicksight:DeleteTopicRefreshSchedule"`
+ `"quicksight:UpdateTopicRefreshSchedule"`
+ `"quicksight:DescribeTopicPermissions"`
+ `"quicksight:UpdateTopicPermissions"`

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

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

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

Quick Sight 주제를 생성한 후 Amazon Quick Sight APIs[를 사용하여 주제 새로 고침 일정을 구성](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-refresh-apis)하고, [계정 내 또는 계정 간에 Quick Sight 주제를 마이그레이션](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-cli-walkthroughs)하고, [ 검토된 답변을 생성할](https://docs.aws.amazon.com/quicksuite/latest/userguide/topic-reviewed-answer-apis) 수 있습니다.

# Quick Sight CLI를 사용하여 Quick Sight 주제 새로 고침 일정 구성
<a name="topic-refresh-apis"></a>

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

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

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

다음 명령은 주제의 새로 고침 일정을 업데이트합니다.

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

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

```
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
```

# 내부 및 사이의 Quick Sight 주제 복사 및 마이그레이션 AWS 계정
<a name="topic-cli-walkthroughs"></a>

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

Quick Sight CLI를 사용하여 주제를 마이그레이션하려면 다음 절차를 사용합니다.

**주제를 다른 계정으로 마이그레이션하려면**

1. 먼저 마이그레이션하려는 주제를 식별합니다. `list-topics` API 명령을 사용하여 Quick 계정의 모든 주제 목록을 볼 수 있습니다.

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

1. 주제 목록이 있으면 마이그레이션하려는 주제를 찾아 주제 구성의 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"
       }
   ```

1. JSON 응답을 사용하여 다른 Quick 계정의 새 `create-topic` 호출에 입력할 수 있는 스켈레톤 파일을 생성합니다. 스켈레톤 파일로 API를 호출하기 전에 새 주제를 추가하려는 AWS 계정 ID 및 데이터 세트 ID와 일치하도록 스켈레톤 파일의 AWS 계정 ID 및 데이터 세트 ID를 변경해야 합니다. CLI 스켈레톤 파일에 대한 자세한 내용은 *Amazon Quick Sight 개발자 안내서*의 [CLI 스켈레톤 파일 사용을](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) 참조하세요.

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

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

# Quick Sight APIs를 사용하여 Quick Sight 주제에서 검토된 답변 생성 및 수정
<a name="topic-reviewed-answer-apis"></a>

Quick Sight 주제를 생성한 후 Quick Sight APIs를 사용하여 주제에 대해 다시 생성된 답변을 생성, 나열, 업데이트 및 삭제할 수 있습니다.

아래 배치 명령은 Quick Sight 주제에 대해 최대 100개의 검토된 답변을 생성합니다.

```
aws quicksight batch-create-topic-reviewed-answer \
--topic-id TOPICID \
--aws-account-id AWSACCOUNTID \                 
—answers ANSWERS
```

다음 명령을 사용하여 CLI 스켈레톤 파일에서 검토된 답변을 일괄 생성할 수도 있습니다. CLI 스켈레톤 파일에 대한 자세한 내용은 *Amazon Quick Sight 개발자 안내서*의 [CLI 스켈레톤 파일 사용을](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) 참조하세요.

```
aws quicksight batch-create-topic-reviewed-answer \ 
--cli-input-json file://createTopicReviewedAnswer.json
```

아래 명령은 Quick Sight 주제에서 검토된 모든 답변을 나열합니다.

```
aws quicksight list-topic-reviewed-answers \
--aws-account-id AWSACCOUNTID \
--topic-id TOPICID \
```

아래 예제는 주제에서 최대 100개의 검토된 답변을 일괄 삭제합니다.

```
aws quicksight batch-delete-topic-reviewed-answer \
--topic-id TOPICID \
--aws-account-id AWSACCOUNTID \                 
—answer-ids: ["AnswerId1, AnswerId2…"]
```

다음 명령을 사용하여 CLI 스켈레톤 파일에서 주제에서 검토된 답변을 일괄 생성할 수도 있습니다. CLI 스켈레톤 파일에 대한 자세한 내용은 *Amazon Quick Sight 개발자 안내서*의 [CLI 스켈레톤 파일 사용을](https://docs.aws.amazon.com/quicksight/latest/developerguide/cli-skeletons.html) 참조하세요.

```
aws quicksight batch-delete-topic-reviewed-answer \
--cli-input-json file://deleteTopicReviewedAnswer.json
```

검토된 답변을 업데이트하려면 `batch-delete-topic-reviewed-answer` API를 사용하여 주제에서 기존 답변을 삭제합니다. 그런 다음 `batch-create-topic-reviewed-answer` API를 사용하여 업데이트된 검토된 답변을 주제에 추가합니다.