URI HTTP methods Schemas Properties See also

Custom Data Identifier Descriptions

The Custom Data Identifier Descriptions resource provides information about the custom data identifiers for your Amazon Macie account. A custom data identifier is a set of criteria that you define to detect sensitive data in a data source.

You can use this resource to retrieve a subset of information about one or more custom data identifiers for your account. To refine your request, you can use the supported request parameter to specify which custom data identifiers to retrieve information about. To retrieve detailed information about the detection criteria and other settings for an individual custom data identifier, use the Custom Data Identifier resource.

URI

/custom-data-identifiers/get

HTTP methods

POST

Operation ID: BatchGetCustomDataIdentifiers

Retrieves information about one or more custom data identifiers.

Responses
Status code	Response model	Description
`200`	`BatchGetCustomDataIdentifiersResponse`	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.
`404`	`ResourceNotFoundException`	The request failed because the specified resource wasn't found.
`409`	`ConflictException`	The request failed because it conflicts with the current state of 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

Request bodies


{
  "ids": [
    "string"
  ]
}

Response bodies


{
  "customDataIdentifiers": [
    {
      "arn": "string",
      "createdAt": "string",
      "deleted": boolean,
      "description": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "notFoundIdentifierIds": [
    "string"
  ]
}


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

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

BatchGetCustomDataIdentifierSummary

Provides information about a custom data identifier.

Property	Type	Required	Description
`arn`	string	False	The Amazon Resource Name (ARN) of the custom data identifier.
`createdAt`	string Format: date-time	False	The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
`deleted`	boolean	False	Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.
`description`	string	False	The custom description of the custom data identifier.
`id`	string	False	The unique identifier for the custom data identifier.
`name`	string	False	The custom name of the custom data identifier.

BatchGetCustomDataIdentifiersRequest

Specifies one or more custom data identifiers to retrieve information about.

Property	Type	Required	Description
`ids`	Array of type string	False	An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.

BatchGetCustomDataIdentifiersResponse

Provides information about one or more custom data identifiers.

Property	Type	Required	Description
`customDataIdentifiers`	Array of type BatchGetCustomDataIdentifierSummary	False	An array of objects, one for each custom data identifier that matches the criteria specified in the request.
`notFoundIdentifierIds`	Array of type string	False	An array of custom data identifier IDs, one for each custom data identifier that was specified in the request but doesn't correlate to an existing custom data identifier.

ConflictException

Provides information about an error that occurred due to a versioning conflict for 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.

ResourceNotFoundException

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

Property	Type	Required	Description
`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.

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.