EntityRecognizerProperties

{
  "$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-entity-recognizer-properties-schema.json",
  "title": "EntityRecognizerProperties",
  "description": "Describes information about an entity recognizer.",
  "type": "object",
  "properties": {
    "EntityRecognizerArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityRecognizerArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) that identifies the entity recognizer."
        }
      ]
    },
    "LanguageCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LanguageCode"
        },
        {
          "description": " The language of the input documents. All documents must be in the same language. Only English (\"en\") is currently supported."
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ModelStatus"
        },
        {
          "description": "Provides the status of the entity recognizer."
        }
      ]
    },
    "Message": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AnyLengthString"
        },
        {
          "description": " A description of the status of the recognizer."
        }
      ]
    },
    "SubmitTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time that the recognizer was submitted for processing."
        }
      ]
    },
    "EndTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time that the recognizer creation completed."
        }
      ]
    },
    "TrainingStartTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time that training of the entity recognizer started."
        }
      ]
    },
    "TrainingEndTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time that training of the entity recognizer was completed."
        }
      ]
    },
    "InputDataConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityRecognizerInputDataConfig"
        },
        {
          "description": "The input data properties of an entity recognizer."
        }
      ]
    },
    "RecognizerMetadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityRecognizerMetadata"
        },
        {
          "description": " Provides information about an entity recognizer."
        }
      ]
    },
    "DataAccessRoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IamRoleArn"
        },
        {
          "description": " The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data."
        }
      ]
    },
    "VolumeKmsKeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KmsKeyId"
        },
        {
          "description": "<p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId 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>"
        }
      ]
    },
    "VpcConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VpcConfig"
        },
        {
          "description": " Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html\">Amazon VPC</a>. "
        }
      ]
    },
    "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>"
        }
      ]
    },
    "VersionName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VersionName"
        },
        {
          "description": "The version name you assigned to the entity recognizer."
        }
      ]
    },
    "SourceModelArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityRecognizerArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account."
        }
      ]
    },
    "FlywheelArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComprehendFlywheelArn"
        },
        {
          "description": "The Amazon Resource Number (ARN) of the flywheel"
        }
      ]
    },
    "OutputDataConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityRecognizerOutputDataConfig"
        },
        {
          "description": "Output data configuration."
        }
      ]
    }
  }
}