Findings List - Amazon Macie

Findings List

The Findings List resource provides a subset of information about the findings for your account. A finding is a notification that contains details about a data classification or a potential data access issue that Amazon Macie discovers for a data source.

Note that this resource doesn't provide access to all the data for a finding. Instead, it provides only a subset of metadata, such as the finding identifier. To retrieve all the data for one or more findings, use the Findings Descriptions resource.

You can use the Findings List resource to retrieve a subset of information about one or more findings. To customize and refine your query, you can use supported parameters that 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 Code Response Model Description
200 ListFindingsResponse

The request succeeded.

400 ValidationException

The request failed because it contains a syntax error.

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

Example POST

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

Response Bodies

Example ListFindingsResponse

{ "findingIds": [ "string" ], "nextToken": "string" }

Example ValidationException

{ "message": "string" }

Example ServiceQuotaExceededException

{ "message": "string" }

Example AccessDeniedException

{ "message": "string" }

Example ResourceNotFoundException

{ "message": "string" }

Example ConflictException

{ "message": "string" }

Example ThrottlingException

{ "message": "string" }

Example InternalServerException

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

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.

Criterion

Specifies a condition that defines a property, operator, and value to use to filter the results of a query for findings.

Property Type Required Description

*

object

False

CriterionAdditionalProperties

Specifies the operator to use in a property-based condition that filters the results of a query for findings.

Property Type Required Description
lt

integer

Format: int64

False

A less than condition to apply to a specified property value for findings.

gte

integer

Format: int64

False

A greater than or equal to condition to apply to a specified property value for findings.

neq

Array of type string

False

A not equal to condition to apply to a specified property value for findings.

lte

integer

Format: int64

False

A less than or equal to condition to apply to a specified property value for findings.

eq

Array of type string

False

An equal to condition to apply to a specified property value for findings.

gt

integer

Format: int64

False

A greater than condition to apply to a specified property value for findings.

FindingCriteria

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

Property Type Required Description
criterion

Criterion

False

A condition that specifies the property, operator, and value to use to filter the results.

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.

ListFindingsRequest

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

Property Type Required Description
nextToken

string

False

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

maxResults

integer

Format: int32

False

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

findingCriteria

FindingCriteria

False

The criteria to use to filter the results.

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.

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

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.

SortCriteria

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

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

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.

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.

See Also

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

ListFindings