Finding List - Amazon Macie

Finding List

The Finding List resource provides a subset of information about the findings for your Amazon Macie account. A finding is a detailed report of a potential policy violation for an Amazon Simple Storage Service (Amazon S3) bucket or sensitive data in an S3 object. Note that this resource doesn't provide access to all the data for a finding. Instead, it provides only a subset of metadata, primarily the unique identifier for a finding. To retrieve all the data for one or more findings, use the Findings resource.

You can use the Finding List resource to retrieve a subset of information about one or more findings. To customize and refine your query, you can use the supported parameters to specify whether and how to filter, sort, and paginate the results.

URI

/findings

HTTP methods

POST

Operation ID: ListFindings

Retrieves a subset of information about one or more findings.

Responses
Status codeResponse modelDescription
200ListFindingsResponse

The request succeeded.

400ValidationException

The request failed because it contains a syntax error.

402ServiceQuotaExceededException

The request failed because fulfilling the request would exceed one or more service quotas for your account.

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.

409ConflictException

The request failed because it conflicts with the current state of the specified resource.

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

{ "nextToken": "string", "findingCriteria": { "criterion": { } }, "maxResults": integer, "sortCriteria": { "orderBy": enum, "attributeName": "string" } }

Response bodies

{ "findingIds": [ "string" ], "nextToken": "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.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

ConflictException

Provides information about an error that occurred due to a versioning conflict for a specified resource.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

Criterion

Specifies a condition that defines a property, operator, and one or more values to filter the results of a query for findings. The number of values depends on the property and operator specified by the condition. For information about defining filter conditions, see Fundamentals of filtering findings in the Amazon Macie User Guide.

PropertyTypeRequiredDescription

*

object

False

CriterionAdditionalProperties

Specifies the operator to use in a property-based condition that filters the results of a query for findings. For detailed information and examples of each operator, see Fundamentals of filtering findings in the Amazon Macie User Guide.

PropertyTypeRequiredDescription
eq

Array of type string

False

The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

eqExactMatch

Array of type string

False

The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.

gt

integer

Format: int64

False

The value for the property is greater than the specified value.

gte

integer

Format: int64

False

The value for the property is greater than or equal to the specified value.

lt

integer

Format: int64

False

The value for the property is less than the specified value.

lte

integer

Format: int64

False

The value for the property is less than or equal to the specified value.

neq

Array of type string

False

The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

FindingCriteria

Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.

PropertyTypeRequiredDescription
criterion

Criterion

False

A condition that specifies the property, operator, and one or more values to use to filter the results.

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.

ListFindingsRequest

Specifies criteria for filtering, sorting, and paginating the results of a request for information about findings.

PropertyTypeRequiredDescription
findingCriteria

FindingCriteria

False

The criteria to use to filter the results.

maxResults

integer

Format: int32

False

The maximum number of items to include in each page of the response.

nextToken

string

False

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

sortCriteria

SortCriteria

False

The criteria to use to sort the results.

ListFindingsResponse

Provides the results of a request for information about one or more findings.

PropertyTypeRequiredDescription
findingIds

Array of type string

False

An array of strings, where each string is the unique identifier for a finding that meets the filter criteria specified in the request.

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.

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.

ServiceQuotaExceededException

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

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

SortCriteria

Specifies criteria for sorting the results of a request for findings.

PropertyTypeRequiredDescription
attributeName

string

False

The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.

orderBy

string

Values: ASC | DESC

False

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

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.

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:

ListFindings