Skip to content

get_workflow async

get_workflow(
    name: NameString,
    *,
    config_overrides: Optional[AsyncGlueClientConfig] = None,
    include_graph: Optional[NullableBoolean] = None,
) -> GetWorkflowResponse

Retrieves resource metadata for a workflow.

Parameters:

  • name (NameString) –

    The name of the workflow to retrieve.

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

    Specifies whether to include a graph when returning the workflow resource metadata.

Raises:

Source code in docs_src/capo_glue/_services/async_glue.py
async def get_workflow(
    self,
    name: "capo_glue.types.name_string.NameString",
    *,
    config_overrides: Optional[AsyncGlueClientConfig] = None,
    include_graph: Optional[
        "capo_glue.types.nullable_boolean.NullableBoolean"
    ] = None,
) -> "capo_glue.types.get_workflow_response.GetWorkflowResponse":
    """<p>Retrieves resource metadata for a workflow.</p>

    Args:
        name: <p>The name of the workflow to retrieve.</p>
        include_graph: <p>Specifies whether to include a graph when returning the workflow resource metadata.</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_request.GetWorkflowRequest]",
    ) -> AsyncOperationResponse[
        "capo_glue.types.get_workflow_response.GetWorkflowResponse"
    ]:
        import capo_glue._operations.aws_glue.get_workflow

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetWorkflow")
    )
    input_: capo_glue.types.get_workflow_request.GetWorkflowRequest = {"name": name}
    if include_graph is not None:
        input_["include_graph"] = include_graph

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