Skip to content
AWS for Query.Farm

aws.sagemaker.describe_cluster_node

Example SQL Queries

SELECT * FROM
aws.sagemaker.describe_cluster_node
WHERE
"cluster_name" = 'VALUE'
AND "node_id" = 'VALUE';

Description

Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster.

Table Definition

Column NameColumn Data Type
cluster_name Required Input Column

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

VARCHAR
node_id Required Input Column

The ID of the SageMaker HyperPod cluster node.

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.

node_details

The details of the SageMaker HyperPod cluster node.

STRUCT(
    "instance_group_name" VARCHAR,
    "instance_id" VARCHAR,
    "instance_status" STRUCT(
        "status" VARCHAR,
        "message" VARCHAR
    ),
    "instance_type" VARCHAR,
    "launch_time" TIMESTAMP_S,
    "life_cycle_config" STRUCT(
        "source_s3_uri" VARCHAR,
        "on_create" VARCHAR
    ),
    "threads_per_core" BIGINT,
    "instance_storage_configs" STRUCT(
        "ebs_volume_config" STRUCT(
            "volume_size_in_gb" BIGINT
        )
    )[],
    "private_primary_ip" VARCHAR,
    "private_dns_hostname" VARCHAR,
    "placement" STRUCT(
        "availability_zone" VARCHAR,
        "availability_zone_id" VARCHAR
    )
)
Show child fields
node_details.instance_group_name

The instance group name in which the instance is.

node_details.instance_id

The ID of the instance.

node_details.instance_status

The status of the instance.

Show child fields
node_details.instance_status.message

The message from an instance in a SageMaker HyperPod cluster.

node_details.instance_status.status

The status of an instance in a SageMaker HyperPod cluster.

node_details.instance_storage_configs[]
Show child fields
node_details.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
node_details.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.

node_details.instance_type

The type of the instance.

node_details.launch_time

The time when the instance is launched.

node_details.life_cycle_config

The LifeCycle configuration applied to the instance.

Show child fields
node_details.life_cycle_config.on_create

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

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

node_details.placement

The placement details of the SageMaker HyperPod cluster node.

Show child fields
node_details.placement.availability_zone

The Availability Zone where the node in the SageMaker HyperPod cluster is launched.

node_details.placement.availability_zone_id

The unique identifier (ID) of the Availability Zone where the node in the SageMaker HyperPod cluster is launched.

node_details.private_dns_hostname

The private DNS hostname of the SageMaker HyperPod cluster node.

node_details.private_primary_ip

The private primary IP address of the SageMaker HyperPod cluster node.

node_details.threads_per_core

The number of threads per CPU core you specified under CreateCluster.