Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1479429429.3 KB

Updates the criteria and other settings for a findings filter.

patch/findingsfilters/{id}

Path parameters

idstring required

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

Request body

action'ARCHIVE' | 'NOOP'

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

clientTokenstring

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

descriptionstring
<p>A custom description of the filter. The description can contain as many as 512 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.</p>
namestring
<p>A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.</p>
positioninteger

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.

Response

Success

arnstring

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

idstring

The unique identifier for the filter that was updated.