Resource Sensitivity Profile - Detections - Amazon Macie

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. 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 of sensitive data. 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. You can optionally adjust these calculations by excluding (suppressing) or including specific types of sensitive data in a bucket's score.

If automated sensitive data discovery is currently enabled for your account, 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. You can also use this resource to adjust the sensitivity scoring settings for a bucket.

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.

Query parameters
NameTypeRequiredDescription
resourceArnStringTrue

The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.

nextTokenStringFalse

The nextToken string that specifies which page of results to return in a paginated response.

maxResultsStringFalse

The maximum number of items to include in each page of a paginated response.

Responses
Status codeResponse modelDescription
200ListResourceProfileDetectionsResponse

The request succeeded.

400ValidationException

The request failed because the input doesn't satisfy the constraints specified by the service.

402ServiceQuotaExceededException

The request failed because fulfilling the request would exceed one or more service quotas for your account.

403AccessDeniedException

The request was denied because you don't have sufficient access to the specified resource.

404ResourceNotFoundException

The request failed because the specified resource wasn't found.

429ThrottlingException

The request failed because you sent too many requests during a certain amount of time.

500InternalServerException

The request failed due to an unknown internal server error, exception, or failure.

PATCH

Operation ID: UpdateResourceProfileDetections

Updates the sensitivity scoring settings for an S3 bucket.

Query parameters
NameTypeRequiredDescription
resourceArnStringTrue

The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.

Responses
Status codeResponse modelDescription
200Empty Schema

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

400ValidationException

The request failed because the input doesn't satisfy the constraints specified by the service.

402ServiceQuotaExceededException

The request failed because fulfilling the request would exceed one or more service quotas for your account.

403AccessDeniedException

The request was denied because you don't have sufficient access to the specified resource.

404ResourceNotFoundException

The request failed because the specified resource wasn't found.

429ThrottlingException

The request failed because you sent too many requests during a certain amount of time.

500InternalServerException

The request failed due to an unknown internal server error, exception, or failure.

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.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

DataIdentifierType

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

  • CUSTOM

  • MANAGED

Detection

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.

PropertyTypeRequiredDescription
arn

string

False

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

integer

Format: int64

False

The total number of occurrences of the sensitive data.

id

string

False

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 Using managed data identifiers in the Amazon Macie User Guide.

name

string

False

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

boolean

False

Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score.

type

DataIdentifierType

False

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.

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.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

ListResourceProfileDetectionsResponse

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

PropertyTypeRequiredDescription
detections

Array of type Detection

True

An array of objects, one for each type of sensitive data that Amazon Macie found in the bucket. Each object reports the number of occurrences of the specified type and provides information about the custom data identifier or managed data identifier that detected the data.

nextToken

string

False

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

ResourceNotFoundException

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

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

ServiceQuotaExceededException

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

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

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.

PropertyTypeRequiredDescription
id

string

False

The unique identifier for the custom data identifier or managed data identifier that detected the type of sensitive data to exclude or include in the score.

type

DataIdentifierType

False

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.

ThrottlingException

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

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

UpdateResourceProfileDetectionsRequest

Updates the sensitivity scoring settings for an S3 bucket that Amazon Macie monitors and analyzes for your account. The settings specify whether to exclude or include occurrences of specific types of sensitive data in calculations of the bucket's sensitivity score. You can update the settings only if automated sensitive data discovery is currently enabled for your account.

PropertyTypeRequiredDescription
suppressDataIdentifiers

Array of type SuppressDataIdentifier

False

An array of objects, one for each custom data identifier or managed data identifier that detected the type of sensitive data to start excluding or including in the bucket's score. To start including all sensitive data types in the score, don't specify any values for this array.

ValidationException

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

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

See also

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

ListResourceProfileDetections

UpdateResourceProfileDetections