SageMaker / Client / describe_cluster

describe_cluster#

SageMaker.Client.describe_cluster(**kwargs)#

Retrieves information of a SageMaker HyperPod cluster.

See also: AWS API Documentation

Request Syntax

response = client.describe_cluster(
    ClusterName='string'
)
Parameters:

ClusterName (string) –

[REQUIRED]

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

Return type:

dict

Returns:

Response Syntax

{
    'ClusterArn': 'string',
    'ClusterName': 'string',
    'ClusterStatus': 'Creating'|'Deleting'|'Failed'|'InService'|'RollingBack'|'SystemUpdating'|'Updating',
    'CreationTime': datetime(2015, 1, 1),
    'FailureMessage': 'string',
    'InstanceGroups': [
        {
            'CurrentCount': 123,
            'TargetCount': 123,
            'InstanceGroupName': 'string',
            'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge',
            'LifeCycleConfig': {
                'SourceS3Uri': 'string',
                'OnCreate': 'string'
            },
            'ExecutionRole': 'string',
            'ThreadsPerCore': 123,
            'InstanceStorageConfigs': [
                {
                    'EbsVolumeConfig': {
                        'VolumeSizeInGB': 123
                    }
                },
            ],
            'OnStartDeepHealthChecks': [
                'InstanceStress'|'InstanceConnectivity',
            ],
            'Status': 'InService'|'Creating'|'Updating'|'Failed'|'Degraded'|'SystemUpdating'|'Deleting',
            'TrainingPlanArn': 'string',
            'TrainingPlanStatus': 'string',
            'OverrideVpcConfig': {
                'SecurityGroupIds': [
                    'string',
                ],
                'Subnets': [
                    'string',
                ]
            }
        },
    ],
    'VpcConfig': {
        'SecurityGroupIds': [
            'string',
        ],
        'Subnets': [
            'string',
        ]
    },
    'Orchestrator': {
        'Eks': {
            'ClusterArn': 'string'
        }
    },
    'NodeRecovery': 'Automatic'|'None'
}

Response Structure

  • (dict) –

    • ClusterArn (string) –

      The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

    • ClusterName (string) –

      The name of the SageMaker HyperPod cluster.

    • ClusterStatus (string) –

      The status of the SageMaker HyperPod cluster.

    • CreationTime (datetime) –

      The time when the SageMaker Cluster is created.

    • FailureMessage (string) –

      The failure message of the SageMaker HyperPod cluster.

    • InstanceGroups (list) –

      The instance groups of the SageMaker HyperPod cluster.

      • (dict) –

        Details of an instance group in a SageMaker HyperPod cluster.

        • CurrentCount (integer) –

          The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

        • TargetCount (integer) –

          The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

        • InstanceGroupName (string) –

          The name of the instance group of a SageMaker HyperPod cluster.

        • InstanceType (string) –

          The instance type of the instance group of a SageMaker HyperPod cluster.

        • LifeCycleConfig (dict) –

          Details of LifeCycle configuration for the instance group.

          • SourceS3Uri (string) –

            An Amazon S3 bucket path where your lifecycle scripts are stored.

            Warning

            Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the specific prefix sagemaker-.

          • OnCreate (string) –

            The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.

        • ExecutionRole (string) –

          The execution role for the instance group to assume.

        • ThreadsPerCore (integer) –

          The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

        • InstanceStorageConfigs (list) –

          The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.

          • (dict) –

            Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: EbsVolumeConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

            • EbsVolumeConfig (dict) –

              Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

              • VolumeSizeInGB (integer) –

                The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

        • OnStartDeepHealthChecks (list) –

          A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

          • (string) –

        • Status (string) –

          The current status of the cluster instance group.

          • InService: The instance group is active and healthy.

          • Creating: The instance group is being provisioned.

          • Updating: The instance group is being updated.

          • Failed: The instance group has failed to provision or is no longer healthy.

          • Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

          • Deleting: The instance group is being deleted.

        • TrainingPlanArn (string) –

          The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.

          For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.

        • TrainingPlanStatus (string) –

          The current status of the training plan associated with this cluster instance group.

        • OverrideVpcConfig (dict) –

          Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

          • SecurityGroupIds (list) –

            The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

            • (string) –

          • Subnets (list) –

            The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

            • (string) –

    • VpcConfig (dict) –

      Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

      • SecurityGroupIds (list) –

        The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

        • (string) –

      • Subnets (list) –

        The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

        • (string) –

    • Orchestrator (dict) –

      The type of orchestrator used for the SageMaker HyperPod cluster.

      • Eks (dict) –

        The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.

        • ClusterArn (string) –

          The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod cluster.

    • NodeRecovery (string) –

      The node recovery mode configured for the SageMaker HyperPod cluster.

Exceptions