delete_finding_aggregator ¶

delete_finding_aggregator(
    finding_aggregator_arn: NonEmptyString,
    *,
    config_overrides: Optional[SecurityHubClientConfig] = None,
) -> DeleteFindingAggregatorResponse

The aggregation Region is now called the home Region.

Deletes a finding aggregator. When you delete the finding aggregator, you stop cross-Region aggregation. Finding replication stops occurring from the linked Regions to the home Region.

When you stop cross-Region aggregation, findings that were already replicated and sent to the home Region are still visible from the home Region. However, new findings and finding updates are no longer replicated and sent to the home Region.

Parameters:

finding_aggregator_arn (NonEmptyString) –

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

Raises:

AccessDeniedException –

You don't have permission to perform the action specified in the request.
InternalException –

Internal server error.
InvalidAccessException –

The account doesn't have permission to perform this action.
InvalidInputException –

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
LimitExceededException –

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.
ResourceNotFoundException –

The request was rejected because we can't find the specified resource.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To delete a finding aggregator The following example deletes a finding aggregator in Security Hub. Deleting the finding aggregator stops cross-Region aggregation. This operation produces no output.

>>> client.delete_finding_aggregator(finding_aggregator_arn='arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111')

Source code in docs_src/capo_securityhub/_services/security_hub.py

def delete_finding_aggregator(
    self,
    finding_aggregator_arn: "capo_securityhub.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[SecurityHubClientConfig] = None,
) -> "capo_securityhub.types.delete_finding_aggregator_response.DeleteFindingAggregatorResponse":
    """<note> <p>The <i>aggregation Region</i> is now called the <i>home Region</i>.</p> </note> <p>Deletes a finding aggregator. When you delete the finding aggregator, you stop cross-Region aggregation. Finding replication stops occurring from the linked Regions to the home Region.</p> <p>When you stop cross-Region aggregation, findings that were already replicated and sent to the home Region are still visible from the home Region. However, new findings and finding updates are no longer replicated and sent to the home Region. </p>

    Args:
        finding_aggregator_arn: <p>The ARN of the finding aggregator to delete. To obtain the ARN, use <code>ListFindingAggregators</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 delete a finding aggregator
        The following example deletes a finding aggregator in Security Hub. Deleting the finding aggregator stops cross-Region aggregation. This operation produces no output.

        >>> client.delete_finding_aggregator(finding_aggregator_arn='arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111')
    """

    def _handler(
        req: "OperationRequest[capo_securityhub.types.delete_finding_aggregator_request.DeleteFindingAggregatorRequest]",
    ) -> OperationResponse[
        "capo_securityhub.types.delete_finding_aggregator_response.DeleteFindingAggregatorResponse"
    ]:
        import capo_securityhub._operations.security_hub_api_service.delete_finding_aggregator

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteFindingAggregator")
    )
    input_: capo_securityhub.types.delete_finding_aggregator_request.DeleteFindingAggregatorRequest = {
        "finding_aggregator_arn": finding_aggregator_arn
    }

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