LambdaMicroVMs / Client / get_microvm

get_microvm

LambdaMicroVMs.Client.get_microvm(**kwargs)

Retrieves the details of a specific MicroVM, including its state, endpoint, image information, and configuration. The state field is eventually consistent — determine readiness by connecting to the endpoint.

See also: AWS API Documentation

Request Syntax

response = client.get_microvm(
    microvmIdentifier='string'
)

Parameters:

microvmIdentifier (string) –

[REQUIRED]

The ID of the MicroVM to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'microvmId': 'string',
    'state': 'PENDING'|'RUNNING'|'SUSPENDING'|'SUSPENDED'|'TERMINATING'|'TERMINATED',
    'endpoint': 'string',
    'imageArn': 'string',
    'imageVersion': 'string',
    'executionRoleArn': 'string',
    'idlePolicy': {
        'maxIdleDurationSeconds': 123,
        'suspendedDurationSeconds': 123,
        'autoResumeEnabled': True|False
    },
    'maximumDurationInSeconds': 123,
    'startedAt': datetime(2015, 1, 1),
    'terminatedAt': datetime(2015, 1, 1),
    'stateReason': 'string',
    'ingressNetworkConnectors': [
        'string',
    ],
    'egressNetworkConnectors': [
        'string',
    ]
}

Response Structure

• (dict) –

  • microvmId (string) –

    The unique identifier of the MicroVM.

  • state (string) –

    The current lifecycle state of the MicroVM.

  • endpoint (string) –

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

  • imageArn (string) –

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

  • imageVersion (string) –

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

  • executionRoleArn (string) –

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

  • idlePolicy (dict) –

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

    • maxIdleDurationSeconds (integer) –

      The maximum time in seconds that a MicroVM can remain idle before it is automatically suspended.

    • suspendedDurationSeconds (integer) –

      The maximum time in seconds that a MicroVM can remain suspended before it is automatically terminated.

    • autoResumeEnabled (boolean) –

      Indicates whether the MicroVM automatically resumes when it receives a request while suspended.

  • maximumDurationInSeconds (integer) –

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

  • startedAt (datetime) –

    The timestamp when the MicroVM first started.

  • terminatedAt (datetime) –

    The timestamp when the MicroVM terminated.

  • stateReason (string) –

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

  • ingressNetworkConnectors (list) –

    The list of ingress network connectors configured for the MicroVM.

    • (string) –

  • egressNetworkConnectors (list) –

    The list of egress network connectors configured for the MicroVM.

    • (string) –

Exceptions

• LambdaMicroVMs.Client.exceptions.InternalServerException

• LambdaMicroVMs.Client.exceptions.AccessDeniedException

• LambdaMicroVMs.Client.exceptions.ResourceNotFoundException

• LambdaMicroVMs.Client.exceptions.ThrottlingException

• LambdaMicroVMs.Client.exceptions.ValidationException