URI HTTP methods Schemas Properties See also

Sensitivity Inspection Templates

The Sensitivity Inspection Templates resource provides a subset of information about the sensitivity inspection template for your Amazon Macie account. This 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. The first time you or your Macie administrator enables automated sensitive data discovery for your account, Macie automatically creates the template for your account.

You can use this resource to retrieve the unique identifier and name of the template that Macie created for your account. You can then use the unique identifier to retrieve or update the template's settings by using the Sensitivity Inspection Template resource.

If your account is part of an organization that centrally manages multiple Macie accounts, Macie uses the sensitivity inspection template for your Macie administrator’s account when it analyzes data for accounts in your organization. Contact your Macie administrator for information about the template settings for your organization.

URI

/templates/sensitivity-inspections

HTTP methods

GET

Operation ID: ListSensitivityInspectionTemplates

Retrieves a subset of information about the sensitivity inspection template for an account.

Query parameters
Name	Type	Required	Description
`nextToken`	String	False	The `nextToken` string that specifies which page of results to return in a paginated response.
`maxResults`	String	False	The maximum number of items to include in each page of a paginated response.

Responses
Status code	Response model	Description
`200`	`ListSensitivityInspectionTemplatesResponse`	The request succeeded.
`400`	`ValidationException`	The request failed because the input doesn't satisfy the constraints specified by the service.
`402`	`ServiceQuotaExceededException`	The request failed because fulfilling the request would exceed one or more service quotas for your account.
`403`	`AccessDeniedException`	The request was denied because you don't have sufficient access to the specified resource.
`429`	`ThrottlingException`	The request failed because you sent too many requests during a certain amount of time.
`500`	`InternalServerException`	The request failed due to an unknown internal server error, exception, or failure.

Schemas

Response bodies


{
  "nextToken": "string",
  "sensitivityInspectionTemplates": [
    {
      "id": "string",
      "name": "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.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

InternalServerException

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

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

ListSensitivityInspectionTemplatesResponse

Provides the results of a request for information about the sensitivity inspection template for an Amazon Macie account.

Property	Type	Required	Description
`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.
`sensitivityInspectionTemplates`	Array of type SensitivityInspectionTemplatesEntry	False	An array that specifies the unique identifier and name of the sensitivity inspection template for the account.

SensitivityInspectionTemplatesEntry

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

Property	Type	Required	Description
`id`	string	False	The unique identifier for the sensitivity inspection template.
`name`	string	False	The name of the sensitivity inspection template: `automated-sensitive-data-discovery`.

ServiceQuotaExceededException

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

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

ThrottlingException

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

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

ValidationException

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

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.