get_finding_aggregator `async` ¶

get_finding_aggregator(
    finding_aggregator_arn: NonEmptyString,
    *,
    config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
) -> GetFindingAggregatorResponse

The aggregation Region is now called the home Region.

Returns the current configuration in the calling account for cross-Region aggregation. A finding aggregator is a resource that establishes the home Region and any linked Regions.

Parameters:

finding_aggregator_arn (NonEmptyString) –

The ARN of the finding aggregator to return details for. 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 get cross-Region aggregation details The following example returns cross-Region aggregation details for the requesting account.

>>> await client.get_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/async_security_hub.py

async def get_finding_aggregator(
    self,
    finding_aggregator_arn: "capo_securityhub.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
) -> "capo_securityhub.types.get_finding_aggregator_response.GetFindingAggregatorResponse":
    """<note> <p>The <i>aggregation Region</i> is now called the <i>home Region</i>.</p> </note> <p>Returns the current configuration in the calling account for cross-Region aggregation. A finding aggregator is a resource that establishes the home Region and any linked Regions.</p>

    Args:
        finding_aggregator_arn: <p>The ARN of the finding aggregator to return details for. 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 get cross-Region aggregation details
        The following example returns cross-Region aggregation details for the requesting account.

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

    async def _handler(
        req: "AsyncOperationRequest[capo_securityhub.types.get_finding_aggregator_request.GetFindingAggregatorRequest]",
    ) -> AsyncOperationResponse[
        "capo_securityhub.types.get_finding_aggregator_response.GetFindingAggregatorResponse"
    ]:
        import capo_securityhub._operations.security_hub_api_service.get_finding_aggregator

        (
            output,
            http_response,
        ) = await capo_securityhub._operations.security_hub_api_service.get_finding_aggregator.async_get_finding_aggregator(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetFindingAggregator")
    )
    input_: capo_securityhub.types.get_finding_aggregator_request.GetFindingAggregatorRequest = {
        "finding_aggregator_arn": finding_aggregator_arn
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_finding_aggregator async ¶

get_finding_aggregator `async` ¶