---
type: resource-type
title: InferenceExperiment
description: aws resource type AWS::SageMaker::InferenceExperiment
name: InferenceExperiment
lexicon: aws
resource_type: AWS::SageMaker::InferenceExperiment
---
`AWS::SageMaker::InferenceExperiment`, a resource type of the aws lexicon.

## Properties

- `EndpointName` (`string`, required)
- `ModelVariants` (`InferenceExperiment_ModelVariantConfig[]`, required): An array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.
- `Name` (`string`, required): The name for the inference experiment.
- `RoleArn` (`string`, required): The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
- `Type` (`"ShadowMode"`, required): The type of the inference experiment that you want to run.
- `Arn` (`string`, optional): The Amazon Resource Name (ARN) of the inference experiment.
- `CreationTime` (`string`, optional): The timestamp at which you created the inference experiment.
- `DataStorageConfig` (`InferenceExperiment_DataStorageConfig`, optional)
- `Description` (`string`, optional): The description of the inference experiment.
- `DesiredState` (`"Cancelled" | "Completed" | "Running"`, optional): The desired state of the experiment after starting or stopping operation.
- `EndpointMetadata` (`InferenceExperiment_EndpointMetadata`, optional)
- `KmsKey` (`string`, optional): The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
- `LastModifiedTime` (`string`, optional): The timestamp at which you last modified the inference experiment.
- `Schedule` (`InferenceExperiment_InferenceExperimentSchedule`, optional)
- `ShadowModeConfig` (`InferenceExperiment_ShadowModeConfig`, optional)
- `Status` (`"Cancelled" | "Completed" | "Created" | "Creating" | "Running" | "Starting" | "Stopping" | "Updating"`, optional): The status of the inference experiment.
- `StatusReason` (`string`, optional): The error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
- `Tags` (`InferenceExperiment_Tag[]`, optional): An array of key-value pairs to apply to this resource.

## Attributes

- `Arn`
- `CreationTime`
- `EndpointMetadata`
- `LastModifiedTime`
- `Status`