AWS CLI Command Reference

Note:

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 ]

batch-add-cluster-nodes

Description

Adds nodes to a HyperPod cluster by incrementing the target count for one or more instance groups. This operation returns a unique NodeLogicalId for each node being added, which can be used to track the provisioning status of the node. This API provides a safer alternative to UpdateCluster for scaling operations by avoiding unintended configuration changes.

Note

This API is only supported for clusters using Continuous as the NodeProvisioningMode .

See also: AWS API Documentation

Synopsis

  batch-add-cluster-nodes
--cluster-name <value>
[--client-token <value>]
--nodes-to-add <value>
[--cli-input-json <value>]
[--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>]

Options

--cluster-name (string)

The name of the HyperPod cluster to which you want to add nodes.

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 8 hours. If you retry the request with the same client token within this timeframe and the same parameters, the API returns the same set of NodeLogicalIds with their latest status.

--nodes-to-add (list)

A list of instance groups and the number of nodes to add to each. You can specify up to 5 instance groups in a single request, with a maximum of 50 nodes total across all instance groups.

(structure)

Specifies an instance group and the number of nodes to add to it.

InstanceGroupName -> (string)

The name of the instance group to which you want to add nodes.

IncrementTargetCountBy -> (integer)

The number of nodes to add to the specified instance group. The total number of nodes across all instance groups in a single request cannot exceed 50.

Shorthand Syntax:

InstanceGroupName=string,IncrementTargetCountBy=integer ...

JSON Syntax:

[
  {
    "InstanceGroupName": "string",
    "IncrementTargetCountBy": integer
  }
  ...
]

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

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

Output

Successful -> (list)

A list of NodeLogicalIDs that were successfully added to the cluster. The NodeLogicalID is unique per cluster and does not change between instance replacements. Each entry includes a NodeLogicalId that can be used to track the node’s provisioning status (with DescribeClusterNode ), the instance group name, and the current status of the node.

(structure)

Information about a node that was successfully added to the cluster.

NodeLogicalId -> (string)

A unique identifier assigned to the node that can be used to track its provisioning status through the DescribeClusterNode operation.

InstanceGroupName -> (string)

The name of the instance group to which the node was added.

Status -> (string)

The current status of the node. Possible values include Pending , Running , Failed , ShuttingDown , SystemUpdating , DeepHealthCheckInProgress , and NotFound .

Failed -> (list)

A list of errors that occurred during the node addition operation. Each entry includes the instance group name, error code, number of failed additions, and an error message.

(structure)

Information about an error that occurred during the node addition operation.

InstanceGroupName -> (string)

The name of the instance group for which the error occurred.

ErrorCode -> (string)

The error code associated with the failure. Possible values include InstanceGroupNotFound and InvalidInstanceGroupState .

FailedCount -> (integer)

The number of nodes that failed to be added to the specified instance group.

Message -> (string)

A descriptive message providing additional details about the error.