Macie2 / Paginator / ListFindingsFilters

ListFindingsFilters

class Macie2.Paginator.ListFindingsFilters

paginator = client.get_paginator('list_findings_filters')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Macie2.Client.list_findings_filters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous 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) –

    A token to resume pagination.