You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]



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

See also: AWS API Documentation


--cluster-name <value>
--node-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--endpoint-url <value>]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]


--cluster-name (string)

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

--node-id (string)

The ID of the instance.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.


NodeDetails -> (structure)

The details of the instance.

InstanceGroupName -> (string)

The instance group name in which the instance is.

InstanceId -> (string)

The ID of the instance.

InstanceStatus -> (structure)

The status of the instance.

Status -> (string)

The status of an instance in a SageMaker HyperPod cluster.

Message -> (string)

The message from an instance in a SageMaker HyperPod cluster.

InstanceType -> (string)

The type of the instance.

LaunchTime -> (timestamp)

The time when the instance is launched.

LifeCycleConfig -> (structure)

The LifeCycle configuration applied to the instance.

SourceS3Uri -> (string)

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

OnCreate -> (string)

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

ThreadsPerCore -> (integer)

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