Resource Sensitivity Profile - Detections

The Resource Sensitivity Profile Detections resource provides information about the types and amount of sensitive data that Amazon Macie has found in individual Amazon Simple Storage Service (Amazon S3) buckets for your account. If you're the Macie administrator for an organization, this includes S3 buckets that your member accounts own.

For each S3 bucket, the information includes an inventory of the types of sensitive data that Macie has found and the number of occurrences of each type. It also includes details about the custom data identifier or managed data identifier that detected each type. The information captures the results of automated sensitive data discovery activities that Macie has performed for an S3 bucket. For more information, see Performing automated sensitive data discovery in the Amazon Macie User Guide.

This resource also provides access to the sensitivity scoring settings for individual S3 buckets. By default, Macie calculates a bucket's sensitivity score based partly on the amount of sensitive data that Macie has found in a bucket. If you're a Macie administrator or you have a standalone Macie account, you can optionally adjust these calculations by excluding (suppressing) or including specific types of sensitive data in a bucket's score.

You can use the Resource Sensitivity Profile Detections resource to retrieve information about the types and amount of sensitive data that Macie has found in an S3 bucket. If you're a Macie administrator or you have a standalone Macie account, you can also use this resource to adjust the sensitivity scoring settings for a bucket.

To use this resource, you must first enable automated sensitive data discovery. To enable it for an organization or a standalone account, use the Configuration resource for automated sensitive data discovery. To enable it for a member account in an organization, use the Accounts resource for automated sensitive data discovery.

URI

/resource-profiles/detections

HTTP methods

GET

Operation ID: ListResourceProfileDetections

Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.

PATCH

Operation ID: UpdateResourceProfileDetections

Updates the sensitivity scoring settings for an S3 bucket.

Schemas

Request bodies

{
  "suppressDataIdentifiers": [
    {
      "id": "string",
      "type": enum
    }
  ]
}

Response bodies

{
  "detections": [
    {
      "arn": "string",
      "count": integer,
      "id": "string",
      "name": "string",
      "suppressed": boolean,
      "type": enum
    }
  ],
  "nextToken": "string"
}

{
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

Properties

AccessDeniedException

Provides information about an error that occurred due to insufficient access to a specified resource.

DataIdentifierType

The type of data identifier that detected a specific type of sensitive data in an S3 bucket. Possible values are:

Detection

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

Empty

The request succeeded and there isn't any content to include in the body of the response (No Content).

InternalServerException

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ListResourceProfileDetectionsResponse

Provides information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket while performing automated sensitive data discovery for an account. This information is available only if automated sensitive data discovery has been enabled for the account.

ResourceNotFoundException

Provides information about an error that occurred because a specified resource wasn't found.

ServiceQuotaExceededException

Provides information about an error that occurred due to one or more service quotas for an account.

SuppressDataIdentifier

Specifies a custom data identifier or managed data identifier that detected a type of sensitive data to start excluding or including in an S3 bucket's sensitivity score.

ThrottlingException

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

UpdateResourceProfileDetectionsRequest

Updates the sensitivity scoring settings for an S3 bucket that Amazon Macie monitors and analyzes for an account. The settings specify whether to exclude or include occurrences of specific types of sensitive data in the bucket's sensitivity score. To update the settings, automated sensitive data discovery must be enabled for the account.

ValidationException

Provides information about an error that occurred due to a syntax error in a request.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListResourceProfileDetections

UpdateResourceProfileDetections