Amazon Macie · JSON Structure

Amazon Macie Detection Structure

Provides information about a type of sensitive data that Amazon Macie found in an S3 bucket while performing automated sensitive data discovery for the bucket. The information also specifies the custom data identifier or managed data identifier that detected the data. This information is available only if automated sensitive data discovery is currently enabled for your account.

Type: object Properties: 6
Data SecuritySensitive DataPrivacyComplianceMachine LearningS3

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

Properties

arn count id name suppressed type

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-macie/refs/heads/main/json-structure/amazon-macie-detection-structure.json",
  "name": "Detection",
  "description": "Provides information about a type of sensitive data that Amazon Macie found in an S3 bucket while performing automated sensitive data discovery for the bucket. The information also specifies the custom data identifier or managed data identifier that detected the data. This information is available only if automated sensitive data discovery is currently enabled for your account.",
  "type": "object",
  "properties": {
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data. Otherwise, this value is null."
        }
      ]
    },
    "count": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__long"
        },
        {
          "description": "The total number of occurrences of the sensitive data."
        }
      ]
    },
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data. For additional details about a specified managed data identifier, see <a href=\"https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html\">Using managed data identifiers</a> in the <i>Amazon Macie User Guide</i>."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The name of the custom data identifier or managed data identifier that detected the sensitive data. For a managed data identifier, this value is the same as the unique identifier (id)."
        }
      ]
    },
    "suppressed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "description": "Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score."
        }
      ]
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataIdentifierType"
        },
        {
          "description": "The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier."
        }
      ]
    }
  }
}