Skip to content

BatchAddClusterNodesRequest

Source code in docs_src/capo_sagemaker/types/batch_add_cluster_nodes_request.py 
15
16
17
18
19
20
21
22
23
class BatchAddClusterNodesRequest(TypedDict, closed=True):
    cluster_name: "capo_sagemaker.types.cluster_name_or_arn.ClusterNameOrArn"
    """<p>The name of the HyperPod cluster to which you want to add nodes.</p>"""
    client_token: NotRequired["capo_sagemaker.types.string.String"]
    """<p>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 <code>NodeLogicalIds</code> with their latest status.</p>"""
    nodes_to_add: NotRequired[
        "capo_sagemaker.types.add_cluster_node_specification_list.AddClusterNodeSpecificationList"
    ]
    """<p>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.</p>"""

client_token instance-attribute 

client_token: NotRequired[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.

cluster_name instance-attribute 

cluster_name: ClusterNameOrArn

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

nodes_to_add instance-attribute 

nodes_to_add: NotRequired[AddClusterNodeSpecificationList]

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.