list_workflow_runs ¶

def list_workflow_runs(
    self,
    space_name: "capo_codecatalyst.types.name_string.NameString",
    project_name: "capo_codecatalyst.types.name_string.NameString",
    *,
    config_overrides: Optional[CodeCatalystClientConfig] = None,
    workflow_id: Optional["capo_codecatalyst.types.uuid.Uuid"] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
    sort_by: Optional[
        "capo_codecatalyst.types.workflow_run_sort_criteria_list.WorkflowRunSortCriteriaList"
    ] = None,
) -> "capo_codecatalyst.types.list_workflow_runs_response.ListWorkflowRunsResponse":
    """<p>Retrieves a list of workflow runs of a specified workflow.</p>

    Args:
        space_name: <p>The name of the space.</p>
        workflow_id: <p>The ID of the workflow. To retrieve a list of workflow IDs, use <a>ListWorkflows</a>.</p>
        project_name: <p>The name of the project in the space.</p>
        next_token: <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
        max_results: <p>The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results.</p>
        sort_by: <p>Information used to sort the items in the returned list.</p>

    Raises:
        capo_codecatalyst.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.</p>
        capo_codecatalyst.errors.conflict_exception.ConflictException: <p>The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.</p>
        capo_codecatalyst.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.</p>
        capo_codecatalyst.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.</p>
        capo_codecatalyst.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_codecatalyst.errors.validation_exception.ValidationException: <p>The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.</p>
        capo_codecatalyst.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codecatalyst.types.list_workflow_runs_request.ListWorkflowRunsRequest]",
    ) -> OperationResponse[
        "capo_codecatalyst.types.list_workflow_runs_response.ListWorkflowRunsResponse"
    ]:
        import capo_codecatalyst._operations.code_catalyst.list_workflow_runs

        output, http_response = (
            capo_codecatalyst._operations.code_catalyst.list_workflow_runs.list_workflow_runs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWorkflowRuns")
    )
    input_: capo_codecatalyst.types.list_workflow_runs_request.ListWorkflowRunsRequest = {
        "space_name": space_name,
        "project_name": project_name,
    }
    if workflow_id is not None:
        input_["workflow_id"] = workflow_id
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if sort_by is not None:
        input_["sort_by"] = sort_by

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