CreateClusterSchedulerConfig
Create cluster policy configuration. This policy is used for task prioritization and fair-share allocation of idle compute. This helps prioritize critical workloads and distributes idle compute across entities.
Request Syntax
{
"ClusterArn": "string",
"Description": "string",
"Name": "string",
"SchedulerConfig": {
"FairShare": "string",
"PriorityClasses": [
{
"Name": "string",
"Weight": number
}
]
},
"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.
- ClusterArn
-
ARN of the cluster.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$Required: Yes
- Description
-
Description of the cluster policy.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*Required: No
- Name
-
Name for the cluster policy.
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
- SchedulerConfig
-
Configuration about the monitoring schedule.
Type: SchedulerConfig object
Required: Yes
- Tags
-
Tags of the cluster policy.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Syntax
{
"ClusterSchedulerConfigArn": "string",
"ClusterSchedulerConfigId": "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.
- ClusterSchedulerConfigArn
-
ARN of the cluster policy.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:cluster-scheduler-config/[a-z0-9]{12}$ - ClusterSchedulerConfigId
-
ID of the cluster policy.
Type: String
Length Constraints: Maximum length of 12.
Pattern:
^[a-z0-9]{12}$
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
ExperimentorArtifact.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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
