list_workloads ¶

def list_workloads(
    self,
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    workload_name_prefix: Optional[
        "capo_wellarchitected.types.workload_name_prefix.WorkloadNamePrefix"
    ] = None,
    next_token: Optional["capo_wellarchitected.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_wellarchitected.types.max_results.MaxResults"
    ] = None,
) -> "capo_wellarchitected.types.list_workloads_output.ListWorkloadsOutput":
    """<p>Paginated list of workloads.</p>

    Args:
        max_results: <p>The maximum number of results to return for this request.</p>

    Raises:
        capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
        capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
        capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_wellarchitected.types.list_workloads_input.ListWorkloadsInput]",
    ) -> OperationResponse[
        "capo_wellarchitected.types.list_workloads_output.ListWorkloadsOutput"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.list_workloads

        output, http_response = (
            capo_wellarchitected._operations.well_architected_api_service_lambda.list_workloads.list_workloads(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWorkloads")
    )
    input_: capo_wellarchitected.types.list_workloads_input.ListWorkloadsInput = {}
    if workload_name_prefix is not None:
        input_["workload_name_prefix"] = workload_name_prefix
    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