AWS CLI Command Reference

[ aws . sagemaker ]

batch-reboot-cluster-nodes

Description

Reboots specific nodes within a SageMaker HyperPod cluster using a soft recovery mechanism. BatchRebootClusterNodes performs a graceful reboot of the specified nodes by calling the Amazon Elastic Compute Cloud RebootInstances API, which attempts to cleanly shut down the operating system before restarting the instance.

This operation is useful for recovering from transient issues or applying certain configuration changes that require a restart.

Note

  • Rebooting a node may cause temporary service interruption for workloads running on that node. Ensure your workloads can handle node restarts or use appropriate scheduling to minimize impact.
  • You can reboot up to 25 nodes in a single request.
  • For SageMaker HyperPod clusters using the Slurm workload manager, ensure rebooting nodes will not disrupt critical cluster operations.

See also: AWS API Documentation

Synopsis

  batch-reboot-cluster-nodes
--cluster-name <value>
[--node-ids <value>]
[--node-logical-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--cluster-name (string) [required]

The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster containing the nodes to reboot.

Constraints:

  • min: 0
  • max: 256
  • pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})

--node-ids (list)

A list of EC2 instance IDs to reboot using soft recovery. You can specify between 1 and 25 instance IDs.

Note

  • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.
  • Each instance ID must follow the pattern i- followed by 17 hexadecimal characters (for example, i-0123456789abcdef0 ).

Constraints:

  • min: 1
  • max: 25

(string)

Constraints:

  • min: 1
  • max: 256
  • pattern: i-[a-f0-9]{8}(?:[a-f0-9]{9})?

Syntax:

"string" "string" ...

--node-logical-ids (list)

A list of logical node IDs to reboot using soft recovery. You can specify between 1 and 25 logical node IDs.

The NodeLogicalId is a unique identifier that persists throughout the node’s lifecycle and can be used to track nodes that are still being provisioned and don’t yet have an EC2 instance ID assigned.

Warning

  • This parameter is only supported for clusters using Continuous as the NodeProvisioningMode . For clusters using the default provisioning mode, use NodeIds instead.
  • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

Constraints:

  • min: 1
  • max: 25

(string)

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Successful -> (list)

A list of EC2 instance IDs for which the reboot operation was successfully initiated.

Constraints:

  • min: 1
  • max: 3000

(string)

Constraints:

  • min: 1
  • max: 256
  • pattern: i-[a-f0-9]{8}(?:[a-f0-9]{9})?

Failed -> (list)

A list of errors encountered for EC2 instance IDs that could not be rebooted. Each error includes the instance ID, an error code, and a descriptive message.

Constraints:

  • min: 0
  • max: 25

(structure)

Represents an error encountered when rebooting a node from a SageMaker HyperPod cluster.

NodeId -> (string) [required]

The EC2 instance ID of the node that encountered an error during the reboot operation.

Constraints:

  • min: 1
  • max: 256
  • pattern: i-[a-f0-9]{8}(?:[a-f0-9]{9})?

ErrorCode -> (string) [required]

The error code associated with the error encountered when rebooting a node.

Possible values:

  • InstanceIdNotFound : The instance does not exist in the specified cluster.
  • InvalidInstanceStatus : The instance is in a state that does not allow rebooting. Wait for the instance to finish any ongoing changes before retrying.
  • InstanceIdInUse : Another operation is already in progress for this node. Wait for the operation to complete before retrying.
  • InternalServerError : An internal error occurred while processing this node.

Possible values:

  • InstanceIdNotFound
  • InvalidInstanceStatus
  • InstanceIdInUse
  • InternalServerError

Message -> (string) [required]

A human-readable message describing the error encountered when rebooting a node.

FailedNodeLogicalIds -> (list)

A list of errors encountered for logical node IDs that could not be rebooted. Each error includes the logical node ID, an error code, and a descriptive message. This field is only present when NodeLogicalIds were provided in the request.

Constraints:

  • min: 0
  • max: 25

(structure)

Represents an error encountered when rebooting a node (identified by its logical node ID) from a SageMaker HyperPod cluster.

NodeLogicalId -> (string) [required]

The logical node ID of the node that encountered an error during the reboot operation.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]

ErrorCode -> (string) [required]

The error code associated with the error encountered when rebooting a node by logical node ID.

Possible values:

  • InstanceIdNotFound : The node does not exist in the specified cluster.
  • InvalidInstanceStatus : The node is in a state that does not allow rebooting. Wait for the node to finish any ongoing changes before retrying.
  • InstanceIdInUse : Another operation is already in progress for this node. Wait for the operation to complete before retrying.
  • InternalServerError : An internal error occurred while processing this node.

Possible values:

  • InstanceIdNotFound
  • InvalidInstanceStatus
  • InstanceIdInUse
  • InternalServerError

Message -> (string) [required]

A human-readable message describing the error encountered when rebooting a node by logical node ID.

SuccessfulNodeLogicalIds -> (list)

A list of logical node IDs for which the reboot operation was successfully initiated. This field is only present when NodeLogicalIds were provided in the request.

Constraints:

  • min: 1
  • max: 99

(string)

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]
© Copyright 2025, Amazon Web Services. Created using Sphinx.