InstanceGroupMetadata - Amazon SageMaker

InstanceGroupMetadata

Metadata information about an instance group in a HyperPod cluster.

Contents

AmiOverride

If you use a custom Amazon Machine Image (AMI) for the instance group, this field shows the ID of the custom AMI.

Type: String

Required: No

AvailabilityZoneId

The ID of the Availability Zone where the instance group is located.

Type: String

Required: No

CapacityReservation

Information about the Capacity Reservation used by the instance group.

Type: CapacityReservation object

Required: No

FailureMessage

An error message describing why the instance group level operation (such as creating, scaling, or deleting) failed.

Type: String

Required: No

SecurityGroupIds

A list of security group IDs associated with the instance group.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Length Constraints: Minimum length of 0. Maximum length of 32.

Pattern: [-0-9a-zA-Z]+

Required: No

SubnetId

The ID of the subnet where the instance group is located.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: