Skip to content

list_finding_aggregators

list_finding_aggregators(
    *,
    config_overrides: Optional[SecurityHubClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListFindingAggregatorsResponse

If cross-Region aggregation is enabled, then ListFindingAggregators returns the Amazon Resource Name (ARN) of the finding aggregator. You can run this operation from any Amazon Web Services Region.

Parameters:

  • next_token (Optional[NextToken], default: None ) –

    The token returned with the previous set of results. Identifies the next set of results to return.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return. This operation currently only returns a single result.

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.

  • UnknownServiceError –

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

Examples:

To update the enablement status of a standard control The following example disables the specified control in the specified security standard.

>>> client.list_finding_aggregators()
Source code in docs_src/capo_securityhub/_services/security_hub.py
def list_finding_aggregators(
    self,
    *,
    config_overrides: Optional[SecurityHubClientConfig] = None,
    next_token: Optional["capo_securityhub.types.next_token.NextToken"] = None,
    max_results: Optional["capo_securityhub.types.max_results.MaxResults"] = None,
) -> "capo_securityhub.types.list_finding_aggregators_response.ListFindingAggregatorsResponse":
    """<p>If cross-Region aggregation is enabled, then <code>ListFindingAggregators</code> returns the Amazon Resource Name (ARN) of the finding aggregator. You can run this operation from any Amazon Web Services Region.</p>

    Args:
        next_token: <p>The token returned with the previous set of results. Identifies the next set of results to return.</p>
        max_results: <p>The maximum number of results to return. This operation currently only returns a single result.</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.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To update the enablement status of a standard control
        The following example disables the specified control in the specified security standard.

        >>> client.list_finding_aggregators()
    """

    def _handler(
        req: "OperationRequest[capo_securityhub.types.list_finding_aggregators_request.ListFindingAggregatorsRequest]",
    ) -> OperationResponse[
        "capo_securityhub.types.list_finding_aggregators_response.ListFindingAggregatorsResponse"
    ]:
        import capo_securityhub._operations.security_hub_api_service.list_finding_aggregators

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFindingAggregators")
    )
    input_: capo_securityhub.types.list_finding_aggregators_request.ListFindingAggregatorsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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