Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeInferenceExperiment

Returns details about an inference experiment.

Request Syntax


{
   "Name": "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.

Name

The name of the inference experiment to describe.

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

Response Syntax


{
   "Arn": "string",
   "CompletionTime": number,
   "CreationTime": number,
   "DataStorageConfig": { 
      "ContentType": { 
         "CsvContentTypes": [ "string" ],
         "JsonContentTypes": [ "string" ]
      },
      "Destination": "string",
      "KmsKey": "string"
   },
   "Description": "string",
   "EndpointMetadata": { 
      "EndpointConfigName": "string",
      "EndpointName": "string",
      "EndpointStatus": "string",
      "FailureReason": "string"
   },
   "KmsKey": "string",
   "LastModifiedTime": number,
   "ModelVariants": [ 
      { 
         "InfrastructureConfig": { 
            "InfrastructureType": "string",
            "RealTimeInferenceConfig": { 
               "InstanceCount": number,
               "InstanceType": "string"
            }
         },
         "ModelName": "string",
         "Status": "string",
         "VariantName": "string"
      }
   ],
   "Name": "string",
   "RoleArn": "string",
   "Schedule": { 
      "EndTime": number,
      "StartTime": number
   },
   "ShadowModeConfig": { 
      "ShadowModelVariants": [ 
         { 
            "SamplingPercentage": number,
            "ShadowModelVariantName": "string"
         }
      ],
      "SourceModelVariantName": "string"
   },
   "Status": "string",
   "StatusReason": "string",
   "Type": "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.

Arn

The ARN of the inference experiment being described.

Type: String

Length Constraints: Maximum length of 256.

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

CompletionTime

The timestamp at which the inference experiment was completed.

Type: Timestamp

CreationTime

The timestamp at which you created the inference experiment.

Type: Timestamp

DataStorageConfig

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

Type: InferenceExperimentDataStorageConfig object

Description

The description of the inference experiment.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*

EndpointMetadata

The metadata of the endpoint on which the inference experiment ran.

Type: EndpointMetadata object

KmsKey

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. For more information, see CreateInferenceExperiment.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[a-zA-Z0-9:/_-]*$

LastModifiedTime

The timestamp at which you last modified the inference experiment.

Type: Timestamp

ModelVariants

An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

Type: Array of ModelVariantConfigSummary objects

Name

The name of the inference experiment.

Type: String

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

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

RoleArn

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.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Schedule

The duration for which the inference experiment ran or will run.

Type: InferenceExperimentSchedule object

ShadowModeConfig

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

Type: ShadowModeConfig object

Status

The status of the inference experiment. The following are the possible statuses for an inference experiment:

Creating - Amazon SageMaker is creating your experiment.
Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.
Updating - When you make changes to your experiment, your experiment shows as updating.
Starting - Amazon SageMaker is beginning your experiment.
Running - Your experiment is in progress.
Stopping - Amazon SageMaker is stopping your experiment.
Completed - Your experiment has completed.
Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

Type: String

StatusReason

The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*

Type

The type of the inference experiment.

Type: String

Valid Values: ShadowMode

Errors

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

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400