Amazon Comprehend · Schema

PiiOutputDataConfig

Provides configuration parameters for the output of PII entity detection jobs.

Machine LearningNatural Language ProcessingNLPText Analysis

Properties

Name Type Description
S3Uri object
KmsKeyId object
View JSON Schema on GitHub

JSON Schema

openapi.yml-pii-output-data-config-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-schema/openapi.yml-pii-output-data-config-schema.json",
  "title": "PiiOutputDataConfig",
  "description": "Provides configuration parameters for the output of PII entity detection jobs.",
  "type": "object",
  "properties": {
    "S3Uri": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3Uri"
        },
        {
          "description": "<p>When you use the <code>PiiOutputDataConfig</code> object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. </p> <p> For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with <code>.out</code> appended at the end. </p>"
        }
      ]
    },
    "KmsKeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KmsKeyId"
        },
        {
          "description": "ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job."
        }
      ]
    }
  },
  "required": [
    "S3Uri"
  ]
}