Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateInferenceExperiment

Updates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperiment.

Request Syntax


{
   "DataStorageConfig": { 
      "ContentType": { 
         "CsvContentTypes": [ "string" ],
         "JsonContentTypes": [ "string" ]
      },
      "Destination": "string",
      "KmsKey": "string"
   },
   "Description": "string",
   "ModelVariants": [ 
      { 
         "InfrastructureConfig": { 
            "InfrastructureType": "string",
            "RealTimeInferenceConfig": { 
               "InstanceCount": number,
               "InstanceType": "string"
            }
         },
         "ModelName": "string",
         "VariantName": "string"
      }
   ],
   "Name": "string",
   "Schedule": { 
      "EndTime": number,
      "StartTime": number
   },
   "ShadowModeConfig": { 
      "ShadowModelVariants": [ 
         { 
            "SamplingPercentage": number,
            "ShadowModelVariantName": "string"
         }
      ],
      "SourceModelVariantName": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DataStorageConfig

The Amazon S3 location and configuration for storing inference request and response data.

Type: InferenceExperimentDataStorageConfig object

Required: No

Description

The description of the inference experiment.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No

ModelVariants

An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure configuration you want to update.

Type: Array of ModelVariantConfig objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: No

Name

The name of the inference experiment to be updated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 120.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}

Required: Yes

Schedule

The duration for which the inference experiment will run. If the status of the inference experiment is Created, then you can update both the start and end dates. If the status of the inference experiment is Running, then you can update only the end date.

Type: InferenceExperimentSchedule object

Required: No

ShadowModeConfig

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

Type: ShadowModeConfig object

Required: No

Response Syntax


{
   "InferenceExperimentArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

InferenceExperimentArn

The ARN of the updated inference experiment.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:inference-experiment/.*

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

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

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400