Skip to content

InstanceGroupMetadata

Source code in docs_src/capo_sagemaker/types/instance_group_metadata.py
class InstanceGroupMetadata(TypedDict, closed=True):
    failure_message: NotRequired["str"]
    """<p>An error message describing why the instance group level operation (such as creating, scaling, or deleting) failed.</p>"""
    availability_zone_id: NotRequired["str"]
    """<p>The ID of the Availability Zone where the instance group is located.</p>"""
    capacity_reservation: NotRequired[
        "capo_sagemaker.types.capacity_reservation.CapacityReservation"
    ]
    """<p>Information about the Capacity Reservation used by the instance group.</p>"""
    subnet_id: NotRequired["str"]
    """<p>The ID of the subnet where the instance group is located.</p>"""
    security_group_ids: NotRequired[
        "capo_sagemaker.types.security_group_ids.SecurityGroupIds"
    ]
    """<p>A list of security group IDs associated with the instance group.</p>"""
    ami_override: NotRequired["str"]
    """<p>If you use a custom Amazon Machine Image (AMI) for the instance group, this field shows the ID of the custom AMI.</p>"""

ami_override instance-attribute

ami_override: NotRequired[str]

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

availability_zone_id instance-attribute

availability_zone_id: NotRequired[str]

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

capacity_reservation instance-attribute

capacity_reservation: NotRequired[CapacityReservation]

Information about the Capacity Reservation used by the instance group.

failure_message instance-attribute

failure_message: NotRequired[str]

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

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIds]

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

subnet_id instance-attribute

subnet_id: NotRequired[str]

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