Amazon Macie 2

{'clientToken': 'string'}

Updates the criteria and other settings for a findings filter.

See also: AWS API Documentation

Request Syntax

client.update_findings_filter(
    action='ARCHIVE'|'NOOP',
    description='string',
    findingCriteria={
        'criterion': {
            'string': {
                'eq': [
                    'string',
                ],
                'eqExactMatch': [
                    'string',
                ],
                'gt': 123,
                'gte': 123,
                'lt': 123,
                'lte': 123,
                'neq': [
                    'string',
                ]
            }
        }
    },
    id='string',
    name='string',
    position=123,
    clientToken='string'
)

type action:

string

param action:

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.

type description:

string

param description:

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.

type findingCriteria:

dict

param findingCriteria:

The criteria to use to filter findings.

• criterion (dict) --

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

  • (string) --

    • (dict) --

      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.

      • eq (list) --

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

        • (string) --

      • eqExactMatch (list) --

        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.

        • (string) --

      • gt (integer) --

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

      • gte (integer) --

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

      • lt (integer) --

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

      • lte (integer) --

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

      • neq (list) --

        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.

        • (string) --

type id:

string

param id:

[REQUIRED]

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

type name:

string

param name:

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.

type position:

integer

param position:

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.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string'
}

Response Structure

• (dict) --

  The request succeeded. The specified findings filter was updated.

  • arn (string) --

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

  • id (string) --

    The unique identifier for the filter that was updated.