cluster_scheduler_configs

Creates, updates, deletes, gets or lists a cluster_scheduler_configs resource.

Overview

Name	cluster_scheduler_configs
Type	Resource
Id	aws.sagemaker.cluster_scheduler_configs

Fields

The following fields are returned by SELECT queries:

describe_cluster_scheduler_config

Name	Datatype	Description
cluster_arn	string	ARN of the cluster where the cluster policy is applied. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:cluster/[a-z0-9]{12}</code>)
cluster_scheduler_config_arn	string	ARN of the cluster policy. (pattern: <code>arn:aws[a-z-]*:sagemaker:[a-z0-9-]{9,16}:[0-9]{12}:cluster-scheduler-config/[a-z0-9]{12}</code>)
cluster_scheduler_config_id	string	ID of the cluster policy. (pattern: <code>[a-z0-9]{12}</code>)
cluster_scheduler_config_version	integer	Version of the cluster policy.
created_by	object	Information about the user who created or modified a SageMaker resource.
creation_time	string (date-time)	Creation time of the cluster policy.
description	string	Description of the cluster policy. (pattern: <code>[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*</code>)
failure_reason	string	Failure reason of the cluster policy.
last_modified_by	object	Information about the user who created or modified a SageMaker resource.
last_modified_time	string (date-time)	Last modified time of the cluster policy.
name	string	Name of the cluster policy. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
scheduler_config	object	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.
status	string	Status of the cluster policy. (Creating, CreateFailed, CreateRollbackFailed, Created, Updating, UpdateFailed, UpdateRollbackFailed, Updated, Deleting, DeleteFailed, DeleteRollbackFailed, Deleted)
status_details	object	Additional details about the status of the cluster policy. This field provides context when the policy is in a non-active state, such as during creation, updates, or if failures occur.

list_cluster_scheduler_configs

Name	Datatype	Description
cluster_arn	string	ARN of the cluster. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:cluster/[a-z0-9]{12}</code>)
cluster_scheduler_config_arn	string	ARN of the cluster policy. (pattern: <code>arn:aws[a-z-]*:sagemaker:[a-z0-9-]{9,16}:[0-9]{12}:cluster-scheduler-config/[a-z0-9]{12}</code>)
cluster_scheduler_config_id	string	ID of the cluster policy. (pattern: <code>[a-z0-9]{12}</code>)
cluster_scheduler_config_version	integer	Version of the cluster policy.
creation_time	string (date-time)	Creation time of the cluster policy.
last_modified_time	string (date-time)	Last modified time of the cluster policy.
name	string	Name of the cluster policy. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
status	string	Status of the cluster policy. (Creating, CreateFailed, CreateRollbackFailed, Created, Updating, UpdateFailed, UpdateRollbackFailed, Updated, Deleting, DeleteFailed, DeleteRollbackFailed, Deleted)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cluster_scheduler_config	select	region		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.
list_cluster_scheduler_configs	select	region		List the cluster policy configurations.
create_cluster_scheduler_config	insert	region, ClusterArn, SchedulerConfig		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.
update_cluster_scheduler_config	update	region, ClusterSchedulerConfigId, TargetVersion		Update the cluster policy configuration.
delete_cluster_scheduler_config	delete	region		Deletes the cluster policy of the cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_cluster_scheduler_config

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.

SELECT
cluster_arn,
cluster_scheduler_config_arn,
cluster_scheduler_config_id,
cluster_scheduler_config_version,
created_by,
creation_time,
description,
failure_reason,
last_modified_by,
last_modified_time,
name,
scheduler_config,
status,
status_details
FROM aws.sagemaker.cluster_scheduler_configs
WHERE region = '{{ region }}' -- required
;

list_cluster_scheduler_configs

List the cluster policy configurations.

SELECT
cluster_arn,
cluster_scheduler_config_arn,
cluster_scheduler_config_id,
cluster_scheduler_config_version,
creation_time,
last_modified_time,
name,
status
FROM aws.sagemaker.cluster_scheduler_configs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_cluster_scheduler_config

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.

INSERT INTO aws.sagemaker.cluster_scheduler_configs (
Name,
ClusterArn,
SchedulerConfig,
Description,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ ClusterArn }}' /* required */,
'{{ SchedulerConfig }}' /* required */,
'{{ Description }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
cluster_scheduler_config_arn,
cluster_scheduler_config_id
;

Manifest

# Description fields are for documentation purposes
- name: cluster_scheduler_configs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cluster_scheduler_configs resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      Name for the cluster policy.
  - name: ClusterArn
    value: "{{ ClusterArn }}"
    description: |
      ARN of the cluster.
  - name: SchedulerConfig
    description: |
      Configuration about the monitoring schedule.
    value:
      PriorityClasses:
        - Name: "{{ Name }}"
          Weight: {{ Weight }}
      FairShare: "{{ FairShare }}"
      IdleResourceSharing: "{{ IdleResourceSharing }}"
  - name: Description
    value: "{{ Description }}"
    description: |
      Description of the cluster policy.
  - name: Tags
    description: |
      Tags of the cluster policy.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_cluster_scheduler_config

Update the cluster policy configuration.

UPDATE aws.sagemaker.cluster_scheduler_configs
SET 
ClusterSchedulerConfigId = '{{ ClusterSchedulerConfigId }}',
TargetVersion = {{ TargetVersion }},
SchedulerConfig = '{{ SchedulerConfig }}',
Description = '{{ Description }}'
WHERE 
region = '{{ region }}' --required
AND ClusterSchedulerConfigId = '{{ ClusterSchedulerConfigId }}' --required
AND TargetVersion = '{{ TargetVersion }}' --required
RETURNING
cluster_scheduler_config_arn,
cluster_scheduler_config_version;

DELETE examples

delete_cluster_scheduler_config

Deletes the cluster policy of the cluster.

DELETE FROM aws.sagemaker.cluster_scheduler_configs
WHERE region = '{{ region }}' --required
;