Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateComputeQuota

Create compute allocation definition. This defines how compute is allocated, shared, and borrowed for specified entities. Specifically, how to lend and borrow idle compute and assign a fair-share weight to the specified entities.

Request Syntax


{
   "ActivationState": "string",
   "ClusterArn": "string",
   "ComputeQuotaConfig": { 
      "ComputeQuotaResources": [ 
         { 
            "AcceleratorPartition": { 
               "Count": number,
               "Type": "string"
            },
            "Accelerators": number,
            "Count": number,
            "InstanceType": "string",
            "MemoryInGiB": number,
            "VCpu": number
         }
      ],
      "PreemptTeamTasks": "string",
      "ResourceSharingConfig": { 
         "AbsoluteBorrowLimits": [ 
            { 
               "AcceleratorPartition": { 
                  "Count": number,
                  "Type": "string"
               },
               "Accelerators": number,
               "Count": number,
               "InstanceType": "string",
               "MemoryInGiB": number,
               "VCpu": number
            }
         ],
         "BorrowLimit": number,
         "Strategy": "string"
      }
   },
   "ComputeQuotaTarget": { 
      "FairShareWeight": number,
      "TeamName": "string"
   },
   "Description": "string",
   "Name": "string",
   "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.

ActivationState

The state of the compute allocation being described. Use to enable or disable compute allocation.

Default is Enabled.

Type: String

Valid Values: Enabled | Disabled

Required: No

ClusterArn

ARN of the cluster.

Type: String

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

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

Required: Yes

ComputeQuotaConfig

Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

Type: ComputeQuotaConfig object

Required: Yes

ComputeQuotaTarget

The target entity to allocate compute resources to.

Type: ComputeQuotaTarget object

Required: Yes

Description

Description of the compute allocation definition.

Type: String

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

Pattern: [\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*

Required: No

Name

The name of the compute allocation definition. The name must be unique within the SageMaker AI HyperPod cluster specified by ClusterArn. You can use the same name in other clusters within a Region or across Regions.

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

Tags

Tags of the compute allocation definition.

Type: Array of Tag objects

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

Required: No

Response Syntax


{
   "ComputeQuotaArn": "string",
   "ComputeQuotaId": "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.

ComputeQuotaArn

ARN of the compute allocation definition.

Type: String

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

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:compute-quota/[a-z0-9]{12}

ComputeQuotaId

ID of the compute allocation definition.

Type: String

Pattern: [a-z0-9]{12}

Errors

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

ConflictException

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

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