DescribeClusterSchedulerConfig
Description of the cluster policy. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.
Request Syntax
{ "ClusterSchedulerConfigId": "string", "ClusterSchedulerConfigVersion": number }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.
- ClusterSchedulerConfigId
-
ID of the cluster policy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern:
[a-z0-9]{12}Required: Yes
- ClusterSchedulerConfigVersion
-
Version of the cluster policy.
Type: Integer
Required: No
Response Syntax
{ "ClusterArn": "string", "ClusterSchedulerConfigArn": "string", "ClusterSchedulerConfigId": "string", "ClusterSchedulerConfigVersion": number, "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "Description": "string", "FailureReason": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "Name": "string", "SchedulerConfig": { "FairShare": "string", "PriorityClasses": [ { "Name": "string", "Weight": number } ] }, "Status": "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.
- ClusterArn
-
ARN of the cluster where the cluster policy is applied.
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} - ClusterSchedulerConfigArn
-
ARN of the cluster policy.
Type: String
Length Constraints: Minimum length of 0. 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: Minimum length of 0. Maximum length of 12.
Pattern:
[a-z0-9]{12} - ClusterSchedulerConfigVersion
-
Version of the cluster policy.
Type: Integer
- CreatedBy
-
Information about the user who created or modified a SageMaker resource.
Type: UserContext object
- CreationTime
-
Creation time of the cluster policy.
Type: Timestamp
- Description
-
Description of the cluster policy.
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}]* - FailureReason
-
Failure reason of the cluster policy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- LastModifiedBy
-
Information about the user who created or modified a SageMaker resource.
Type: UserContext object
- LastModifiedTime
-
Last modified time of the cluster policy.
Type: Timestamp
- Name
-
Name of 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} - SchedulerConfig
-
Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.
Type: SchedulerConfig object
- Status
-
Status of the cluster policy.
Type: String
Valid Values:
Creating | CreateFailed | CreateRollbackFailed | Created | Updating | UpdateFailed | UpdateRollbackFailed | Updated | Deleting | DeleteFailed | DeleteRollbackFailed | Deleted
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: