list_workflows ¶

def list_workflows(
    self,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    type: Optional["capo_omics.types.workflow_type.WorkflowType"] = None,
    name: Optional["capo_omics.types.workflow_name.WorkflowName"] = None,
    starting_token: Optional[
        "capo_omics.types.workflow_list_token.WorkflowListToken"
    ] = None,
    max_results: Optional[int] = None,
) -> "capo_omics.types.list_workflows_response.ListWorkflowsResponse":
    """<p>Retrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify <code>PRIVATE</code> to retrieve a list of private workflows or specify <code>READY2RUN</code> for a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing workflows.</p>

    Args:
        type: <p>Filter the list by workflow type.</p>
        name: <p>Filter the list by workflow name.</p>
        starting_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
        max_results: <p>The maximum number of workflows to return in one page of results.</p>

    Raises:
        capo_omics.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_omics.errors.conflict_exception.ConflictException: <p>The request cannot be applied to the target resource in its current state.</p>
        capo_omics.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred. Try the request again.</p>
        capo_omics.errors.request_timeout_exception.RequestTimeoutException: <p>The request timed out.</p>
        capo_omics.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found in the current Region.</p>
        capo_omics.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeds a service quota.</p>
        capo_omics.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_omics.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_omics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_omics.types.list_workflows_request.ListWorkflowsRequest]",
    ) -> OperationResponse[
        "capo_omics.types.list_workflows_response.ListWorkflowsResponse"
    ]:
        import capo_omics._operations.omics.list_workflows

        output, http_response = (
            capo_omics._operations.omics.list_workflows.list_workflows(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWorkflows")
    )
    input_: capo_omics.types.list_workflows_request.ListWorkflowsRequest = {}
    if type is not None:
        input_["type"] = type
    if name is not None:
        input_["name"] = name
    if starting_token is not None:
        input_["starting_token"] = starting_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