update_finding_aggregator ¶

def update_finding_aggregator(
    self,
    *,
    config_overrides: Optional[SecurityHubClientConfig] = None,
    finding_aggregator_arn: Optional[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ] = None,
    region_linking_mode: Optional[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ] = None,
    regions: Optional["capo_securityhub.types.string_list.StringList"] = None,
) -> "capo_securityhub.types.update_finding_aggregator_response.UpdateFindingAggregatorResponse":
    """<note> <p>The <i>aggregation Region</i> is now called the <i>home Region</i>.</p> </note> <p>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.</p> <p>You can invoke this operation from the current home Region only. </p>

    Args:
        finding_aggregator_arn: <p>The ARN of the finding aggregator. To obtain the ARN, use <code>ListFindingAggregators</code>.</p>
        region_linking_mode: <p>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 CSPM supports them and you opt into them.</p> <p>The selected option also determines how to use the Regions provided in the Regions list.</p> <p>The options are as follows:</p> <ul> <li> <p> <code>ALL_REGIONS</code> - Aggregates findings from all of the Regions where Security Hub CSPM is enabled. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them. </p> </li> <li> <p> <code>ALL_REGIONS_EXCEPT_SPECIFIED</code> - Aggregates findings from all of the Regions where Security Hub CSPM is enabled, except for the Regions listed in the <code>Regions</code> parameter. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them. </p> </li> <li> <p> <code>SPECIFIED_REGIONS</code> - Aggregates findings only from the Regions listed in the <code>Regions</code> parameter. Security Hub CSPM does not automatically aggregate findings from new Regions. </p> </li> <li> <p> <code>NO_REGIONS</code> - Aggregates no data because no Regions are selected as linked Regions. </p> </li> </ul>
        regions: <p>If <code>RegionLinkingMode</code> is <code>ALL_REGIONS_EXCEPT_SPECIFIED</code>, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.</p> <p>If <code>RegionLinkingMode</code> is <code>SPECIFIED_REGIONS</code>, then this is a space-separated list of Regions that do replicate and send findings to the home Region.</p> <p>An <code>InvalidInputException</code> error results if you populate this field while <code>RegionLinkingMode</code> is <code>NO_REGIONS</code>.</p>

    Raises:
        capo_securityhub.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action specified in the request.</p>
        capo_securityhub.errors.internal_exception.InternalException: <p>Internal server error.</p>
        capo_securityhub.errors.invalid_access_exception.InvalidAccessException: <p>The account doesn't have permission to perform this action.</p>
        capo_securityhub.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because you supplied an invalid or out-of-range value for an input parameter.</p>
        capo_securityhub.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.</p>
        capo_securityhub.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because we can't find the specified resource.</p>
        capo_securityhub.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To update cross-Region aggregation settings
        The following example updates the cross-Region aggregation configuration. You use this operation to change the list of linked Regions and the treatment of new Regions. However, you cannot use this operation to change the aggregation Region.

        >>> client.update_finding_aggregator(finding_aggregator_arn='arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111', region_linking_mode='SPECIFIED_REGIONS', regions=['us-west-1', 'us-west-2'])
    """

    def _handler(
        req: "OperationRequest[capo_securityhub.types.update_finding_aggregator_request.UpdateFindingAggregatorRequest]",
    ) -> OperationResponse[
        "capo_securityhub.types.update_finding_aggregator_response.UpdateFindingAggregatorResponse"
    ]:
        import capo_securityhub._operations.security_hub_api_service.update_finding_aggregator

        output, http_response = (
            capo_securityhub._operations.security_hub_api_service.update_finding_aggregator.update_finding_aggregator(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateFindingAggregator")
    )
    input_: capo_securityhub.types.update_finding_aggregator_request.UpdateFindingAggregatorRequest = {}
    if finding_aggregator_arn is not None:
        input_["finding_aggregator_arn"] = finding_aggregator_arn
    if region_linking_mode is not None:
        input_["region_linking_mode"] = region_linking_mode
    if regions is not None:
        input_["regions"] = regions

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output