SecurityHub / Client / update_finding_aggregator

update_finding_aggregator#

SecurityHub.Client.update_finding_aggregator(**kwargs)#

Note

The aggregation Region is now called the home Region.

Updates cross-Region aggregation settings. You can use this operation to update the Region linking mode and the list of included or excluded Amazon Web Services Regions. However, you can’t use this operation to change the home Region.

You can invoke this operation from the current home Region only.

See also: AWS API Documentation

Request Syntax

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

  • FindingAggregatorArn (string) –

    [REQUIRED]

    The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.

  • 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 - Aggregates 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 - Aggregates 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 - Aggregates findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.

    • NO_REGIONS - Aggregates no data because no Regions are selected as linked Regions.

  • Regions (list) –

    If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don’t replicate and send findings to the home Region.

    If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region.

    An InvalidInputException error results if you populate this field while RegionLinkingMode is NO_REGIONS.

    • (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.

    • 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

  • SecurityHub.Client.exceptions.InternalException

  • SecurityHub.Client.exceptions.LimitExceededException

  • SecurityHub.Client.exceptions.InvalidAccessException

  • SecurityHub.Client.exceptions.AccessDeniedException

  • SecurityHub.Client.exceptions.InvalidInputException

  • SecurityHub.Client.exceptions.ResourceNotFoundException