list_findings_filters

Macie2.Client.list_findings_filters(**kwargs)

Retrieves a subset of information about all the findings filters for an account.

See also: AWS API Documentation

Request Syntax

response = client.list_findings_filters(
    maxResults=123,
    nextToken='string'
)

Parameters

• maxResults (integer) -- The maximum number of items to include in each page of a paginated response.
• nextToken (string) -- The nextToken string that specifies which page of results to return in a paginated response.

Return type

dict

Returns

Response Syntax

{
    'findingsFilterListItems': [
        {
            'action': 'ARCHIVE'|'NOOP',
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  The request succeeded.

  • findingsFilterListItems (list) --

    An array of objects, one for each filter that's associated with the account.

    • (dict) --

      Provides information about a findings filter.

      • action (string) --

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

      • arn (string) --

        The Amazon Resource Name (ARN) of the filter.

      • id (string) --

        The unique identifier for the filter.

      • name (string) --

        The custom name of the filter.

      • tags (dict) --

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

        • (string) --
          • (string) --

  • nextToken (string) --

    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.

Exceptions

• Macie2.Client.exceptions.ValidationException
• Macie2.Client.exceptions.InternalServerException
• Macie2.Client.exceptions.ServiceQuotaExceededException
• Macie2.Client.exceptions.AccessDeniedException
• Macie2.Client.exceptions.ResourceNotFoundException
• Macie2.Client.exceptions.ThrottlingException
• Macie2.Client.exceptions.ConflictException