Skip to content

InstanceMetadata

Source code in docs_src/capo_sagemaker/types/instance_metadata.py
class InstanceMetadata(TypedDict, closed=True):
    customer_eni: NotRequired["str"]
    """<p>The ID of the customer-managed Elastic Network Interface (ENI) associated with the instance.</p>"""
    additional_enis: NotRequired["capo_sagemaker.types.additional_enis.AdditionalEnis"]
    """<p>Information about additional Elastic Network Interfaces (ENIs) associated with the instance.</p>"""
    instance_requirements_eni_configurations: NotRequired[
        "capo_sagemaker.types.instance_requirements_eni_configurations.InstanceRequirementsEniConfigurations"
    ]
    """<p>The ENI configurations for the instance types in the instance requirements, grouped by network interface category (for example, ENI-only or EFA with ENIs). At most one configuration per category.</p>"""
    capacity_reservation: NotRequired[
        "capo_sagemaker.types.capacity_reservation.CapacityReservation"
    ]
    """<p>Information about the Capacity Reservation used by the instance.</p>"""
    failure_message: NotRequired["str"]
    """<p>An error message describing why the instance creation or update failed, if applicable.</p>"""
    lcs_execution_state: NotRequired["str"]
    """<p>The execution state of the Lifecycle Script (LCS) for the instance.</p>"""
    node_logical_id: NotRequired[
        "capo_sagemaker.types.cluster_node_logical_id.ClusterNodeLogicalId"
    ]
    """<p>The unique logical identifier of the node within the cluster. The ID used here is the same object as in the <code>BatchAddClusterNodes</code> API.</p>"""

additional_enis instance-attribute

additional_enis: NotRequired[AdditionalEnis]

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

capacity_reservation instance-attribute

capacity_reservation: NotRequired[CapacityReservation]

Information about the Capacity Reservation used by the instance.

customer_eni instance-attribute

customer_eni: NotRequired[str]

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

failure_message instance-attribute

failure_message: NotRequired[str]

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

instance_requirements_eni_configurations instance-attribute

instance_requirements_eni_configurations: NotRequired[
    InstanceRequirementsEniConfigurations
]

The ENI configurations for the instance types in the instance requirements, grouped by network interface category (for example, ENI-only or EFA with ENIs). At most one configuration per category.

lcs_execution_state instance-attribute

lcs_execution_state: NotRequired[str]

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

node_logical_id instance-attribute

node_logical_id: NotRequired[ClusterNodeLogicalId]

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