import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { StopPipelineExecutionRequest, StopPipelineExecutionResponse } from "../models/models_5"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link StopPipelineExecutionCommand}. */ export interface StopPipelineExecutionCommandInput extends StopPipelineExecutionRequest { } /** * @public * * The output of {@link StopPipelineExecutionCommand}. */ export interface StopPipelineExecutionCommandOutput extends StopPipelineExecutionResponse, __MetadataBearer { } declare const StopPipelineExecutionCommand_base: { new (input: StopPipelineExecutionCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: StopPipelineExecutionCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Stops a pipeline execution.

Callback Step

A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping".

You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

Lambda Step

A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SageMakerClient, StopPipelineExecutionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import * // const { SageMakerClient, StopPipelineExecutionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import * const client = new SageMakerClient(config); * const input = { // StopPipelineExecutionRequest * PipelineExecutionArn: "STRING_VALUE", // required * ClientRequestToken: "STRING_VALUE", // required * }; * const command = new StopPipelineExecutionCommand(input); * const response = await client.send(command); * // { // StopPipelineExecutionResponse * // PipelineExecutionArn: "STRING_VALUE", * // }; * * ``` * * @param StopPipelineExecutionCommandInput - {@link StopPipelineExecutionCommandInput} * @returns {@link StopPipelineExecutionCommandOutput} * @see {@link StopPipelineExecutionCommandInput} for command's `input` shape. * @see {@link StopPipelineExecutionCommandOutput} for command's `response` shape. * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. * * @throws {@link ConflictException} (client fault) *

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

* * @throws {@link ResourceNotFound} (client fault) *

Resource being access is not found.

* * @throws {@link SageMakerServiceException} *

Base exception class for all service exceptions from SageMaker service.

* * * @public */ export declare class StopPipelineExecutionCommand extends StopPipelineExecutionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StopPipelineExecutionRequest; output: StopPipelineExecutionResponse; }; sdk: { input: StopPipelineExecutionCommandInput; output: StopPipelineExecutionCommandOutput; }; }; }