Amazon Comprehend · JSON Structure

Openapi.Yml Data Security Config Structure

Data security configuration.

Type: object Properties: 4
Machine LearningNatural Language ProcessingNLPText Analysis

DataSecurityConfig is a JSON Structure definition published by Amazon Comprehend, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ModelKmsKeyId VolumeKmsKeyId DataLakeKmsKeyId VpcConfig

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-data-security-config-structure.json",
  "name": "DataSecurityConfig",
  "description": "Data security configuration.",
  "type": "object",
  "properties": {
    "ModelKmsKeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KmsKeyId"
        },
        {
          "description": "<p>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:</p> <ul> <li> <p>KMS Key ID: <code>\"1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> <li> <p>Amazon Resource Name (ARN) of a KMS Key: <code>\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> </ul>"
        }
      ]
    },
    "VolumeKmsKeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KmsKeyId"
        },
        {
          "description": "ID for the KMS key that Amazon Comprehend uses to encrypt the volume."
        }
      ]
    },
    "DataLakeKmsKeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KmsKeyId"
        },
        {
          "description": "ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake."
        }
      ]
    },
    "VpcConfig": {
      "$ref": "#/components/schemas/VpcConfig"
    }
  }
}