start_workflow_run async ¶

async def start_workflow_run(
    self,
    space_name: "capo_codecatalyst.types.name_string.NameString",
    project_name: "capo_codecatalyst.types.name_string.NameString",
    workflow_id: "capo_codecatalyst.types.uuid.Uuid",
    *,
    config_overrides: Optional[AsyncCodeCatalystClientConfig] = None,
    client_token: Optional[str] = None,
) -> "capo_codecatalyst.types.start_workflow_run_response.StartWorkflowRunResponse":
    """<p>Begins a run of a specified workflow.</p>

    Args:
        space_name: <p>The name of the space.</p>
        project_name: <p>The name of the project in the space.</p>
        workflow_id: <p>The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use <a>ListWorkflows</a>.</p>
        client_token: <p>A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.</p>

    Raises:
        capo_codecatalyst.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.</p>
        capo_codecatalyst.errors.conflict_exception.ConflictException: <p>The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.</p>
        capo_codecatalyst.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.</p>
        capo_codecatalyst.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.</p>
        capo_codecatalyst.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_codecatalyst.errors.validation_exception.ValidationException: <p>The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.</p>
        capo_codecatalyst.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codecatalyst.types.start_workflow_run_request.StartWorkflowRunRequest]",
    ) -> AsyncOperationResponse[
        "capo_codecatalyst.types.start_workflow_run_response.StartWorkflowRunResponse"
    ]:
        import capo_codecatalyst._operations.code_catalyst.start_workflow_run

        (
            output,
            http_response,
        ) = await capo_codecatalyst._operations.code_catalyst.start_workflow_run.async_start_workflow_run(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartWorkflowRun")
    )
    input_: capo_codecatalyst.types.start_workflow_run_request.StartWorkflowRunRequest = {
        "space_name": space_name,
        "project_name": project_name,
        "workflow_id": workflow_id,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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