2025/08/05 - Amazon SageMaker Service - 3 new7 updated api methods
Changes Add support for SageMaker Hyperpod continuous scaling and custom AMI; Introduce new APIs: ListClusterEvents, DescribeClusterEvent, BatchAddClusterNodes
Retrieves a list of event summaries for a specified HyperPod cluster. The operation supports filtering, sorting, and pagination of results. This functionality is only supported when the NodeProvisioningMode is set to Continuous.
See also: AWS API Documentation
Request Syntax
client.list_cluster_events(
ClusterName='string',
InstanceGroupName='string',
NodeId='string',
EventTimeAfter=datetime(2015, 1, 1),
EventTimeBefore=datetime(2015, 1, 1),
SortBy='EventTime',
SortOrder='Ascending'|'Descending',
ResourceType='Cluster'|'InstanceGroup'|'Instance',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.
string
The name of the instance group to filter events. If specified, only events related to this instance group are returned.
string
The EC2 instance ID to filter events. If specified, only events related to this instance are returned.
datetime
The start of the time range for filtering events. Only events that occurred after this time are included in the results.
datetime
The end of the time range for filtering events. Only events that occurred before this time are included in the results.
string
The field to use for sorting the event list. Currently, the only supported value is EventTime.
string
The order in which to sort the results. Valid values are Ascending or Descending (the default is Descending).
string
The type of resource for which to filter events. Valid values are Cluster, InstanceGroup, or Instance.
integer
The maximum number of events to return in the response. Valid range is 1 to 100.
string
A token to retrieve the next set of results. This token is obtained from the output of a previous ListClusterEvents call.
dict
Response Syntax
{
'NextToken': 'string',
'Events': [
{
'EventId': 'string',
'ClusterArn': 'string',
'ClusterName': 'string',
'InstanceGroupName': 'string',
'InstanceId': 'string',
'ResourceType': 'Cluster'|'InstanceGroup'|'Instance',
'EventTime': datetime(2015, 1, 1),
'Description': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
A token to retrieve the next set of results. Include this token in subsequent ListClusterEvents calls to fetch more events.
Events (list) --
A list of event summaries matching the specified criteria.
(dict) --
A summary of an event in a SageMaker HyperPod cluster.
EventId (string) --
The unique identifier (UUID) of the event.
ClusterArn (string) --
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster associated with the event.
ClusterName (string) --
The name of the SageMaker HyperPod cluster associated with the event.
InstanceGroupName (string) --
The name of the instance group associated with the event, if applicable.
InstanceId (string) --
The EC2 instance ID associated with the event, if applicable.
ResourceType (string) --
The type of resource associated with the event. Valid values are "Cluster", "InstanceGroup", or "Instance".
EventTime (datetime) --
The timestamp when the event occurred.
Description (string) --
A brief, human-readable description of the event.
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.
See also: AWS API Documentation
Request Syntax
client.batch_add_cluster_nodes(
ClusterName='string',
ClientToken='string',
NodesToAdd=[
{
'InstanceGroupName': 'string',
'IncrementTargetCountBy': 123
},
]
)
string
[REQUIRED]
The name of the HyperPod cluster to which you want to add nodes.
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.
This field is autopopulated if not provided.
list
[REQUIRED]
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.
(dict) --
Specifies an instance group and the number of nodes to add to it.
InstanceGroupName (string) -- [REQUIRED]
The name of the instance group to which you want to add nodes.
IncrementTargetCountBy (integer) -- [REQUIRED]
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.
dict
Response Syntax
{
'Successful': [
{
'NodeLogicalId': 'string',
'InstanceGroupName': 'string',
'Status': 'Running'|'Failure'|'Pending'|'ShuttingDown'|'SystemUpdating'|'DeepHealthCheckInProgress'|'NotFound'
},
],
'Failed': [
{
'InstanceGroupName': 'string',
'ErrorCode': 'InstanceGroupNotFound'|'InvalidInstanceGroupStatus',
'FailedCount': 123,
'Message': 'string'
},
]
}
Response Structure
(dict) --
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.
(dict) --
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.
(dict) --
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.
Retrieves detailed information about a specific event for a given HyperPod cluster. This functionality is only supported when the NodeProvisioningMode is set to Continuous.
See also: AWS API Documentation
Request Syntax
client.describe_cluster_event(
EventId='string',
ClusterName='string'
)
string
[REQUIRED]
The unique identifier (UUID) of the event to describe. This ID can be obtained from the ListClusterEvents operation.
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.
dict
Response Syntax
{
'EventDetails': {
'EventId': 'string',
'ClusterArn': 'string',
'ClusterName': 'string',
'InstanceGroupName': 'string',
'InstanceId': 'string',
'ResourceType': 'Cluster'|'InstanceGroup'|'Instance',
'EventTime': datetime(2015, 1, 1),
'EventDetails': {
'EventMetadata': {
'Cluster': {
'FailureMessage': 'string',
'EksRoleAccessEntries': [
'string',
],
'SlrAccessEntry': 'string'
},
'InstanceGroup': {
'FailureMessage': 'string',
'AvailabilityZoneId': 'string',
'CapacityReservation': {
'Arn': 'string',
'Type': 'ODCR'|'CRG'
},
'SubnetId': 'string',
'SecurityGroupIds': [
'string',
],
'AmiOverride': 'string'
},
'InstanceGroupScaling': {
'InstanceCount': 123,
'TargetCount': 123,
'FailureMessage': 'string'
},
'Instance': {
'CustomerEni': 'string',
'AdditionalEnis': {
'EfaEnis': [
'string',
]
},
'CapacityReservation': {
'Arn': 'string',
'Type': 'ODCR'|'CRG'
},
'FailureMessage': 'string',
'LcsExecutionState': 'string',
'NodeLogicalId': 'string'
}
}
},
'Description': 'string'
}
}
Response Structure
(dict) --
EventDetails (dict) --
Detailed information about the requested cluster event, including event metadata for various resource types such as Cluster, InstanceGroup, Instance, and their associated attributes.
EventId (string) --
The unique identifier (UUID) of the event.
ClusterArn (string) --
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster associated with the event.
ClusterName (string) --
The name of the SageMaker HyperPod cluster associated with the event.
InstanceGroupName (string) --
The name of the instance group associated with the event, if applicable.
InstanceId (string) --
The EC2 instance ID associated with the event, if applicable.
ResourceType (string) --
The type of resource associated with the event. Valid values are "Cluster", "InstanceGroup", or "Instance".
EventTime (datetime) --
The timestamp when the event occurred.
EventDetails (dict) --
Additional details about the event, including event-specific metadata.
EventMetadata (dict) --
Metadata specific to the event, which may include information about the cluster, instance group, or instance involved.
Cluster (dict) --
Metadata specific to cluster-level events.
FailureMessage (string) --
An error message describing why the cluster level operation (such as creating, updating, or deleting) failed.
EksRoleAccessEntries (list) --
A list of Amazon EKS IAM role ARNs associated with the cluster. This is created by SageMaker HyperPod on your behalf and only applies for EKS-orchestrated clusters.
(string) --
SlrAccessEntry (string) --
The Service-Linked Role (SLR) associated with the cluster. This is created by SageMaker HyperPod on your behalf and only applies for EKS-orchestrated clusters.
InstanceGroup (dict) --
Metadata specific to instance group-level events.
FailureMessage (string) --
An error message describing why the instance group level operation (such as creating, scaling, or deleting) failed.
AvailabilityZoneId (string) --
The ID of the Availability Zone where the instance group is located.
CapacityReservation (dict) --
Information about the Capacity Reservation used by the instance group.
Arn (string) --
The Amazon Resource Name (ARN) of the Capacity Reservation.
Type (string) --
The type of Capacity Reservation. Valid values are ODCR (On-Demand Capacity Reservation) or CRG (Capacity Reservation Group).
SubnetId (string) --
The ID of the subnet where the instance group is located.
SecurityGroupIds (list) --
A list of security group IDs associated with the instance group.
(string) --
AmiOverride (string) --
If you use a custom Amazon Machine Image (AMI) for the instance group, this field shows the ID of the custom AMI.
InstanceGroupScaling (dict) --
Metadata related to instance group scaling events.
InstanceCount (integer) --
The current number of instances in the group.
TargetCount (integer) --
The desired number of instances for the group after scaling.
FailureMessage (string) --
An error message describing why the scaling operation failed, if applicable.
Instance (dict) --
Metadata specific to instance-level events.
CustomerEni (string) --
The ID of the customer-managed Elastic Network Interface (ENI) associated with the instance.
AdditionalEnis (dict) --
Information about additional Elastic Network Interfaces (ENIs) associated with the instance.
EfaEnis (list) --
A list of Elastic Fabric Adapter (EFA) ENIs associated with the instance.
(string) --
CapacityReservation (dict) --
Information about the Capacity Reservation used by the instance.
Arn (string) --
The Amazon Resource Name (ARN) of the Capacity Reservation.
Type (string) --
The type of Capacity Reservation. Valid values are ODCR (On-Demand Capacity Reservation) or CRG (Capacity Reservation Group).
FailureMessage (string) --
An error message describing why the instance creation or update failed, if applicable.
LcsExecutionState (string) --
The execution state of the Lifecycle Script (LCS) for the instance.
NodeLogicalId (string) --
The unique logical identifier of the node within the cluster. The ID used here is the same object as in the BatchAddClusterNodes API.
Description (string) --
A human-readable description of the event.
{'NodeLogicalIds': ['string']}
Response {'FailedNodeLogicalIds': [{'Code': 'NodeIdNotFound | InvalidNodeStatus | '
'NodeIdInUse',
'Message': 'string',
'NodeLogicalId': 'string'}],
'SuccessfulNodeLogicalIds': ['string']}
Deletes specific nodes within a SageMaker HyperPod cluster. BatchDeleteClusterNodes accepts a cluster name and a list of node IDs.
See also: AWS API Documentation
Request Syntax
client.batch_delete_cluster_nodes(
ClusterName='string',
NodeIds=[
'string',
],
NodeLogicalIds=[
'string',
]
)
string
[REQUIRED]
The name of the SageMaker HyperPod cluster from which to delete the specified nodes.
list
A list of node IDs to be deleted from the specified cluster.
(string) --
list
A list of NodeLogicalIds identifying the nodes to be deleted. You can specify up to 50 NodeLogicalIds. You must specify either NodeLogicalIds, InstanceIds, or both, with a combined maximum of 50 identifiers.
(string) --
dict
Response Syntax
{
'Failed': [
{
'Code': 'NodeIdNotFound'|'InvalidNodeStatus'|'NodeIdInUse',
'Message': 'string',
'NodeId': 'string'
},
],
'Successful': [
'string',
],
'FailedNodeLogicalIds': [
{
'Code': 'NodeIdNotFound'|'InvalidNodeStatus'|'NodeIdInUse',
'Message': 'string',
'NodeLogicalId': 'string'
},
],
'SuccessfulNodeLogicalIds': [
'string',
]
}
Response Structure
(dict) --
Failed (list) --
A list of errors encountered when deleting the specified nodes.
(dict) --
Represents an error encountered when deleting a node from a SageMaker HyperPod cluster.
Code (string) --
The error code associated with the error encountered when deleting a node.
The code provides information about the specific issue encountered, such as the node not being found, the node's status being invalid for deletion, or the node ID being in use by another process.
Message (string) --
A message describing the error encountered when deleting a node.
NodeId (string) --
The ID of the node that encountered an error during the deletion process.
Successful (list) --
A list of node IDs that were successfully deleted from the specified cluster.
(string) --
FailedNodeLogicalIds (list) --
A list of NodeLogicalIds that could not be deleted, along with error information explaining why the deletion failed.
(dict) --
Information about an error that occurred when attempting to delete a node identified by its NodeLogicalId.
Code (string) --
The error code associated with the failure. Possible values include NodeLogicalIdNotFound, InvalidNodeStatus, and InternalError.
Message (string) --
A descriptive message providing additional details about the error.
NodeLogicalId (string) --
The NodeLogicalId of the node that could not be deleted.
SuccessfulNodeLogicalIds (list) --
A list of NodeLogicalIds that were successfully deleted from the cluster.
(string) --
{'InstanceGroups': {'ImageId': 'string'}, 'NodeProvisioningMode': 'Continuous'}
Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.
See also: AWS API Documentation
Request Syntax
client.create_cluster(
ClusterName='string',
InstanceGroups=[
{
'InstanceCount': 123,
'InstanceGroupName': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge',
'LifeCycleConfig': {
'SourceS3Uri': 'string',
'OnCreate': 'string'
},
'ExecutionRole': 'string',
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123
}
},
],
'OnStartDeepHealthChecks': [
'InstanceStress'|'InstanceConnectivity',
],
'TrainingPlanArn': 'string',
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ScheduledUpdateConfig': {
'ScheduleExpression': 'string',
'DeploymentConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
}
},
'ImageId': 'string'
},
],
RestrictedInstanceGroups=[
{
'InstanceCount': 123,
'InstanceGroupName': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge',
'ExecutionRole': 'string',
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123
}
},
],
'OnStartDeepHealthChecks': [
'InstanceStress'|'InstanceConnectivity',
],
'TrainingPlanArn': 'string',
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ScheduledUpdateConfig': {
'ScheduleExpression': 'string',
'DeploymentConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
}
},
'EnvironmentConfig': {
'FSxLustreConfig': {
'SizeInGiB': 123,
'PerUnitStorageThroughput': 123
}
}
},
],
VpcConfig={
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Orchestrator={
'Eks': {
'ClusterArn': 'string'
}
},
NodeRecovery='Automatic'|'None',
NodeProvisioningMode='Continuous'
)
string
[REQUIRED]
The name for the new SageMaker HyperPod cluster.
list
The instance groups to be created in the SageMaker HyperPod cluster.
(dict) --
The specifications of an instance group that you need to define.
InstanceCount (integer) -- [REQUIRED]
Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
InstanceGroupName (string) -- [REQUIRED]
Specifies the name of the instance group.
InstanceType (string) -- [REQUIRED]
Specifies the instance type of the instance group.
LifeCycleConfig (dict) -- [REQUIRED]
Specifies the LifeCycle configuration for the instance group.
SourceS3Uri (string) -- [REQUIRED]
An Amazon S3 bucket path where your lifecycle scripts are stored.
OnCreate (string) -- [REQUIRED]
The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
ExecutionRole (string) -- [REQUIRED]
Specifies an IAM execution role to be assumed by the instance group.
ThreadsPerCore (integer) --
Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
InstanceStorageConfigs (list) --
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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.
VolumeSizeInGB (integer) --
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.
OnStartDeepHealthChecks (list) --
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
(string) --
TrainingPlanArn (string) --
The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
OverrideVpcConfig (dict) --
To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.
SecurityGroupIds (list) -- [REQUIRED]
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) -- [REQUIRED]
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ScheduledUpdateConfig (dict) --
The configuration object of the schedule that SageMaker uses to update the AMI.
ScheduleExpression (string) -- [REQUIRED]
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
DeploymentConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) -- [REQUIRED]
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) -- [REQUIRED]
The name of the alarm.
ImageId (string) --
When configuring your HyperPod cluster, you can specify an image ID using one of the following options:
HyperPodPublicAmiId: Use a HyperPod public AMI
CustomAmiId: Use your custom AMI
default: Use the default latest system image
f you choose to use a custom AMI ( CustomAmiId), ensure it meets the following requirements:
Encryption: The custom AMI must be unencrypted.
Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.
Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.
When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input.
list
The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
(dict) --
The specifications of a restricted instance group that you need to define.
InstanceCount (integer) -- [REQUIRED]
Specifies the number of instances to add to the restricted instance group of a SageMaker HyperPod cluster.
InstanceGroupName (string) -- [REQUIRED]
Specifies the name of the restricted instance group.
InstanceType (string) -- [REQUIRED]
Specifies the instance type of the restricted instance group.
ExecutionRole (string) -- [REQUIRED]
Specifies an IAM execution role to be assumed by the restricted instance group.
ThreadsPerCore (integer) --
The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
InstanceStorageConfigs (list) --
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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.
VolumeSizeInGB (integer) --
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.
OnStartDeepHealthChecks (list) --
A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.
(string) --
TrainingPlanArn (string) --
The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
OverrideVpcConfig (dict) --
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
SecurityGroupIds (list) -- [REQUIRED]
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) -- [REQUIRED]
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ScheduledUpdateConfig (dict) --
The configuration object of the schedule that SageMaker follows when updating the AMI.
ScheduleExpression (string) -- [REQUIRED]
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
DeploymentConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) -- [REQUIRED]
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) -- [REQUIRED]
The name of the alarm.
EnvironmentConfig (dict) -- [REQUIRED]
The configuration for the restricted instance groups (RIG) environment.
FSxLustreConfig (dict) --
Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.
SizeInGiB (integer) -- [REQUIRED]
The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).
PerUnitStorageThroughput (integer) -- [REQUIRED]
The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.
dict
Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.
SecurityGroupIds (list) -- [REQUIRED]
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) -- [REQUIRED]
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
list
Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.
(dict) --
A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.
For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
Key (string) -- [REQUIRED]
The tag key. Tag keys must be unique per resource.
Value (string) -- [REQUIRED]
The tag value.
dict
The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is "eks", which is to use an Amazon Elastic Kubernetes Service (EKS) cluster as the orchestrator.
Eks (dict) -- [REQUIRED]
The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
ClusterArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod cluster.
string
The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.
string
The mode for provisioning nodes in the cluster. You can specify the following modes:
Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.
dict
Response Syntax
{
'ClusterArn': 'string'
}
Response Structure
(dict) --
ClusterArn (string) --
The Amazon Resource Name (ARN) of the cluster.
{'InstanceGroups': {'CurrentImageId': 'string', 'DesiredImageId': 'string'},
'NodeProvisioningMode': 'Continuous'}
Retrieves information of a SageMaker HyperPod cluster.
See also: AWS API Documentation
Request Syntax
client.describe_cluster(
ClusterName='string'
)
string
[REQUIRED]
The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
dict
Response Syntax
{
'ClusterArn': 'string',
'ClusterName': 'string',
'ClusterStatus': 'Creating'|'Deleting'|'Failed'|'InService'|'RollingBack'|'SystemUpdating'|'Updating',
'CreationTime': datetime(2015, 1, 1),
'FailureMessage': 'string',
'InstanceGroups': [
{
'CurrentCount': 123,
'TargetCount': 123,
'InstanceGroupName': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge',
'LifeCycleConfig': {
'SourceS3Uri': 'string',
'OnCreate': 'string'
},
'ExecutionRole': 'string',
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123
}
},
],
'OnStartDeepHealthChecks': [
'InstanceStress'|'InstanceConnectivity',
],
'Status': 'InService'|'Creating'|'Updating'|'Failed'|'Degraded'|'SystemUpdating'|'Deleting',
'TrainingPlanArn': 'string',
'TrainingPlanStatus': 'string',
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ScheduledUpdateConfig': {
'ScheduleExpression': 'string',
'DeploymentConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
}
},
'CurrentImageId': 'string',
'DesiredImageId': 'string'
},
],
'RestrictedInstanceGroups': [
{
'CurrentCount': 123,
'TargetCount': 123,
'InstanceGroupName': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge',
'ExecutionRole': 'string',
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123
}
},
],
'OnStartDeepHealthChecks': [
'InstanceStress'|'InstanceConnectivity',
],
'Status': 'InService'|'Creating'|'Updating'|'Failed'|'Degraded'|'SystemUpdating'|'Deleting',
'TrainingPlanArn': 'string',
'TrainingPlanStatus': 'string',
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ScheduledUpdateConfig': {
'ScheduleExpression': 'string',
'DeploymentConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
}
},
'EnvironmentConfig': {
'FSxLustreConfig': {
'SizeInGiB': 123,
'PerUnitStorageThroughput': 123
},
'S3OutputPath': 'string'
}
},
],
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'Orchestrator': {
'Eks': {
'ClusterArn': 'string'
}
},
'NodeRecovery': 'Automatic'|'None',
'NodeProvisioningMode': 'Continuous'
}
Response Structure
(dict) --
ClusterArn (string) --
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
ClusterName (string) --
The name of the SageMaker HyperPod cluster.
ClusterStatus (string) --
The status of the SageMaker HyperPod cluster.
CreationTime (datetime) --
The time when the SageMaker Cluster is created.
FailureMessage (string) --
The failure message of the SageMaker HyperPod cluster.
InstanceGroups (list) --
The instance groups of the SageMaker HyperPod cluster.
(dict) --
Details of an instance group in a SageMaker HyperPod cluster.
CurrentCount (integer) --
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
TargetCount (integer) --
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
InstanceGroupName (string) --
The name of the instance group of a SageMaker HyperPod cluster.
InstanceType (string) --
The instance type of the instance group of a SageMaker HyperPod cluster.
LifeCycleConfig (dict) --
Details of LifeCycle configuration for the instance group.
SourceS3Uri (string) --
An Amazon S3 bucket path where your lifecycle scripts are stored.
OnCreate (string) --
The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
ExecutionRole (string) --
The execution role for the instance group to assume.
ThreadsPerCore (integer) --
The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
InstanceStorageConfigs (list) --
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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.
VolumeSizeInGB (integer) --
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.
OnStartDeepHealthChecks (list) --
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
(string) --
Status (string) --
The current status of the cluster instance group.
InService: The instance group is active and healthy.
Creating: The instance group is being provisioned.
Updating: The instance group is being updated.
Failed: The instance group has failed to provision or is no longer healthy.
Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.
Deleting: The instance group is being deleted.
TrainingPlanArn (string) --
The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
TrainingPlanStatus (string) --
The current status of the training plan associated with this cluster instance group.
OverrideVpcConfig (dict) --
The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ScheduledUpdateConfig (dict) --
The configuration object of the schedule that SageMaker follows when updating the AMI.
ScheduleExpression (string) --
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
DeploymentConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) --
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) --
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) --
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) --
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) --
The name of the alarm.
CurrentImageId (string) --
The ID of the Amazon Machine Image (AMI) currently in use by the instance group.
DesiredImageId (string) --
The ID of the Amazon Machine Image (AMI) desired for the instance group.
RestrictedInstanceGroups (list) --
The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
(dict) --
The instance group details of the restricted instance group (RIG).
CurrentCount (integer) --
The number of instances that are currently in the restricted instance group of a SageMaker HyperPod cluster.
TargetCount (integer) --
The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster.
InstanceGroupName (string) --
The name of the restricted instance group of a SageMaker HyperPod cluster.
InstanceType (string) --
The instance type of the restricted instance group of a SageMaker HyperPod cluster.
ExecutionRole (string) --
The execution role for the restricted instance group to assume.
ThreadsPerCore (integer) --
The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
InstanceStorageConfigs (list) --
The additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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.
VolumeSizeInGB (integer) --
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.
OnStartDeepHealthChecks (list) --
A flag indicating whether deep health checks should be performed when the cluster's restricted instance group is created or updated.
(string) --
Status (string) --
The current status of the cluster's restricted instance group.
InService: The restricted instance group is active and healthy.
Creating: The restricted instance group is being provisioned.
Updating: The restricted instance group is being updated.
Failed: The restricted instance group has failed to provision or is no longer healthy.
Degraded: The restricted instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.
Deleting: The restricted instance group is being deleted.
TrainingPlanArn (string) --
The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
TrainingPlanStatus (string) --
The current status of the training plan associated with this cluster restricted instance group.
OverrideVpcConfig (dict) --
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ScheduledUpdateConfig (dict) --
The configuration object of the schedule that SageMaker follows when updating the AMI.
ScheduleExpression (string) --
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
DeploymentConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) --
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) --
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) --
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) --
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) --
The name of the alarm.
EnvironmentConfig (dict) --
The configuration for the restricted instance groups (RIG) environment.
FSxLustreConfig (dict) --
Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.
SizeInGiB (integer) --
The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).
PerUnitStorageThroughput (integer) --
The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.
S3OutputPath (string) --
The Amazon S3 path where output data from the restricted instance group (RIG) environment will be stored.
VpcConfig (dict) --
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
Orchestrator (dict) --
The type of orchestrator used for the SageMaker HyperPod cluster.
Eks (dict) --
The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
ClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod cluster.
NodeRecovery (string) --
The node recovery mode configured for the SageMaker HyperPod cluster.
NodeProvisioningMode (string) --
The mode used for provisioning nodes in the cluster.
{'NodeLogicalId': 'string'}
Response {'NodeDetails': {'CurrentImageId': 'string',
'DesiredImageId': 'string',
'InstanceStatus': {'Status': {'NotFound'}},
'NodeLogicalId': 'string'}}
Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster.
See also: AWS API Documentation
Request Syntax
client.describe_cluster_node(
ClusterName='string',
NodeId='string',
NodeLogicalId='string'
)
string
[REQUIRED]
The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.
string
The ID of the SageMaker HyperPod cluster node.
string
The logical identifier of the node to describe. You can specify either NodeLogicalId or InstanceId, but not both. NodeLogicalId can be used to describe nodes that are still being provisioned and don't yet have an InstanceId assigned.
dict
Response Syntax
{
'NodeDetails': {
'InstanceGroupName': 'string',
'InstanceId': 'string',
'NodeLogicalId': 'string',
'InstanceStatus': {
'Status': 'Running'|'Failure'|'Pending'|'ShuttingDown'|'SystemUpdating'|'DeepHealthCheckInProgress'|'NotFound',
'Message': 'string'
},
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge',
'LaunchTime': datetime(2015, 1, 1),
'LastSoftwareUpdateTime': datetime(2015, 1, 1),
'LifeCycleConfig': {
'SourceS3Uri': 'string',
'OnCreate': 'string'
},
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123
}
},
],
'PrivatePrimaryIp': 'string',
'PrivatePrimaryIpv6': 'string',
'PrivateDnsHostname': 'string',
'Placement': {
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string'
},
'CurrentImageId': 'string',
'DesiredImageId': 'string'
}
}
Response Structure
(dict) --
NodeDetails (dict) --
The details of the SageMaker HyperPod cluster node.
InstanceGroupName (string) --
The instance group name in which the instance is.
InstanceId (string) --
The ID of the instance.
NodeLogicalId (string) --
A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId.
InstanceStatus (dict) --
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 (datetime) --
The time when the instance is launched.
LastSoftwareUpdateTime (datetime) --
The time when the cluster was last updated.
LifeCycleConfig (dict) --
The LifeCycle configuration applied to the instance.
SourceS3Uri (string) --
An Amazon S3 bucket path where your lifecycle scripts are stored.
OnCreate (string) --
The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
OverrideVpcConfig (dict) --
The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ThreadsPerCore (integer) --
The number of threads per CPU core you specified under CreateCluster.
InstanceStorageConfigs (list) --
The configurations of additional storage specified to the instance group where the instance (node) is launched.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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.
VolumeSizeInGB (integer) --
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.
PrivatePrimaryIp (string) --
The private primary IP address of the SageMaker HyperPod cluster node.
PrivatePrimaryIpv6 (string) --
The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.
PrivateDnsHostname (string) --
The private DNS hostname of the SageMaker HyperPod cluster node.
Placement (dict) --
The placement details of the SageMaker HyperPod cluster node.
AvailabilityZone (string) --
The Availability Zone where the node in the SageMaker HyperPod cluster is launched.
AvailabilityZoneId (string) --
The unique identifier (ID) of the Availability Zone where the node in the SageMaker HyperPod cluster is launched.
CurrentImageId (string) --
The ID of the Amazon Machine Image (AMI) currently in use by the node.
DesiredImageId (string) --
The ID of the Amazon Machine Image (AMI) desired for the node.
{'IncludeNodeLogicalIds': 'boolean'}
Response {'ClusterNodeSummaries': {'InstanceStatus': {'Status': {'NotFound'}},
'NodeLogicalId': 'string'}}
Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.
See also: AWS API Documentation
Request Syntax
client.list_cluster_nodes(
ClusterName='string',
CreationTimeAfter=datetime(2015, 1, 1),
CreationTimeBefore=datetime(2015, 1, 1),
InstanceGroupNameContains='string',
MaxResults=123,
NextToken='string',
SortBy='CREATION_TIME'|'NAME',
SortOrder='Ascending'|'Descending',
IncludeNodeLogicalIds=True|False
)
string
[REQUIRED]
The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.
datetime
A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.
Acceptable formats include:
YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z
YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00
YYYY-MM-DD, for example, 2014-10-01
Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
datetime
A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
string
A filter that returns the instance groups whose name contain a specified string.
integer
The maximum number of nodes to return in the response.
string
If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.
string
The field by which to sort results. The default value is CREATION_TIME.
string
The sort order for results. The default value is Ascending.
boolean
Specifies whether to include nodes that are still being provisioned in the response. When set to true, the response includes all nodes regardless of their provisioning status. When set to False (default), only nodes with assigned InstanceIds are returned.
dict
Response Syntax
{
'NextToken': 'string',
'ClusterNodeSummaries': [
{
'InstanceGroupName': 'string',
'InstanceId': 'string',
'NodeLogicalId': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge',
'LaunchTime': datetime(2015, 1, 1),
'LastSoftwareUpdateTime': datetime(2015, 1, 1),
'InstanceStatus': {
'Status': 'Running'|'Failure'|'Pending'|'ShuttingDown'|'SystemUpdating'|'DeepHealthCheckInProgress'|'NotFound',
'Message': 'string'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
The next token specified for listing instances in a SageMaker HyperPod cluster.
ClusterNodeSummaries (list) --
The summaries of listed instances in a SageMaker HyperPod cluster
(dict) --
Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.
InstanceGroupName (string) --
The name of the instance group in which the instance is.
InstanceId (string) --
The ID of the instance.
NodeLogicalId (string) --
A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId. This field is only included when IncludeNodeLogicalIds is set to True in the ListClusterNodes request.
InstanceType (string) --
The type of the instance.
LaunchTime (datetime) --
The time when the instance is launched.
LastSoftwareUpdateTime (datetime) --
The time when SageMaker last updated the software of the instances in the cluster.
InstanceStatus (dict) --
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.
{'InstanceGroups': {'ImageId': 'string'}}
Updates a SageMaker HyperPod cluster.
See also: AWS API Documentation
Request Syntax
client.update_cluster(
ClusterName='string',
InstanceGroups=[
{
'InstanceCount': 123,
'InstanceGroupName': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge',
'LifeCycleConfig': {
'SourceS3Uri': 'string',
'OnCreate': 'string'
},
'ExecutionRole': 'string',
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123
}
},
],
'OnStartDeepHealthChecks': [
'InstanceStress'|'InstanceConnectivity',
],
'TrainingPlanArn': 'string',
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ScheduledUpdateConfig': {
'ScheduleExpression': 'string',
'DeploymentConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
}
},
'ImageId': 'string'
},
],
RestrictedInstanceGroups=[
{
'InstanceCount': 123,
'InstanceGroupName': 'string',
'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.p6-b200.48xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge',
'ExecutionRole': 'string',
'ThreadsPerCore': 123,
'InstanceStorageConfigs': [
{
'EbsVolumeConfig': {
'VolumeSizeInGB': 123
}
},
],
'OnStartDeepHealthChecks': [
'InstanceStress'|'InstanceConnectivity',
],
'TrainingPlanArn': 'string',
'OverrideVpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ScheduledUpdateConfig': {
'ScheduleExpression': 'string',
'DeploymentConfig': {
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
}
},
'EnvironmentConfig': {
'FSxLustreConfig': {
'SizeInGiB': 123,
'PerUnitStorageThroughput': 123
}
}
},
],
NodeRecovery='Automatic'|'None',
InstanceGroupsToDelete=[
'string',
]
)
string
[REQUIRED]
Specify the name of the SageMaker HyperPod cluster you want to update.
list
Specify the instance groups to update.
(dict) --
The specifications of an instance group that you need to define.
InstanceCount (integer) -- [REQUIRED]
Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
InstanceGroupName (string) -- [REQUIRED]
Specifies the name of the instance group.
InstanceType (string) -- [REQUIRED]
Specifies the instance type of the instance group.
LifeCycleConfig (dict) -- [REQUIRED]
Specifies the LifeCycle configuration for the instance group.
SourceS3Uri (string) -- [REQUIRED]
An Amazon S3 bucket path where your lifecycle scripts are stored.
OnCreate (string) -- [REQUIRED]
The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
ExecutionRole (string) -- [REQUIRED]
Specifies an IAM execution role to be assumed by the instance group.
ThreadsPerCore (integer) --
Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
InstanceStorageConfigs (list) --
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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.
VolumeSizeInGB (integer) --
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.
OnStartDeepHealthChecks (list) --
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
(string) --
TrainingPlanArn (string) --
The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
OverrideVpcConfig (dict) --
To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.
SecurityGroupIds (list) -- [REQUIRED]
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) -- [REQUIRED]
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ScheduledUpdateConfig (dict) --
The configuration object of the schedule that SageMaker uses to update the AMI.
ScheduleExpression (string) -- [REQUIRED]
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
DeploymentConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) -- [REQUIRED]
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) -- [REQUIRED]
The name of the alarm.
ImageId (string) --
When configuring your HyperPod cluster, you can specify an image ID using one of the following options:
HyperPodPublicAmiId: Use a HyperPod public AMI
CustomAmiId: Use your custom AMI
default: Use the default latest system image
f you choose to use a custom AMI ( CustomAmiId), ensure it meets the following requirements:
Encryption: The custom AMI must be unencrypted.
Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.
Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.
When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input.
list
The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
(dict) --
The specifications of a restricted instance group that you need to define.
InstanceCount (integer) -- [REQUIRED]
Specifies the number of instances to add to the restricted instance group of a SageMaker HyperPod cluster.
InstanceGroupName (string) -- [REQUIRED]
Specifies the name of the restricted instance group.
InstanceType (string) -- [REQUIRED]
Specifies the instance type of the restricted instance group.
ExecutionRole (string) -- [REQUIRED]
Specifies an IAM execution role to be assumed by the restricted instance group.
ThreadsPerCore (integer) --
The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
InstanceStorageConfigs (list) --
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.
(dict) --
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
EbsVolumeConfig (dict) --
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.
VolumeSizeInGB (integer) --
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.
OnStartDeepHealthChecks (list) --
A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.
(string) --
TrainingPlanArn (string) --
The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
OverrideVpcConfig (dict) --
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
SecurityGroupIds (list) -- [REQUIRED]
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) -- [REQUIRED]
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
(string) --
ScheduledUpdateConfig (dict) --
The configuration object of the schedule that SageMaker follows when updating the AMI.
ScheduleExpression (string) -- [REQUIRED]
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
DeploymentConfig (dict) --
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) -- [REQUIRED]
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) -- [REQUIRED]
The name of the alarm.
EnvironmentConfig (dict) -- [REQUIRED]
The configuration for the restricted instance groups (RIG) environment.
FSxLustreConfig (dict) --
Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.
SizeInGiB (integer) -- [REQUIRED]
The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).
PerUnitStorageThroughput (integer) -- [REQUIRED]
The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.
string
The node recovery mode to be applied to the SageMaker HyperPod cluster.
list
Specify the names of the instance groups to delete. Use a single , as the separator between multiple names.
(string) --
dict
Response Syntax
{
'ClusterArn': 'string'
}
Response Structure
(dict) --
ClusterArn (string) --
The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.
{'ImageId': 'string'}
Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.
See also: AWS API Documentation
Request Syntax
client.update_cluster_software(
ClusterName='string',
InstanceGroups=[
{
'InstanceGroupName': 'string'
},
],
DeploymentConfig={
'RollingUpdatePolicy': {
'MaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
},
'RollbackMaximumBatchSize': {
'Type': 'INSTANCE_COUNT'|'CAPACITY_PERCENTAGE',
'Value': 123
}
},
'WaitIntervalInSeconds': 123,
'AutoRollbackConfiguration': [
{
'AlarmName': 'string'
},
]
},
ImageId='string'
)
string
[REQUIRED]
Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.
list
The array of instance groups for which to update AMI versions.
(dict) --
The configuration that describes specifications of the instance groups to update.
InstanceGroupName (string) -- [REQUIRED]
The name of the instance group to update.
dict
The configuration to use when updating the AMI versions.
RollingUpdatePolicy (dict) --
The policy that SageMaker uses when updating the AMI versions of the cluster.
MaximumBatchSize (dict) -- [REQUIRED]
The maximum amount of instances in the cluster that SageMaker can update at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
RollbackMaximumBatchSize (dict) --
The maximum amount of instances in the cluster that SageMaker can roll back at a time.
Type (string) -- [REQUIRED]
Specifies whether SageMaker should process the update by amount or percentage of instances.
Value (integer) -- [REQUIRED]
Specifies the amount or percentage of instances SageMaker updates at a time.
WaitIntervalInSeconds (integer) --
The duration in seconds that SageMaker waits before updating more instances in the cluster.
AutoRollbackConfiguration (list) --
An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
(dict) --
The details of the alarm to monitor during the AMI update.
AlarmName (string) -- [REQUIRED]
The name of the alarm.
string
When configuring your HyperPod cluster, you can specify an image ID using one of the following options:
HyperPodPublicAmiId: Use a HyperPod public AMI
CustomAmiId: Use your custom AMI
default: Use the default latest system image
f you choose to use a custom AMI ( CustomAmiId), ensure it meets the following requirements:
Encryption: The custom AMI must be unencrypted.
Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.
Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.
When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input.
dict
Response Syntax
{
'ClusterArn': 'string'
}
Response Structure
(dict) --
ClusterArn (string) --
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.