get_finding_aggregator

SecurityHub.Client.get_finding_aggregator(**kwargs)

Returns the current finding aggregation configuration.

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 aggregation 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

  • SecurityHub.Client.exceptions.InternalException
  • SecurityHub.Client.exceptions.LimitExceededException
  • SecurityHub.Client.exceptions.InvalidAccessException
  • SecurityHub.Client.exceptions.AccessDeniedException
  • SecurityHub.Client.exceptions.InvalidInputException
  • SecurityHub.Client.exceptions.ResourceNotFoundException