Sensitivity Inspection Template - Amazon Macie

Sensitivity Inspection Template

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

The first time you enable automated sensitive data discovery for your account, Macie automatically creates the sensitivity inspection template for your account. Macie then uses the settings specified by the template to determine whether to use (include) or not use (exclude) individual allow lists, custom data identifiers, and managed data identifiers when it analyzes data.

By default, the template includes only those 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. You can customize the template by also including allow lists and custom data identifiers that you've defined, and by excluding or including 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.

If automated sensitive data discovery is currently enabled for your account, you can use the Sensitivity Inspection Template resource to retrieve or update the template settings for your account. To use this resource, you have to specify the unique identifier for the template. To obtain this identifier, use the Sensitivity Inspection Templates resource. In addition, automated sensitive data discovery must be enabled for your account. To enable automated sensitive data discovery for your account, use the Automated Sensitive Data Discovery Configuration resource.

URI

/templates/sensitivity-inspections/id

HTTP methods

GET

Operation ID: GetSensitivityInspectionTemplate

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

Path parameters
NameTypeRequiredDescription
idStringTrue

The unique identifier for the Amazon Macie resource that the request applies to.

Responses
Status codeResponse modelDescription
200GetSensitivityInspectionTemplateResponse

The request succeeded.

400ValidationException

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

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.

PUT

Operation ID: UpdateSensitivityInspectionTemplate

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

Path parameters
NameTypeRequiredDescription
idStringTrue

The unique identifier for the Amazon Macie resource that the request applies to.

Responses
Status codeResponse modelDescription
200Empty Schema

The request succeeded. The template's 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.

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

{ "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.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

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. Macie uses the template's settings when it performs automated sensitive data discovery for the account.

PropertyTypeRequiredDescription
description

string

False

The custom description of the template.

excludes

SensitivityInspectionTemplateExcludes

False

The managed data identifiers that are explicitly excluded (not used) when analyzing data.

includes

SensitivityInspectionTemplateIncludes

False

The allow lists, custom data identifiers, and managed data identifiers that are included (used) when analyzing data.

name

string

True

The name of the template: automated-sensitive-data-discovery.

sensitivityInspectionTemplateId

string

True

The unique identifier for the template.

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.

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.

SensitivityInspectionTemplateExcludes

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

PropertyTypeRequiredDescription
managedDataIdentifierIds

Array of type string

False

An array of unique identifiers, one for each managed data identifier to exclude. To retrieve a list of valid values, use the ListManagedDataIdentifiers operation.

SensitivityInspectionTemplateIncludes

Specifies the allow lists, custom data identifiers, and managed data identifiers to include (use) when performing automated sensitive data discovery for an Amazon Macie account. 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.

PropertyTypeRequiredDescription
allowListIds

Array of type string

False

An array of unique identifiers, one for each allow list to include.

customDataIdentifierIds

Array of type string

False

An array of unique identifiers, one for each custom data identifier to include.

managedDataIdentifierIds

Array of type string

False

An array of unique identifiers, one for each managed data identifier to include.

Amazon Macie uses these managed data identifiers in addition to managed data identifiers that are subsequently released and recommended for automated sensitive data discovery. To retrieve a list of valid values for the managed data identifiers that are currently available, use the ListManagedDataIdentifiers operation.

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.

UpdateSensitivityInspectionTemplateRequest

Specifies settings for the sensitivity inspection template for an Amazon Macie account. Macie uses the template's settings when it performs automated sensitive data discovery for the account. To update the settings, automated sensitive data discovery must currently be enabled for the account.

PropertyTypeRequiredDescription
description

string

False

A custom description of the template. The description can contain as many as 200 characters.

excludes

SensitivityInspectionTemplateExcludes

False

The managed data identifiers to explicitly exclude (not use) when analyzing data.

To exclude an allow list or custom data identifier that's currently included by the template, update the values for the SensitivityInspectionTemplateIncludes.allowListIds and SensitivityInspectionTemplateIncludes.customDataIdentifierIds properties, respectively.

includes

SensitivityInspectionTemplateIncludes

False

The allow lists, custom data identifiers, and managed data identifiers to include (use) when analyzing data.

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:

GetSensitivityInspectionTemplate

UpdateSensitivityInspectionTemplate