Sensitivity Inspection Template

The Sensitivity Inspection Template resource provides access to the sensitivity inspection template for your Amazon Macie account. The template stores the collection of settings that specify which allow lists, custom data identifiers, and managed data identifiers you want Macie to use when performing automated sensitive data discovery. For more information, see Performing automated sensitive data discovery in the Amazon Macie User Guide.

The first time you or your Macie administrator enables automated sensitive data discovery for your account, Macie automatically creates the sensitivity inspection template for your account. Macie uses the template's settings to determine whether to use (include) or not use (exclude) individual allow lists, custom data identifiers, and managed data identifiers when it analyzes data. If your account is part of an organization that centrally manages multiple Macie accounts, Macie uses the template settings for your Macie administrator’s account when it analyzes data for accounts in your organization. Contact your Macie administrator for information about the settings for your organization.

By default, Macie analyzes data by using only the set of managed data identifiers that we recommend for automated sensitive data discovery. For a list of these identifiers, see Default settings for automated sensitive data discovery in the Amazon Macie User Guide. If you're a Macie administrator or you have a standalone Macie account, you can customize the analyses by updating the template settings for your account. You can include allow lists and custom data identifiers that you've defined, and include or exclude specific managed data identifiers that Macie provides. You can use allow lists in all the AWS Regions where Macie is currently available except the Asia Pacific (Osaka) Region.

You can use the Sensitivity Inspection Template resource to retrieve or update the template settings for your account. When you use this resource, you have to specify the unique identifier for the template. To obtain this identifier, use the Sensitivity Inspection Templates resource.

URI

/templates/sensitivity-inspections/id

HTTP methods

GET

Operation ID: GetSensitivityInspectionTemplate

Retrieves the settings for the sensitivity inspection template for an account.

PUT

Operation ID: UpdateSensitivityInspectionTemplate

Updates the settings for the sensitivity inspection template for an account.

Schemas

Request bodies

{
  "description": "string",
  "excludes": {
    "managedDataIdentifierIds": [
      "string"
    ]
  },
  "includes": {
    "allowListIds": [
      "string"
    ],
    "customDataIdentifierIds": [
      "string"
    ],
    "managedDataIdentifierIds": [
      "string"
    ]
  }
}

Response bodies

{
  "description": "string",
  "excludes": {
    "managedDataIdentifierIds": [
      "string"
    ]
  },
  "includes": {
    "allowListIds": [
      "string"
    ],
    "customDataIdentifierIds": [
      "string"
    ],
    "managedDataIdentifierIds": [
      "string"
    ]
  },
  "name": "string",
  "sensitivityInspectionTemplateId": "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.

Empty

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

GetSensitivityInspectionTemplateResponse

Provides information about the settings for the sensitivity inspection template for an Amazon Macie account.

InternalServerException

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

ResourceNotFoundException

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

SensitivityInspectionTemplateExcludes

Specifies managed data identifiers to exclude (not use) when performing automated sensitive data discovery. For information about the managed data identifiers that Amazon Macie currently provides, see Using managed data identifiers in the Amazon Macie User Guide.

SensitivityInspectionTemplateIncludes

Specifies the allow lists, custom data identifiers, and managed data identifiers to include (use) when performing automated sensitive data discovery. The configuration must specify at least one custom data identifier or managed data identifier. For information about the managed data identifiers that Amazon Macie currently provides, see Using managed data identifiers in the Amazon Macie User Guide.

ThrottlingException

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

UpdateSensitivityInspectionTemplateRequest

Specifies settings for the sensitivity inspection template for an Amazon Macie account. 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:

GetSensitivityInspectionTemplate

UpdateSensitivityInspectionTemplate