Skip to content

start_workflow_run

start_workflow_run(
    name: NameString,
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    run_properties: Optional[WorkflowRunProperties] = None,
) -> StartWorkflowRunResponse

Starts a new run of the specified workflow.

Parameters:

  • name (NameString) –

    The name of the workflow to start.

  • run_properties (Optional[WorkflowRunProperties], default: None ) –

    The workflow run properties for the new workflow run.

    Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.

Raises:

Source code in docs_src/capo_glue/_services/glue.py
def start_workflow_run(
    self,
    name: "capo_glue.types.name_string.NameString",
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    run_properties: Optional[
        "capo_glue.types.workflow_run_properties.WorkflowRunProperties"
    ] = None,
) -> "capo_glue.types.start_workflow_run_response.StartWorkflowRunResponse":
    """<p>Starts a new run of the specified workflow.</p>

    Args:
        name: <p>The name of the workflow to start.</p>
        run_properties: <p>The workflow run properties for the new workflow run.</p> <p>Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.</p>

    Raises:
        capo_glue.errors.concurrent_runs_exceeded_exception.ConcurrentRunsExceededException: <p>Too many jobs are being run concurrently.</p>
        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.resource_number_limit_exceeded_exception.ResourceNumberLimitExceededException: <p>A resource numerical limit was exceeded.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_glue.types.start_workflow_run_request.StartWorkflowRunRequest]",
    ) -> OperationResponse[
        "capo_glue.types.start_workflow_run_response.StartWorkflowRunResponse"
    ]:
        import capo_glue._operations.aws_glue.start_workflow_run

        output, http_response = (
            capo_glue._operations.aws_glue.start_workflow_run.start_workflow_run(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartWorkflowRun")
    )
    input_: capo_glue.types.start_workflow_run_request.StartWorkflowRunRequest = {
        "name": name
    }
    if run_properties is not None:
        input_["run_properties"] = run_properties

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