Amazon Comprehend · JSON Structure

Openapi.Yml Pii Output Data Config Structure

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

Type: object Properties: 2 Required: 1
Machine LearningNatural Language ProcessingNLPText Analysis

PiiOutputDataConfig is a JSON Structure definition published by Amazon Comprehend, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

S3Uri KmsKeyId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-pii-output-data-config-structure.json",
  "name": "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"
  ]
}