SecurityHub / Client / create_finding_aggregator

create_finding_aggregator#

SecurityHub.Client.create_finding_aggregator(**kwargs)#

Used to enable finding aggregation. Must be called from the aggregation Region.

For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_finding_aggregator(
    RegionLinkingMode='string',
    Regions=[
        'string',
    ]
)
Parameters:

  • RegionLinkingMode (string) –

    [REQUIRED]

    Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.

    The selected option also determines how to use the Regions provided in the Regions list.

    The options are as follows:

    • ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.

    • ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.

    • SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.

  • Regions (list) –

    If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.

    If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.

    • (string) –

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. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.

    • 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