Skip to content

aws.sagemaker.describe_cluster

Example SQL Queries

SELECT * FROM
aws.sagemaker.describe_cluster
WHERE
"cluster_name" = 'VALUE';

Description

Retrieves information of a SageMaker HyperPod cluster.

Table Definition

Column NameColumn Data Type
cluster_name Required Input Column

The name of the SageMaker HyperPod cluster.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

cluster_arn

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

VARCHAR
cluster_status

The status of the SageMaker HyperPod cluster.

VARCHAR
creation_time

The time when the SageMaker Cluster is created.

TIMESTAMP_S
failure_message

The failure message of the SageMaker HyperPod cluster.

VARCHAR
instance_groups

The instance groups of the SageMaker HyperPod cluster.

STRUCT(
"current_count" BIGINT,
"target_count" BIGINT,
"instance_group_name" VARCHAR,
"instance_type" VARCHAR,
"life_cycle_config" STRUCT(
"source_s3_uri" VARCHAR,
"on_create" VARCHAR
),
"execution_role" VARCHAR,
"threads_per_core" BIGINT,
"instance_storage_configs" STRUCT(
"ebs_volume_config" STRUCT(
"volume_size_in_gb" BIGINT
)
)[]
)[]
Show child fields
instance_groups[]
Show child fields
instance_groups[].current_count

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

instance_groups[].execution_role

The execution role for the instance group to assume.

instance_groups[].instance_group_name

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

instance_groups[].instance_storage_configs[]
Show child fields
instance_groups[].instance_storage_configs[].ebs_volume_config

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.

Show child fields
instance_groups[].instance_storage_configs[].ebs_volume_config.volume_size_in_gb

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.

instance_groups[].instance_type

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

instance_groups[].life_cycle_config

Details of LifeCycle configuration for the instance group.

Show child fields
instance_groups[].life_cycle_config.on_create

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

instance_groups[].life_cycle_config.source_s3_uri

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

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-.

instance_groups[].target_count

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

instance_groups[].threads_per_core

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.

vpc_config

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.

STRUCT(
"security_group_ids" VARCHAR[],
"subnets" VARCHAR[]
)
Show child fields
vpc_config.security_group_ids[]
vpc_config.subnets[]