StartPiiEntitiesDetectionJob - Amazon Comprehend
リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素Errors以下の資料も参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

StartPiiEntitiesDetectionJob

ドキュメントのコレクション用に非同期 PII エンティティ検出ジョブを開始します。

リクエストの構文

{
   "ClientRequestToken": "string",
   "DataAccessRoleArn": "string",
   "InputDataConfig": { 
      "DocumentReaderConfig": { 
         "DocumentReadAction": "string",
         "DocumentReadMode": "string",
         "FeatureTypes": [ "string" ]
      },
      "InputFormat": "string",
      "S3Uri": "string"
   },
   "JobName": "string",
   "LanguageCode": "string",
   "Mode": "string",
   "OutputDataConfig": { 
      "KmsKeyId": "string",
      "S3Uri": "string"
   },
   "RedactionConfig": { 
      "MaskCharacter": "string",
      "MaskMode": "string",
      "PiiEntityTypes": [ "string" ]
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

リクエストパラメータ

すべてのアクションに共通のパラメータについては、「」を参照してください。共通パラメータ。

リクエストは以下のデータを JSON 形式で受け入れます。

ClientRequestToken

リクエストの一意の識別子。クライアントリクエストトークンを設定しないと、Amazon Comprehend が生成します。

Type: 文字列

制約: 最小長は 1 です｡ 最大長は 64 です。

Pattern: ^[a-zA-Z0-9-]+$

: 必須 いいえ

DataAccessRoleArn

入力データへの Amazon Comprehend () の読み取りアクセスを付与する AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN)。

Type: 文字列

制約: 最小長は 20 です｡ 最大長は 2048 です。

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

: 必須 はい

InputDataConfig

PII エンティティ検出ジョブの入力プロパティ。

タイプ: InputDataConfig オブジェクト

: 必須 はい

JobName

ジョブの識別子。

Type: 文字列

制約: 最小長は 1 です｡ 最大長は 256 です。

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

: 必須 いいえ

LanguageCode

入力ドキュメントの言語。

Type: 文字列

有効な値: en

: 必須 はい

Mode

PII エンティティの位置 (オフセット) を出力するか、PII エンティティが編集されるファイルのどちらを提供するかを指定します。

Type: 文字列

有効な値: ONLY_REDACTION | ONLY_OFFSETS

: 必須 はい

OutputDataConfig

PII エンティティ検出ジョブの出力の設定パラメータを提供します。

タイプ: OutputDataConfig オブジェクト

: 必須 はい

RedactionConfig

PII エンティティの墨消しの設定パラメータを提供します。

このパラメータは必須です。ModeパラメータをONLY_REDACTION。その場合、RedactionConfigを含む定義PiiEntityTypesパラメータ。

タイプ: RedactionConfig オブジェクト

: 必須 いいえ

Tags

PII エンティティ検出ジョブに関連付けるタグ。タグは Amazon Comprehend で使用されるリソースにメタデータを追加するキーと値のペアです。たとえば、「Sales」をキーとするタグがリソースに追加され、営業部門による使用を示す場合があります。

Type: 配列配列Tagobjects

: 必須 いいえ

レスポンスの構文

{
   "JobArn": "string",
   "JobId": "string",
   "JobStatus": "string"
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

JobArn

PII エンティティ検出ジョブの Amazon リソースネーム (ARN)。これは、ジョブの一意の完全修飾識別子です。これには、AWS アカウント、リージョン、およびジョブ ID が含まれます。ARN の形式は次のとおりです。

arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>

ジョブ ARN の例を以下に示します。

arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Type: 文字列

制約: 最大長は 256 です。

Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

JobId

ジョブ識別子。

Type: 文字列

制約: 最小長は 1 です｡ 最大長は 32 です。

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

JobStatus

ジョブのステータス。

Type: 文字列

有効な値: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED

Errors

すべてのアクションに共通のエラーについては、「一般的なエラー」を参照してください。

InternalServerException

内部サーバーエラーが発生しました。リクエストを再実行します。

HTTP ステータスコード: 500

InvalidRequestException

リクエストは無効でした。

HTTP ステータスコード: 400

KmsKeyValidationException

入力された KMS カスタマー管理キー (CMK) を検証できません。キーを確認し、もう一度入力してください。

HTTP ステータスコード: 400

TooManyRequestsException

リクエストの数が制限を超えています。後でリクエストを再送信してください。

HTTP ステータスコード: 400

TooManyTagsException

リクエストには、リソースに関連付けることができるより多くのタグが含まれています (リソースあたり 50 タグ)。タグの最大数には、既存のタグと現在のリクエストに含まれるタグの両方が含まれます。

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください。