SageMaker / Client / update_cluster_scheduler_config

update_cluster_scheduler_config#

SageMaker.Client.update_cluster_scheduler_config(**kwargs)#

Update the cluster policy configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_cluster_scheduler_config(
    ClusterSchedulerConfigId='string',
    TargetVersion=123,
    SchedulerConfig={
        'PriorityClasses': [
            {
                'Name': 'string',
                'Weight': 123
            },
        ],
        'FairShare': 'Enabled'|'Disabled'
    },
    Description='string'
)
Parameters:

  • ClusterSchedulerConfigId (string) –

    [REQUIRED]

    ID of the cluster policy.

  • TargetVersion (integer) –

    [REQUIRED]

    Target version.

  • SchedulerConfig (dict) –

    Cluster policy configuration.

    • PriorityClasses (list) –

      List of the priority classes, PriorityClass, of the cluster policy. When specified, these class configurations define how tasks are queued.

      • (dict) –

        Priority class configuration. When included in PriorityClasses, these class configurations define how tasks are queued.

        • Name (string) – [REQUIRED]

          Name of the priority class.

        • Weight (integer) – [REQUIRED]

          Weight of the priority class. The value is within a range from 0 to 100, where 0 is the default.

          A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the default.

    • FairShare (string) –

      When enabled, entities borrow idle compute based on their assigned FairShareWeight.

      When disabled, entities borrow idle compute based on a first-come first-serve basis.

      Default is Enabled.

  • Description (string) – Description of the cluster policy.

Return type:

dict

Returns:

Response Syntax

{
    'ClusterSchedulerConfigArn': 'string',
    'ClusterSchedulerConfigVersion': 123
}

Response Structure

  • (dict) –

    • ClusterSchedulerConfigArn (string) –

      ARN of the cluster policy.

    • ClusterSchedulerConfigVersion (integer) –

      Version of the cluster policy.

Exceptions