SecurityHub / Paginator / ListFindingAggregators

ListFindingAggregators#

class SecurityHub.Paginator.ListFindingAggregators#
paginator = client.get_paginator('list_finding_aggregators')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SecurityHub.Client.list_finding_aggregators().

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

{
    'FindingAggregators': [
        {
            'FindingAggregatorArn': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • FindingAggregators (list) –

      The list of finding aggregators. This operation currently only returns a single result.

      • (dict) –

        A finding aggregator is a Security Hub resource that specifies cross-Region aggregation settings, including the home Region and any linked Regions.

        • FindingAggregatorArn (string) –

          The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.