Managed Data Identifiers - Amazon Macie

Managed Data Identifiers

The Managed Data Identifiers resource represents the repository of managed data identifiers that Amazon Macie currently provides. A managed data identifier is a set of built-in criteria and techniques that detect a specific type of sensitive data, such as credit card numbers, AWS secret access keys, or passport numbers for a particular country or region. These identifiers can detect a large and growing list of sensitive data types for many countries and regions, including multiple types of financial data, personal health information (PHI), and personally identifiable information (PII). For information about the categories and types of sensitive data that they can detect, see Using managed data identifiers in the Amazon Macie User Guide.

To detect sensitive data with managed data identifiers, you create and run classification jobs. When you create a job, you can configure it to use all, some, or none of the managed data identifiers that Macie provides. If you want the job to use only some managed data identifiers, you specify the unique identifier for each managed data identifier that you want to explicitly include or exclude from the job's analysis. To find these unique identifiers, you can use this resource.

You can use the Managed Data Identifiers resource to retrieve information about the managed data identifiers that Macie currently provides.

URI

/managed-data-identifiers/list

HTTP methods

POST

Operation ID: ListManagedDataIdentifiers

Retrieves information about all the managed data identifiers that Amazon Macie currently provides.

Responses
Status code Response model Description
200 ListManagedDataIdentifiersResponse

The request succeeded.

Schemas

Request bodies

{ "nextToken": "string" }

Response bodies

{ "nextToken": "string", "items": [ { "id": "string", "category": enum } ] }

Properties

ListManagedDataIdentifiersRequest

Specifies criteria for paginating the results of a request for information about managed data identifiers.

Property Type Required Description
nextToken

string

False

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

ListManagedDataIdentifiersResponse

Provides information about the managed data identifiers that Amazon Macie currently provides.

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.

items

Array of type ManagedDataIdentifierSummary

False

An array of objects, one for each managed data identifier.

ManagedDataIdentifierSummary

Provides information about a managed data identifier. For additional information, see Using managed data identifiers in the Amazon Macie User Guide.

Property Type Required Description
id

string

False

The unique identifier for the managed data identifier. This is a string that describes the type of sensitive data that the managed data identifier detects. For example: OPENSSH_PRIVATE_KEY for OpenSSH private keys, CREDIT_CARD_NUMBER for credit card numbers, or USA_PASSPORT_NUMBER for US passport numbers.

category

SensitiveDataItemCategory

False

The category of sensitive data that the managed data identifier detects: CREDENTIALS, for credentials data such as private keys or AWS secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

SensitiveDataItemCategory

For a finding, the category of sensitive data that was detected and produced the finding. For a managed data identifier, the category of sensitive data that the managed data identifier detects. Possible values are:

  • FINANCIAL_INFORMATION

  • PERSONAL_INFORMATION

  • CREDENTIALS

  • CUSTOM_IDENTIFIER

See also

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

ListManagedDataIdentifiers