SecurityHub / Client / list_finding_aggregators

list_finding_aggregators#

SecurityHub.Client.list_finding_aggregators(**kwargs)#

If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.

See also: AWS API Documentation

Request Syntax

response = client.list_finding_aggregators(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – The token returned with the previous set of results. Identifies the next set of results to return.

  • MaxResults (integer) – The maximum number of results to return. This operation currently only returns a single result.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • FindingAggregators (list) –

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

      • (dict) –

        A finding aggregator. A finding aggregator contains the configuration for finding aggregation.

        • FindingAggregatorArn (string) –

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

    • NextToken (string) –

      If there are more results, this is the token to provide in the next call to ListFindingAggregators.

      This operation currently only returns a single result.

Exceptions

  • SecurityHub.Client.exceptions.InternalException

  • SecurityHub.Client.exceptions.LimitExceededException

  • SecurityHub.Client.exceptions.InvalidAccessException

  • SecurityHub.Client.exceptions.AccessDeniedException

  • SecurityHub.Client.exceptions.InvalidInputException