Skip to content

get_workflow_run async

get_workflow_run(
    workflow_definition_name: WorkflowDefinitionName,
    workflow_run_id: UuidString,
    *,
    config_overrides: Optional[AsyncNovaActClientConfig] = None,
) -> GetWorkflowRunResponse

Retrieves the current state, configuration, and execution details of a workflow run.

Parameters:

  • workflow_definition_name (WorkflowDefinitionName) –

    The name of the workflow definition containing the workflow run.

  • workflow_run_id (UuidString) –

    The unique identifier of the workflow run to retrieve.

Raises:

Source code in docs_src/capo_nova_act/_services/async_nova_act.py
async def get_workflow_run(
    self,
    workflow_definition_name: "capo_nova_act.types.workflow_definition_name.WorkflowDefinitionName",
    workflow_run_id: "capo_nova_act.types.uuid_string.UuidString",
    *,
    config_overrides: Optional[AsyncNovaActClientConfig] = None,
) -> "capo_nova_act.types.get_workflow_run_response.GetWorkflowRunResponse":
    """<p>Retrieves the current state, configuration, and execution details of a workflow run.</p>

    Args:
        workflow_definition_name: <p>The name of the workflow definition containing the workflow run.</p>
        workflow_run_id: <p>The unique identifier of the workflow run to retrieve.</p>

    Raises:
        capo_nova_act.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permissions to perform this action.</p>
        capo_nova_act.errors.conflict_exception.ConflictException: <p>The request could not be completed due to a conflict with the current state of the resource.</p>
        capo_nova_act.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Please try again later.</p>
        capo_nova_act.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</p>
        capo_nova_act.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests. Please try again later.</p>
        capo_nova_act.errors.validation_exception.ValidationException: <p>The input parameters for the request are invalid.</p>
        capo_nova_act.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_nova_act.types.get_workflow_run_request.GetWorkflowRunRequest]",
    ) -> AsyncOperationResponse[
        "capo_nova_act.types.get_workflow_run_response.GetWorkflowRunResponse"
    ]:
        import capo_nova_act._operations.amazon_nova_agents_data_plane.get_workflow_run

        (
            output,
            http_response,
        ) = await capo_nova_act._operations.amazon_nova_agents_data_plane.get_workflow_run.async_get_workflow_run(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetWorkflowRun")
    )
    input_: capo_nova_act.types.get_workflow_run_request.GetWorkflowRunRequest = {
        "workflow_definition_name": workflow_definition_name,
        "workflow_run_id": workflow_run_id,
    }

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