Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateAIWorkloadConfig

Creates a reusable AI workload configuration that defines datasets, data sources, and benchmark tool settings for consistent performance testing of generative AI inference deployments on Amazon SageMaker AI.

Request Syntax


{
   "AIWorkloadConfigName": "string",
   "AIWorkloadConfigs": { 
      "WorkloadSpec": { ... }
   },
   "DatasetConfig": { ... },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

AIWorkloadConfigName

The name of the AI workload configuration. The name must be unique within your AWS account in the current AWS Region.

Type: String

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

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

Required: Yes

AIWorkloadConfigs

The benchmark tool configuration and workload specification. Provide the specification as an inline YAML or JSON string.

Type: AIWorkloadConfigs object

Required: No

DatasetConfig

The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.

Type: AIDatasetConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

Tags

The metadata that you apply to AWS resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging AWS Resources in the AWS General Reference.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax


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

AIWorkloadConfigArn

The Amazon Resource Name (ARN) of the created AI workload configuration.

Type: String

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

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:ai-workload-config/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Errors

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

ResourceInUse

Resource being accessed is in use.

HTTP Status Code: 400

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400