Skip to content

GetMicrovmResponse

Source code in docs_src/capo_lambda_microvms/types/get_microvm_response.py
class GetMicrovmResponse(TypedDict, closed=True):
    microvm_id: "capo_lambda_microvms.types.microvm_identifier.MicrovmIdentifier"
    """<p>The unique identifier of the MicroVM.</p>"""
    state: "capo_lambda_microvms.types.microvm_state.MicrovmState"
    """<p>The current lifecycle state of the MicroVM.</p>"""
    endpoint: "str"
    """<p>The HTTPS endpoint URL for communicating with the MicroVM. Include a valid authentication token in the X-aws-proxy-auth header when sending requests.</p>"""
    image_arn: "capo_lambda_microvms.types.microvm_image_arn.MicrovmImageArn"
    """<p>The ARN of the MicroVM image used to run this MicroVM.</p>"""
    image_version: "capo_lambda_microvms.types.version.Version"
    """<p>The version of the MicroVM image used to run this MicroVM.</p>"""
    execution_role_arn: NotRequired["capo_lambda_microvms.types.role_arn.RoleArn"]
    """<p>The ARN of the IAM execution role assumed by the MicroVM.</p>"""
    idle_policy: NotRequired["capo_lambda_microvms.types.idle_policy.IdlePolicy"]
    """<p>The idle policy configuration of the MicroVM, controlling auto-suspend and auto-resume behavior.</p>"""
    maximum_duration_in_seconds: "int"
    """<p>The maximum duration in seconds that the MicroVM can exist before being terminated by the platform.</p>"""
    started_at: "datetime.datetime"
    """<p>The timestamp when the MicroVM first started.</p>"""
    terminated_at: NotRequired["datetime.datetime"]
    """<p>The timestamp when the MicroVM terminated.</p>"""
    state_reason: NotRequired[
        "capo_lambda_microvms.types.non_blank_string.NonBlankString"
    ]
    """<p>The reason for why the MicroVM is in the current state.</p>"""
    ingress_network_connectors: NotRequired[
        "capo_lambda_microvms.types.network_connector_list.NetworkConnectorList"
    ]
    """<p>The list of ingress network connectors configured for the MicroVM.</p>"""
    egress_network_connectors: NotRequired[
        "capo_lambda_microvms.types.network_connector_list.NetworkConnectorList"
    ]
    """<p>The list of egress network connectors configured for the MicroVM.</p>"""

egress_network_connectors instance-attribute

egress_network_connectors: NotRequired[NetworkConnectorList]

The list of egress network connectors configured for the MicroVM.

endpoint instance-attribute

endpoint: str

The HTTPS endpoint URL for communicating with the MicroVM. Include a valid authentication token in the X-aws-proxy-auth header when sending requests.

execution_role_arn instance-attribute

execution_role_arn: NotRequired[RoleArn]

The ARN of the IAM execution role assumed by the MicroVM.

idle_policy instance-attribute

idle_policy: NotRequired[IdlePolicy]

The idle policy configuration of the MicroVM, controlling auto-suspend and auto-resume behavior.

image_arn instance-attribute

image_arn: MicrovmImageArn

The ARN of the MicroVM image used to run this MicroVM.

image_version instance-attribute

image_version: Version

The version of the MicroVM image used to run this MicroVM.

ingress_network_connectors instance-attribute

ingress_network_connectors: NotRequired[NetworkConnectorList]

The list of ingress network connectors configured for the MicroVM.

maximum_duration_in_seconds instance-attribute

maximum_duration_in_seconds: int

The maximum duration in seconds that the MicroVM can exist before being terminated by the platform.

microvm_id instance-attribute

microvm_id: MicrovmIdentifier

The unique identifier of the MicroVM.

started_at instance-attribute

started_at: datetime

The timestamp when the MicroVM first started.

state instance-attribute

state: MicrovmState

The current lifecycle state of the MicroVM.

state_reason instance-attribute

state_reason: NotRequired[NonBlankString]

The reason for why the MicroVM is in the current state.

terminated_at instance-attribute

terminated_at: NotRequired[datetime]

The timestamp when the MicroVM terminated.