SageMaker / Client / describe_cluster_scheduler_config

describe_cluster_scheduler_config

SageMaker.Client.describe_cluster_scheduler_config(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_cluster_scheduler_config(
    ClusterSchedulerConfigId='string',
    ClusterSchedulerConfigVersion=123
)

Parameters:

• ClusterSchedulerConfigId (string) –

  [REQUIRED]

  ID of the cluster policy.

• ClusterSchedulerConfigVersion (integer) – Version of the cluster policy.

Return type:

dict

Returns:

Response Syntax

{
    'ClusterSchedulerConfigArn': 'string',
    'ClusterSchedulerConfigId': 'string',
    'Name': 'string',
    'ClusterSchedulerConfigVersion': 123,
    'Status': 'Creating'|'CreateFailed'|'CreateRollbackFailed'|'Created'|'Updating'|'UpdateFailed'|'UpdateRollbackFailed'|'Updated'|'Deleting'|'DeleteFailed'|'DeleteRollbackFailed'|'Deleted',
    'FailureReason': 'string',
    'ClusterArn': 'string',
    'SchedulerConfig': {
        'PriorityClasses': [
            {
                'Name': 'string',
                'Weight': 123
            },
        ],
        'FairShare': 'Enabled'|'Disabled'
    },
    'Description': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'CreatedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    },
    'LastModifiedTime': datetime(2015, 1, 1),
    'LastModifiedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    }
}

Response Structure

• (dict) –

  • ClusterSchedulerConfigArn (string) –

    ARN of the cluster policy.

  • ClusterSchedulerConfigId (string) –

    ID of the cluster policy.

  • Name (string) –

    Name of the cluster policy.

  • ClusterSchedulerConfigVersion (integer) –

    Version of the cluster policy.

  • Status (string) –

    Status of the cluster policy.

  • FailureReason (string) –

    Failure reason of the cluster policy.

  • ClusterArn (string) –

    ARN of the cluster where the cluster policy is applied.

  • SchedulerConfig (dict) –

    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.

    • 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) –

          Name of the priority class.

        • Weight (integer) –

          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.

  • CreationTime (datetime) –

    Creation time of the cluster policy.

  • CreatedBy (dict) –

    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

    • UserProfileArn (string) –

      The Amazon Resource Name (ARN) of the user’s profile.

    • UserProfileName (string) –

      The name of the user’s profile.

    • DomainId (string) –

      The domain associated with the user.

    • IamIdentity (dict) –

      The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the IAM identity.

      • PrincipalId (string) –

        The ID of the principal that assumes the IAM identity.

      • SourceIdentity (string) –

        The person or application which assumes the IAM identity.

  • LastModifiedTime (datetime) –

    Last modified time of the cluster policy.

  • LastModifiedBy (dict) –

    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

    • UserProfileArn (string) –

      The Amazon Resource Name (ARN) of the user’s profile.

    • UserProfileName (string) –

      The name of the user’s profile.

    • DomainId (string) –

      The domain associated with the user.

    • IamIdentity (dict) –

      The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the IAM identity.

      • PrincipalId (string) –

        The ID of the principal that assumes the IAM identity.

      • SourceIdentity (string) –

        The person or application which assumes the IAM identity.

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound