Skip to content

list_baselines

list_baselines(
    *,
    config_overrides: Optional[ControlTowerClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[ListBaselinesMaxResults] = None,
) -> ListBaselinesOutput

Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .

Parameters:

Raises:

Source code in docs_src/capo_controltower/_services/control_tower.py
def list_baselines(
    self,
    *,
    config_overrides: Optional[ControlTowerClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[
        "capo_controltower.types.list_baselines_max_results.ListBaselinesMaxResults"
    ] = None,
) -> "capo_controltower.types.list_baselines_output.ListBaselinesOutput":
    """<p>Returns a summary list of all available baselines. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html"> <i>the Amazon Web Services Control Tower User Guide</i> </a>.</p>

    Args:
        next_token: <p>A pagination token.</p>
        max_results: <p>The maximum number of results to be shown.</p>

    Raises:
        capo_controltower.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_controltower.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during processing of a request.</p>
        capo_controltower.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_controltower.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_controltower.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_controltower.types.list_baselines_input.ListBaselinesInput]",
    ) -> OperationResponse[
        "capo_controltower.types.list_baselines_output.ListBaselinesOutput"
    ]:
        import capo_controltower._operations.aws_control_tower_apis.list_baselines

        output, http_response = (
            capo_controltower._operations.aws_control_tower_apis.list_baselines.list_baselines(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBaselines")
    )
    input_: capo_controltower.types.list_baselines_input.ListBaselinesInput = {}
    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