v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

Stops an inference experiment.

post/#X-Amz-Target=SageMaker.StopInferenceExperiment

Headers

X-Amz-Target'SageMaker.StopInferenceExperiment' required

Request body

Namestring required

The name of the inference experiment to stop.

ModelVariantActionsobject required
<p> Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following: </p> <ul> <li> <p> <code>Promote</code> - Promote the shadow variant to a production variant</p> </li> <li> <p> <code>Remove</code> - Delete the variant</p> </li> <li> <p> <code>Retain</code> - Keep the variant as it is</p> </li> </ul>
DesiredState'Completed' | 'Cancelled'
<p> The desired state of the experiment after stopping. The possible states are the following: </p> <ul> <li> <p> <code>Completed</code>: The experiment completed successfully</p> </li> <li> <p> <code>Cancelled</code>: The experiment was canceled</p> </li> </ul>
Reasonstring

The reason for stopping the experiment.

Response

Success

InferenceExperimentArnstring required

The ARN of the stopped inference experiment.