Sign in

v1

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

Returns details about an inference experiment.

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

Headers

X-Amz-Target'SageMaker.DescribeInferenceExperiment' required

Request body

Namestring required

The name of the inference experiment to describe.

Response

Success

Arnstring required

The ARN of the inference experiment being described.

Namestring required

The name of the inference experiment.

Type'ShadowMode' required

The type of the inference experiment.

Status'Creating' | 'Created' | 'Updating' | 'Running' | 'Starting' | 'Stopping' | 'Completed' | 'Cancelled' required
<p> The status of the inference experiment. The following are the possible statuses for an inference experiment: </p> <ul> <li> <p> <code>Creating</code> - Amazon SageMaker is creating your experiment. </p> </li> <li> <p> <code>Created</code> - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time. </p> </li> <li> <p> <code>Updating</code> - When you make changes to your experiment, your experiment shows as updating. </p> </li> <li> <p> <code>Starting</code> - Amazon SageMaker is beginning your experiment. </p> </li> <li> <p> <code>Running</code> - Your experiment is in progress. </p> </li> <li> <p> <code>Stopping</code> - Amazon SageMaker is stopping your experiment. </p> </li> <li> <p> <code>Completed</code> - Your experiment has completed. </p> </li> <li> <p> <code>Cancelled</code> - When you conclude your experiment early using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html">StopInferenceExperiment</a> API, or if any operation fails with an unexpected error, it shows as cancelled. </p> </li> </ul>
StatusReasonstring

The error message or client-specified <code>Reason</code> from the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html">StopInferenceExperiment</a> API, that explains the status of the inference experiment.

Descriptionstring

The description of the inference experiment.

CreationTimestring date-time

The timestamp at which you created the inference experiment.

CompletionTimestring date-time

The timestamp at which the inference experiment was completed.

LastModifiedTimestring date-time

The timestamp at which you last modified the inference experiment.

RoleArnstring

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

KmsKeystring

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html">CreateInferenceExperiment</a>.