InstanceMetadata - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

InstanceMetadata

Metadata information about an instance in a HyperPod cluster.

Contents

AdditionalEnis

Information about additional Elastic Network Interfaces (ENIs) associated with the instance.

Type: AdditionalEnis object

Required: No

CapacityReservation

Information about the Capacity Reservation used by the instance.

Type: CapacityReservation object

Required: No

CustomerEni

The ID of the customer-managed Elastic Network Interface (ENI) associated with the instance.

Type: String

Required: No

FailureMessage

An error message describing why the instance creation or update failed, if applicable.

Type: String

Required: No

LcsExecutionState

The execution state of the Lifecycle Script (LCS) for the instance.

Type: String

Required: No

NodeLogicalId

The unique logical identifier of the node within the cluster. The ID used here is the same object as in the BatchAddClusterNodes API.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]

Required: No

See Also

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