SecurityHub / Client / get_finding_aggregator

get_finding_aggregator#

SecurityHub.Client.get_finding_aggregator(**kwargs)#

Note

The aggregation Region is now called the home Region.

Returns the current configuration in the calling account for cross-Region aggregation. A finding aggregator is a resource that establishes the home Region and any linked Regions.

See also: AWS API Documentation

Request Syntax

response = client.get_finding_aggregator(
    FindingAggregatorArn='string'
)
Parameters:

FindingAggregatorArn (string) –

[REQUIRED]

The ARN of the finding aggregator to return details for. To obtain the ARN, use ListFindingAggregators.

Return type:

dict

Returns:

Response Syntax

{
    'FindingAggregatorArn': 'string',
    'FindingAggregationRegion': 'string',
    'RegionLinkingMode': 'string',
    'Regions': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • FindingAggregatorArn (string) –

      The ARN of the finding aggregator.

    • FindingAggregationRegion (string) –

      The home Region. Findings generated in linked Regions are replicated and sent to the home Region.

    • RegionLinkingMode (string) –

      Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

    • Regions (list) –

      The list of excluded Regions or included Regions.

      • (string) –

Exceptions