Findings Filter - Amazon Macie

Findings Filter

The Findings Filter resource represents an individual findings filter that you created and saved to view, analyze, and manage findings. A findings filter, also referred to as a filter, is a set of criteria that specifies which findings to include in the results of a query that retrieves findings. A findings filter can also perform specific actions on findings that meet the filter's criteria. For example, you can configure a filter to suppress (automatically archive) findings that meet the filter's criteria.

You can use the Findings Filter resource to update, delete, or retrieve detailed information about a findings filter. To create a new filter, use the Findings Filters resource.

URI

/findingsfilters/id

HTTP Methods

GET

Operation ID: GetFindingsFilter

Retrieves information about the criteria and other settings for a findings filter.

Path Parameters
Name Type Required Description
id String True

The unique identifier for the Amazon Macie resource or account that the request applies to.

Responses
Status Code Response Model Description
200 GetFindingsFilterResponse

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.

DELETE

Operation ID: DeleteFindingsFilter

Deletes a findings filter.

Path Parameters
Name Type Required Description
id String True

The unique identifier for the Amazon Macie resource or account that the request applies to.

Responses
Status Code Response Model Description
200 Empty Schema

The request succeeded. The specified findings filter was deleted and there isn't any content to include in the body of the response (No Content).

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.

PATCH

Operation ID: UpdateFindingsFilter

Updates the criteria and other settings for a findings filter.

Path Parameters
Name Type Required Description
id String True

The unique identifier for the Amazon Macie resource or account that the request applies to.

Responses
Status Code Response Model Description
200 UpdateFindingsFilterResponse

The request succeeded. The specified findings filter was updated.

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 PATCH

{ "findingCriteria": { "criterion": { } }, "name": "string", "action": enum, "description": "string", "position": integer }

Response Bodies

Example GetFindingsFilterResponse

{ "findingCriteria": { "criterion": { } }, "name": "string", "action": enum, "description": "string", "position": integer, "id": "string", "arn": "string", "tags": { } }

Example Empty Schema

{ }

Example UpdateFindingsFilterResponse

{ "id": "string", "arn": "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.

Empty

The request succeeded and there isn't any content to include in the body of the response (No Content).

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.

FindingsFilterAction

The action to perform on findings that meet the filter criteria. To suppress (automatically archive) findings that meet the criteria, set this value to ARCHIVE. Valid values are:

  • ARCHIVE

  • NOOP

GetFindingsFilterResponse

Provides information about the criteria and other settings for a findings filter.

Property Type Required Description
findingCriteria

FindingCriteria

False

The criteria that's used to filter findings.

name

string

False

The custom name of the filter.

action

FindingsFilterAction

False

The action that's performed on findings that meet the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

description

string

False

The custom description of the filter.

position

integer

Format: int32

False

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

id

string

False

The unique identifier for the filter.

arn

string

False

The Amazon Resource Name (ARN) of the filter.

tags

TagMap

False

A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.

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.

TagMap

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

Property Type Required Description

*

string

False

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.

UpdateFindingsFilterRequest

Specifies the criteria and other settings for a findings filter.

Property Type Required Description
findingCriteria

FindingCriteria

False

The criteria to use to filter findings.

name

string

False

A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.

action

FindingsFilterAction

False

The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

description

string

False

A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.

position

integer

Format: int32

False

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

UpdateFindingsFilterResponse

Provides information about a findings filter that was updated in response to a request.

Property Type Required Description
id

string

False

The unique identifier for the filter that was updated.

arn

string

False

The Amazon Resource Name (ARN) of the filter that was updated.

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:

GetFindingsFilter

DeleteFindingsFilter

UpdateFindingsFilter