Describe Cluster Scheduler Config

sagemaker_describe_cluster_scheduler_config

R Documentation

Description of the cluster policy¶

Description¶

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.

Usage¶

sagemaker_describe_cluster_scheduler_config(ClusterSchedulerConfigId,
  ClusterSchedulerConfigVersion)

Arguments¶

ClusterSchedulerConfigId: [required] ID of the cluster policy.
ClusterSchedulerConfigVersion: Version of the cluster policy.

Value¶

A list with the following syntax:

list(
  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 = list(
    PriorityClasses = list(
      list(
        Name = "string",
        Weight = 123
      )
    ),
    FairShare = "Enabled"|"Disabled"
  ),
  Description = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  CreatedBy = list(
    UserProfileArn = "string",
    UserProfileName = "string",
    DomainId = "string",
    IamIdentity = list(
      Arn = "string",
      PrincipalId = "string",
      SourceIdentity = "string"
    )
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedBy = list(
    UserProfileArn = "string",
    UserProfileName = "string",
    DomainId = "string",
    IamIdentity = list(
      Arn = "string",
      PrincipalId = "string",
      SourceIdentity = "string"
    )
  )
)

Request syntax¶

svc$describe_cluster_scheduler_config(
  ClusterSchedulerConfigId = "string",
  ClusterSchedulerConfigVersion = 123
)