@docusign/iam-sdk/dist/commonjs/funcs/maestroWorkflowInstanceManagementCancelWorkflowInstance.d.ts

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.

import { IamClientCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import * as components from "../models/components/index.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
import { IamClientError } from "../models/errors/iamclienterror.js";
import * as errors from "../models/errors/index.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import * as operations from "../models/operations/index.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
 * Cancel a Running Workflow Instance
 *
 * @remarks
 * This operation cancels a running Maestro workflow instance by its unique identifier (`instanceId`).
 * Once canceled, the workflow instance will no longer continue executing any remaining steps.
 *
 * ### Use Cases:
 * - Stopping a workflow execution when it is no longer needed or relevant
 * - Manually intervening in a workflow to prevent it from reaching completion if conditions change
 *
 * ### Key Features:
 * - **Immediate Termination**: Ensures the workflow instance no longer processes subsequent steps
 * - **Clear Feedback**: Returns a confirmation message including both the instance and workflow identifiers
 */
export declare function maestroWorkflowInstanceManagementCancelWorkflowInstance(client: IamClientCore, request: operations.CancelWorkflowInstanceRequest, options?: RequestOptions): APIPromise<Result<components.CancelWorkflowInstanceResponse, errors.ErrorT | IamClientError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=maestroWorkflowInstanceManagementCancelWorkflowInstance.d.ts.map