Macie2 / Paginator / ListFindings

ListFindings

class Macie2.Paginator.ListFindings

paginator = client.get_paginator('list_findings')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    findingCriteria={
        'criterion': {
            'string': {
                'eq': [
                    'string',
                ],
                'eqExactMatch': [
                    'string',
                ],
                'gt': 123,
                'gte': 123,
                'lt': 123,
                'lte': 123,
                'neq': [
                    'string',
                ]
            }
        }
    },
    sortCriteria={
        'attributeName': 'string',
        'orderBy': 'ASC'|'DESC'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• findingCriteria (dict) –

  The criteria to use to filter the results.

  • 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) –

• sortCriteria (dict) –

  The criteria to use to sort the results.

  • attributeName (string) –

    The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.

  • orderBy (string) –

    The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

• 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

{
    'findingIds': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The request succeeded.

  • findingIds (list) –

    An array of strings, where each string is the unique identifier for a finding that matches the filter criteria specified in the request.

    • (string) –

  • NextToken (string) –

    A token to resume pagination.