Amazon Macie · Schema

SimpleScopeTerm

Specifies a property-based condition that determines whether an S3 object is included or excluded from a classification job.

Data SecuritySensitive DataPrivacyComplianceMachine LearningS3

Properties

Name Type Description
comparator object
key object
values object
View JSON Schema on GitHub

JSON Schema

amazon-macie-simple-scope-term-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-macie/refs/heads/main/json-schema/amazon-macie-simple-scope-term-schema.json",
  "title": "SimpleScopeTerm",
  "description": "Specifies a property-based condition that determines whether an S3 object is included or excluded from a classification job.",
  "type": "object",
  "properties": {
    "comparator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobComparator"
        },
        {
          "description": "<p>The operator to use in the condition. Valid values for each supported property (key) are:</p> <ul><li><p>OBJECT_EXTENSION - EQ (equals) or NE (not equals)</p></li> <li><p>OBJECT_KEY - STARTS_WITH</p></li> <li><p>OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS</p></li> <li><p>OBJECT_SIZE - Any operator except CONTAINS</p></li></ul>"
        }
      ]
    },
    "key": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScopeFilterKey"
        },
        {
          "description": "The object property to use in the condition."
        }
      ]
    },
    "values": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOf__string"
        },
        {
          "description": "<p>An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.</p> <p>Valid values for each supported property (key) are:</p> <ul><li><p>OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf</p></li> <li><p>OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.</p></li> <li><p>OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z</p></li> <li><p>OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.</p></li></ul> <p>Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.</p>"
        }
      ]
    }
  }
}