Skip to content

get_workflow_runs async

get_workflow_runs(
    name: NameString,
    *,
    config_overrides: Optional[AsyncGlueClientConfig] = None,
    include_graph: Optional[NullableBoolean] = None,
    next_token: Optional[GenericString] = None,
    max_results: Optional[PageSize] = None,
) -> GetWorkflowRunsResponse

Retrieves metadata for all runs of a given workflow.

Parameters:

  • name (NameString) –

    Name of the workflow whose metadata of runs should be returned.

  • include_graph (Optional[NullableBoolean], default: None ) –

    Specifies whether to include the workflow graph in response or not.

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

    The maximum size of the response.

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

    The maximum number of workflow runs to be included in the response.

Raises:

Source code in docs_src/capo_glue/_services/async_glue.py
async def get_workflow_runs(
    self,
    name: "capo_glue.types.name_string.NameString",
    *,
    config_overrides: Optional[AsyncGlueClientConfig] = None,
    include_graph: Optional[
        "capo_glue.types.nullable_boolean.NullableBoolean"
    ] = None,
    next_token: Optional["capo_glue.types.generic_string.GenericString"] = None,
    max_results: Optional["capo_glue.types.page_size.PageSize"] = None,
) -> "capo_glue.types.get_workflow_runs_response.GetWorkflowRunsResponse":
    """<p>Retrieves metadata for all runs of a given workflow.</p>

    Args:
        name: <p>Name of the workflow whose metadata of runs should be returned.</p>
        include_graph: <p>Specifies whether to include the workflow graph in response or not.</p>
        next_token: <p>The maximum size of the response.</p>
        max_results: <p>The maximum number of workflow runs to be included in the response.</p>

    Raises:
        capo_glue.errors.entity_not_found_exception.EntityNotFoundException: <p>A specified entity does not exist</p>
        capo_glue.errors.internal_service_exception.InternalServiceException: <p>An internal service error occurred.</p>
        capo_glue.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_glue.errors.operation_timeout_exception.OperationTimeoutException: <p>The operation timed out.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_glue.types.get_workflow_runs_request.GetWorkflowRunsRequest]",
    ) -> AsyncOperationResponse[
        "capo_glue.types.get_workflow_runs_response.GetWorkflowRunsResponse"
    ]:
        import capo_glue._operations.aws_glue.get_workflow_runs

        (
            output,
            http_response,
        ) = await capo_glue._operations.aws_glue.get_workflow_runs.async_get_workflow_runs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetWorkflowRuns")
    )
    input_: capo_glue.types.get_workflow_runs_request.GetWorkflowRunsRequest = {
        "name": name
    }
    if include_graph is not None:
        input_["include_graph"] = include_graph
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output