

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

# 비동기 작업으로 PII 개체 수정(API)
<a name="redact-api-pii"></a>

텍스트의 PII 개체를 수정하려면 비동기 일괄 작업을 시작합니다. 이 작업을 실행하려면 Amazon S3에 문서를 업로드하고 [StartPiiEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartPiiEntitiesDetectionJob.html) 요청을 제출하세요.

**Topics**
+ [시작하기 전에](#redact-pii-before)
+ [입력 파라미터](#redact-pii-api-inputs)
+ [출력 파일 형식](#redact-pii-api-outputs)
+ [를 사용한 PII 수정 AWS Command Line Interface](#redact-pii-api-cli)

## 시작하기 전에
<a name="redact-pii-before"></a>

시작하기 전에 다음 사항을 확인해야 합니다.
+ **입력 및 출력 버킷** - 입력 파일 및 출력 파일에 사용하려는 Amazon S3 버킷을 식별합니다. 버킷은 사용자가 호출하는 API와 동일한 리전에 있어야 합니다.
+ **IAM 서비스 역할** - 입력 및 출력 버킷에 액세스하려면 권한이 있는 IAM 서비스 역할이 필요합니다. 자세한 내용은 [비동기 작업에 필요한 역할 기반 권한](security_iam_id-based-policy-examples.md#auth-role-permissions)을 참조하십시오.

## 입력 파라미터
<a name="redact-pii-api-inputs"></a>

요청 시 다음의 필수적인 파라미터를 포함시킵니다.
+ `InputDataConfig` — 요청에 [InputDataConfig](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_InputDataConfig.html) 정의를 제공합니다. 여기에는 작업에 대한 입력 속성이 포함되어야 합니다. `S3Uri` 파라미터에서 입력 문서의 Amazon S3 위치를 지정합니다.
+ `OutputDataConfig` — 요청에 [OutputDataConfig](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_OutputDataConfig.html) 정의를 제공합니다. 여기에는 작업에 대한 입력 속성이 포함되어야 합니다. `S3Uri` 파라미터에서 Amazon Comprehend가 분석 결과를 기록하는 Amazon S3 위치를 지정하십시오.
+ `DataAccessRoleArn` – AWS Identity and Access Management 역할의 Amazon 리소스 이름(ARN)을 제공하십시오. 이 역할은 Amazon Comprehend에 입력 데이터에 대한 읽기 액세스 권한과 Amazon S3 내 출력 위치에 대한 쓰기 액세스 권한을 부여해야 합니다. 자세한 내용은 [비동기 작업에 필요한 역할 기반 권한](security_iam_id-based-policy-examples.md#auth-role-permissions)을 참조하십시오.
+ `Mode` - 이 파라미터를 `ONLY_REDACTION`로 설정합니다. 이 설정을 사용하면 Amazon Comprehend는 입력 문서의 사본을 Amazon S3의 출력 위치에 기록합니다. 이 사본에서는 각 PII 개체가 수정됩니다.
+ `RedactionConfig` — 요청에 [RedActionConfig](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_RedactionConfig.html) 정의를 제공합니다. 여기에는 수정을 위한 구성 파라미터가 포함됩니다. 수정할 PII의 유형을 지정하고 각 PII 개체를 해당 유형의 이름 또는 원하는 문자로 대체할지 여부를 지정합니다.
  + `PiiEntityTypes` 배열에서 수정할 PII 개체 유형을 지정합니다. 모든 개체 유형을 수정하려면 배열 값을 `["ALL"]`로 설정합니다.
  + 각 PII 개체를 해당 유형으로 바꾸려면 `MaskMode` 파라미터를 `REPLACE_WITH_PII_ENTITY_TYPE`로 설정합니다. 예를 들어 이 설정을 사용하면 PII 개체 “아무개(Jane Doe)”가 “[이름]”으로 대체됩니다.
  + 각 PII 개체의 문자를 귀하가 선택하는 문자로 바꾸려면 `MaskMode` 파라미터를 `MASK`로 설정하고 `MaskCharacter` 파라미터를 대체 문자로 설정합니다. 문자는 한 개만 제공하십시오. 유효한 문자는 \$1, \$1, \$1, %, &, \$1, 및 @입니다. 예를 들어 이 설정을 사용하면 PII 개체 “아무개(Jane Doe)”를 “\$1\$1\$1 \$1\$1\$1"로 바꿀 수 있습니다.
+ `LanguageCode` -이 파라미터를 `en` 또는 로 설정합니다`es`. Amazon Comprehend는 영어 또는 스페인어 텍스트로 PII 감지를 지원합니다.

## 출력 파일 형식
<a name="redact-pii-api-outputs"></a>

다음 예제는 PII를 수정하는 분석 작업의 입력 및 출력 파일을 보여줍니다. 입력 형식은 한 줄에 한 문서입니다.

```
{
Managing Your Accounts Primary Branch Canton John Doe Phone Number 443-573-4800 123 Main StreetBaltimore, MD 21224
Online Banking HowardBank.com  Telephone 1-877-527-2703 Bank 3301 Boston Street, Baltimore, MD 21224
```

이 입력 파일을 수정하는 분석 작업은 다음과 같은 출력 파일을 생성합니다.

```
{
Managing Your Accounts Primary Branch ****** ******** Phone Number ************ **********************************
Online Banking **************  Telephone ************** Bank ***************************************     
 }
```

## 를 사용한 PII 수정 AWS Command Line Interface
<a name="redact-pii-api-cli"></a>

다음 예제에서는 AWS CLI로 `StartPiiEntitiesDetectionJob` 작업을 사용합니다.

다음은 Unix, Linux, macOS용 형식으로 지정된 예제입니다. Windows의 경우 각 줄의 끝에 있는 백슬래시(\$1) Unix 연속 문자를 캐럿(^)으로 바꿉니다.

```
aws comprehend start-pii-entities-detection-job \
    --region region \
    --job-name job name \
    --cli-input-json file://path to JSON input file
```

`cli-input-json` 파라미터에는 다음 예시에 표시된 대로 요청 데이터가 포함된 JSON 파일의 경로를 제공해야 합니다.

```
{
    "InputDataConfig": {
        "S3Uri": "s3://input bucket/input path",
        "InputFormat": "ONE_DOC_PER_LINE"
    },
    "OutputDataConfig": {
        "S3Uri": "s3://output bucket/output path"
    },
    "DataAccessRoleArn": "arn:aws:iam::account ID:role/data access role"
    "LanguageCode": "en",
    "Mode": "ONLY_REDACTION"
    "RedactionConfig": {
        "MaskCharacter": "*",
        "MaskMode": "MASK",
        "PiiEntityTypes": ["ALL"]
    }
}
```

이벤트 감지 작업을 시작하는 요청이 받아들여지면 다음과 유사한 응답을 받게 됩니다.

```
{
  "JobId": "7c4fbe6e...e5b"
  "JobArn":  "arn:aws:comprehend:us-west-2:123456789012:pii-entities-detection-job/7c4fbe6e...e5b" 
  "JobStatus": "SUBMITTED",   
}
```

[DescribeEventsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEventsDetectionJob.html) 작업을 사용하여 기존 작업의 상태를 얻을 수 있습니다.

```
aws comprehend describe-pii-entities-detection-job \
    --region region \
    --job-id job ID
```

작업이 성공적으로 완료되면 다음과 비슷한 응답을 받게 됩니다.

```
{
  "PiiEntitiesDetectionJobProperties": {
     "JobId": "7c4fbe6e...e5b"
     "JobArn":  "arn:aws:comprehend:us-west-2:123456789012:pii-entities-detection-job/7c4fbe6e...e5b" 
     "JobName": "piiCLIredtest1",
     "JobStatus": "COMPLETED",
     "SubmitTime": "2022-05-05T14:54:06.169000-07:00",
     "EndTime": "2022-05-05T15:00:17.007000-07:00",
     "InputDataConfig": {
        (identical to the input data that you provided with the request)
  }
}
```