Skip to content

LambdaMicroVMsClient#

Index > LambdaMicroVMs > LambdaMicroVMsClient

Auto-generated documentation for LambdaMicroVMs type annotations stubs module types-boto3-lambda-microvms.

LambdaMicroVMsClient#

Type annotations and code completion for boto3.client("lambda-microvms"). boto3 documentation

# LambdaMicroVMsClient usage example

from boto3.session import Session
from types_boto3_lambda_microvms.client import LambdaMicroVMsClient

def get_lambda-microvms_client() -> LambdaMicroVMsClient:
    return Session().client("lambda-microvms")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("lambda-microvms").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("lambda-microvms")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidParameterValueException,
    client.exceptions.ResourceConflictException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyRequestsException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_lambda_microvms.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("lambda-microvms").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("lambda-microvms").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_microvm_auth_token#

Creates an authentication token for accessing a running MicroVM.

Type annotations and code completion for boto3.client("lambda-microvms").create_microvm_auth_token method. boto3 documentation

# create_microvm_auth_token method definition

def create_microvm_auth_token(
    self,
    *,
    microvmIdentifier: str,
    expirationInMinutes: int,
    allowedPorts: Sequence[PortSpecificationTypeDef],  # (1)
) -> CreateMicrovmAuthTokenResponseTypeDef:  # (2)
    ...
  1. See Sequence[PortSpecificationTypeDef]
  2. See CreateMicrovmAuthTokenResponseTypeDef
# create_microvm_auth_token method usage example with argument unpacking

kwargs: CreateMicrovmAuthTokenRequestTypeDef = {  # (1)
    "microvmIdentifier": ...,
    "expirationInMinutes": ...,
    "allowedPorts": ...,
}

parent.create_microvm_auth_token(**kwargs)
  1. See CreateMicrovmAuthTokenRequestTypeDef

create_microvm_image#

Creates a MicroVM image from the specified code artifact and base image.

Type annotations and code completion for boto3.client("lambda-microvms").create_microvm_image method. boto3 documentation

# create_microvm_image method definition

def create_microvm_image(
    self,
    *,
    baseImageArn: str,
    buildRoleArn: str,
    codeArtifact: CodeArtifactTypeDef,  # (1)
    name: str,
    baseImageVersion: str = ...,
    description: str = ...,
    logging: LoggingUnionTypeDef = ...,  # (2)
    egressNetworkConnectors: Sequence[str] = ...,
    cpuConfigurations: Sequence[CpuConfigurationTypeDef] = ...,  # (3)
    resources: Sequence[ResourcesTypeDef] = ...,  # (4)
    additionalOsCapabilities: Sequence[CapabilityType] = ...,  # (5)
    hooks: HooksTypeDef = ...,  # (6)
    environmentVariables: Mapping[str, str] = ...,
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateMicrovmImageResponseTypeDef:  # (7)
    ...
  1. See CodeArtifactTypeDef
  2. See LoggingUnionTypeDef
  3. See Sequence[CpuConfigurationTypeDef]
  4. See Sequence[ResourcesTypeDef]
  5. See Sequence[Literal['ALL']]
  6. See HooksTypeDef
  7. See CreateMicrovmImageResponseTypeDef
# create_microvm_image method usage example with argument unpacking

kwargs: CreateMicrovmImageRequestTypeDef = {  # (1)
    "baseImageArn": ...,
    "buildRoleArn": ...,
    "codeArtifact": ...,
    "name": ...,
}

parent.create_microvm_image(**kwargs)
  1. See CreateMicrovmImageRequestTypeDef

create_microvm_shell_auth_token#

Creates a shell authentication token for interactive shell access to a running MicroVM.

Type annotations and code completion for boto3.client("lambda-microvms").create_microvm_shell_auth_token method. boto3 documentation

# create_microvm_shell_auth_token method definition

def create_microvm_shell_auth_token(
    self,
    *,
    microvmIdentifier: str,
    expirationInMinutes: int,
) -> CreateMicrovmShellAuthTokenResponseTypeDef:  # (1)
    ...
  1. See CreateMicrovmShellAuthTokenResponseTypeDef
# create_microvm_shell_auth_token method usage example with argument unpacking

kwargs: CreateMicrovmShellAuthTokenRequestTypeDef = {  # (1)
    "microvmIdentifier": ...,
    "expirationInMinutes": ...,
}

parent.create_microvm_shell_auth_token(**kwargs)
  1. See CreateMicrovmShellAuthTokenRequestTypeDef

delete_microvm_image#

Deletes a MicroVM image.

Type annotations and code completion for boto3.client("lambda-microvms").delete_microvm_image method. boto3 documentation

# delete_microvm_image method definition

def delete_microvm_image(
    self,
    *,
    imageIdentifier: str,
) -> DeleteMicrovmImageOutputTypeDef:  # (1)
    ...
  1. See DeleteMicrovmImageOutputTypeDef
# delete_microvm_image method usage example with argument unpacking

kwargs: DeleteMicrovmImageInputTypeDef = {  # (1)
    "imageIdentifier": ...,
}

parent.delete_microvm_image(**kwargs)
  1. See DeleteMicrovmImageInputTypeDef

delete_microvm_image_version#

Deletes a specific version of a MicroVM image.

Type annotations and code completion for boto3.client("lambda-microvms").delete_microvm_image_version method. boto3 documentation

# delete_microvm_image_version method definition

def delete_microvm_image_version(
    self,
    *,
    imageIdentifier: str,
    imageVersion: str,
) -> DeleteMicrovmImageVersionOutputTypeDef:  # (1)
    ...
  1. See DeleteMicrovmImageVersionOutputTypeDef
# delete_microvm_image_version method usage example with argument unpacking

kwargs: DeleteMicrovmImageVersionInputTypeDef = {  # (1)
    "imageIdentifier": ...,
    "imageVersion": ...,
}

parent.delete_microvm_image_version(**kwargs)
  1. See DeleteMicrovmImageVersionInputTypeDef

get_microvm#

Retrieves the details of a specific MicroVM, including its state, endpoint, image information, and configuration.

Type annotations and code completion for boto3.client("lambda-microvms").get_microvm method. boto3 documentation

# get_microvm method definition

def get_microvm(
    self,
    *,
    microvmIdentifier: str,
) -> GetMicrovmResponseTypeDef:  # (1)
    ...
  1. See GetMicrovmResponseTypeDef
# get_microvm method usage example with argument unpacking

kwargs: GetMicrovmRequestTypeDef = {  # (1)
    "microvmIdentifier": ...,
}

parent.get_microvm(**kwargs)
  1. See GetMicrovmRequestTypeDef

get_microvm_image#

Retrieves the details of a MicroVM image, including its state, versions, and configuration.

Type annotations and code completion for boto3.client("lambda-microvms").get_microvm_image method. boto3 documentation

# get_microvm_image method definition

def get_microvm_image(
    self,
    *,
    imageIdentifier: str,
) -> GetMicrovmImageOutputTypeDef:  # (1)
    ...
  1. See GetMicrovmImageOutputTypeDef
# get_microvm_image method usage example with argument unpacking

kwargs: GetMicrovmImageInputTypeDef = {  # (1)
    "imageIdentifier": ...,
}

parent.get_microvm_image(**kwargs)
  1. See GetMicrovmImageInputTypeDef

get_microvm_image_build#

Retrieves the details of a specific MicroVM image build, including its state, target architecture, and snapshot information.

Type annotations and code completion for boto3.client("lambda-microvms").get_microvm_image_build method. boto3 documentation

# get_microvm_image_build method definition

def get_microvm_image_build(
    self,
    *,
    imageIdentifier: str,
    imageVersion: str,
    buildId: str,
) -> GetMicrovmImageBuildOutputTypeDef:  # (1)
    ...
  1. See GetMicrovmImageBuildOutputTypeDef
# get_microvm_image_build method usage example with argument unpacking

kwargs: GetMicrovmImageBuildInputTypeDef = {  # (1)
    "imageIdentifier": ...,
    "imageVersion": ...,
    "buildId": ...,
}

parent.get_microvm_image_build(**kwargs)
  1. See GetMicrovmImageBuildInputTypeDef

get_microvm_image_version#

Retrieves the details of a specific version of a MicroVM image, including its configuration, state, and build information.

Type annotations and code completion for boto3.client("lambda-microvms").get_microvm_image_version method. boto3 documentation

# get_microvm_image_version method definition

def get_microvm_image_version(
    self,
    *,
    imageIdentifier: str,
    imageVersion: str,
) -> GetMicrovmImageVersionOutputTypeDef:  # (1)
    ...
  1. See GetMicrovmImageVersionOutputTypeDef
# get_microvm_image_version method usage example with argument unpacking

kwargs: GetMicrovmImageVersionInputTypeDef = {  # (1)
    "imageIdentifier": ...,
    "imageVersion": ...,
}

parent.get_microvm_image_version(**kwargs)
  1. See GetMicrovmImageVersionInputTypeDef

list_managed_microvm_image_versions#

Lists versions of a managed MicroVM image.

Type annotations and code completion for boto3.client("lambda-microvms").list_managed_microvm_image_versions method. boto3 documentation

# list_managed_microvm_image_versions method definition

def list_managed_microvm_image_versions(
    self,
    *,
    imageIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListManagedMicrovmImageVersionsOutputTypeDef:  # (1)
    ...
  1. See ListManagedMicrovmImageVersionsOutputTypeDef
# list_managed_microvm_image_versions method usage example with argument unpacking

kwargs: ListManagedMicrovmImageVersionsInputTypeDef = {  # (1)
    "imageIdentifier": ...,
}

parent.list_managed_microvm_image_versions(**kwargs)
  1. See ListManagedMicrovmImageVersionsInputTypeDef

list_managed_microvm_images#

Lists AWS managed MicroVM images available for use as base images.

Type annotations and code completion for boto3.client("lambda-microvms").list_managed_microvm_images method. boto3 documentation

# list_managed_microvm_images method definition

def list_managed_microvm_images(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListManagedMicrovmImagesOutputTypeDef:  # (1)
    ...
  1. See ListManagedMicrovmImagesOutputTypeDef
# list_managed_microvm_images method usage example with argument unpacking

kwargs: ListManagedMicrovmImagesInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_managed_microvm_images(**kwargs)
  1. See ListManagedMicrovmImagesInputTypeDef

list_microvm_image_builds#

Lists builds for a MicroVM image version with optional filtering by architecture and chipset.

Type annotations and code completion for boto3.client("lambda-microvms").list_microvm_image_builds method. boto3 documentation

# list_microvm_image_builds method definition

def list_microvm_image_builds(
    self,
    *,
    imageIdentifier: str,
    imageVersion: str,
    maxResults: int = ...,
    nextToken: str = ...,
    architecture: ArchitectureType = ...,  # (1)
    chipset: ChipsetType = ...,  # (2)
    chipsetGeneration: str = ...,
) -> ListMicrovmImageBuildsOutputTypeDef:  # (3)
    ...
  1. See ArchitectureType
  2. See ChipsetType
  3. See ListMicrovmImageBuildsOutputTypeDef
# list_microvm_image_builds method usage example with argument unpacking

kwargs: ListMicrovmImageBuildsInputTypeDef = {  # (1)
    "imageIdentifier": ...,
    "imageVersion": ...,
}

parent.list_microvm_image_builds(**kwargs)
  1. See ListMicrovmImageBuildsInputTypeDef

list_microvm_image_versions#

Lists versions of a MicroVM image.

Type annotations and code completion for boto3.client("lambda-microvms").list_microvm_image_versions method. boto3 documentation

# list_microvm_image_versions method definition

def list_microvm_image_versions(
    self,
    *,
    imageIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMicrovmImageVersionsOutputTypeDef:  # (1)
    ...
  1. See ListMicrovmImageVersionsOutputTypeDef
# list_microvm_image_versions method usage example with argument unpacking

kwargs: ListMicrovmImageVersionsInputTypeDef = {  # (1)
    "imageIdentifier": ...,
}

parent.list_microvm_image_versions(**kwargs)
  1. See ListMicrovmImageVersionsInputTypeDef

list_microvm_images#

Lists MicroVM images in the account with optional name filtering.

Type annotations and code completion for boto3.client("lambda-microvms").list_microvm_images method. boto3 documentation

# list_microvm_images method definition

def list_microvm_images(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    nameFilter: str = ...,
) -> ListMicrovmImagesResponseTypeDef:  # (1)
    ...
  1. See ListMicrovmImagesResponseTypeDef
# list_microvm_images method usage example with argument unpacking

kwargs: ListMicrovmImagesRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_microvm_images(**kwargs)
  1. See ListMicrovmImagesRequestTypeDef

list_microvms#

Lists MicroVMs in the account with optional filtering by image and version.

Type annotations and code completion for boto3.client("lambda-microvms").list_microvms method. boto3 documentation

# list_microvms method definition

def list_microvms(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    imageIdentifier: str = ...,
    imageVersion: str = ...,
) -> ListMicrovmsResponseTypeDef:  # (1)
    ...
  1. See ListMicrovmsResponseTypeDef
# list_microvms method usage example with argument unpacking

kwargs: ListMicrovmsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_microvms(**kwargs)
  1. See ListMicrovmsRequestTypeDef

list_tags#

Lists the tags associated with a Lambda MicroVM resource.

Type annotations and code completion for boto3.client("lambda-microvms").list_tags method. boto3 documentation

# list_tags method definition

def list_tags(
    self,
    *,
    Resource: str,
) -> ListTagsResponseTypeDef:  # (1)
    ...
  1. See ListTagsResponseTypeDef
# list_tags method usage example with argument unpacking

kwargs: ListTagsRequestTypeDef = {  # (1)
    "Resource": ...,
}

parent.list_tags(**kwargs)
  1. See ListTagsRequestTypeDef

resume_microvm#

Resumes a suspended MicroVM, restoring it to RUNNING state with all state intact.

Type annotations and code completion for boto3.client("lambda-microvms").resume_microvm method. boto3 documentation

# resume_microvm method definition

def resume_microvm(
    self,
    *,
    microvmIdentifier: str,
) -> dict[str, Any]:
    ...
# resume_microvm method usage example with argument unpacking

kwargs: ResumeMicrovmRequestTypeDef = {  # (1)
    "microvmIdentifier": ...,
}

parent.resume_microvm(**kwargs)
  1. See ResumeMicrovmRequestTypeDef

run_microvm#

Runs a new MicroVM from the specified image.

Type annotations and code completion for boto3.client("lambda-microvms").run_microvm method. boto3 documentation

# run_microvm method definition

def run_microvm(
    self,
    *,
    imageIdentifier: str,
    ingressNetworkConnectors: Sequence[str] = ...,
    egressNetworkConnectors: Sequence[str] = ...,
    imageVersion: str = ...,
    executionRoleArn: str = ...,
    idlePolicy: IdlePolicyTypeDef = ...,  # (1)
    logging: LoggingUnionTypeDef = ...,  # (2)
    runHookPayload: str = ...,
    maximumDurationInSeconds: int = ...,
    clientToken: str = ...,
) -> RunMicrovmResponseTypeDef:  # (3)
    ...
  1. See IdlePolicyTypeDef
  2. See LoggingUnionTypeDef
  3. See RunMicrovmResponseTypeDef
# run_microvm method usage example with argument unpacking

kwargs: RunMicrovmRequestTypeDef = {  # (1)
    "imageIdentifier": ...,
}

parent.run_microvm(**kwargs)
  1. See RunMicrovmRequestTypeDef

suspend_microvm#

Suspends a running MicroVM, preserving its full memory and disk state.

Type annotations and code completion for boto3.client("lambda-microvms").suspend_microvm method. boto3 documentation

# suspend_microvm method definition

def suspend_microvm(
    self,
    *,
    microvmIdentifier: str,
) -> dict[str, Any]:
    ...
# suspend_microvm method usage example with argument unpacking

kwargs: SuspendMicrovmRequestTypeDef = {  # (1)
    "microvmIdentifier": ...,
}

parent.suspend_microvm(**kwargs)
  1. See SuspendMicrovmRequestTypeDef

tag_resource#

Adds tags to a Lambda MicroVM resource.

Type annotations and code completion for boto3.client("lambda-microvms").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    Resource: str,
    Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "Resource": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

terminate_microvm#

Terminates a MicroVM.

Type annotations and code completion for boto3.client("lambda-microvms").terminate_microvm method. boto3 documentation

# terminate_microvm method definition

def terminate_microvm(
    self,
    *,
    microvmIdentifier: str,
) -> dict[str, Any]:
    ...
# terminate_microvm method usage example with argument unpacking

kwargs: TerminateMicrovmRequestTypeDef = {  # (1)
    "microvmIdentifier": ...,
}

parent.terminate_microvm(**kwargs)
  1. See TerminateMicrovmRequestTypeDef

untag_resource#

Removes tags from a Lambda MicroVM resource.

Type annotations and code completion for boto3.client("lambda-microvms").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    Resource: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "Resource": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_microvm_image#

Updates the configuration of a MicroVM image and triggers a new version build.

Type annotations and code completion for boto3.client("lambda-microvms").update_microvm_image method. boto3 documentation

# update_microvm_image method definition

def update_microvm_image(
    self,
    *,
    baseImageArn: str,
    buildRoleArn: str,
    codeArtifact: CodeArtifactTypeDef,  # (1)
    imageIdentifier: str,
    baseImageVersion: str = ...,
    description: str = ...,
    logging: LoggingUnionTypeDef = ...,  # (2)
    egressNetworkConnectors: Sequence[str] = ...,
    cpuConfigurations: Sequence[CpuConfigurationTypeDef] = ...,  # (3)
    resources: Sequence[ResourcesTypeDef] = ...,  # (4)
    additionalOsCapabilities: Sequence[CapabilityType] = ...,  # (5)
    hooks: HooksTypeDef = ...,  # (6)
    environmentVariables: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> UpdateMicrovmImageResponseTypeDef:  # (7)
    ...
  1. See CodeArtifactTypeDef
  2. See LoggingUnionTypeDef
  3. See Sequence[CpuConfigurationTypeDef]
  4. See Sequence[ResourcesTypeDef]
  5. See Sequence[Literal['ALL']]
  6. See HooksTypeDef
  7. See UpdateMicrovmImageResponseTypeDef
# update_microvm_image method usage example with argument unpacking

kwargs: UpdateMicrovmImageRequestTypeDef = {  # (1)
    "baseImageArn": ...,
    "buildRoleArn": ...,
    "codeArtifact": ...,
    "imageIdentifier": ...,
}

parent.update_microvm_image(**kwargs)
  1. See UpdateMicrovmImageRequestTypeDef

update_microvm_image_version#

Updates the status of a specific MicroVM image version.

Type annotations and code completion for boto3.client("lambda-microvms").update_microvm_image_version method. boto3 documentation

# update_microvm_image_version method definition

def update_microvm_image_version(
    self,
    *,
    imageIdentifier: str,
    imageVersion: str,
    status: MicrovmImageVersionStatusType,  # (1)
) -> UpdateMicrovmImageVersionResponseTypeDef:  # (2)
    ...
  1. See MicrovmImageVersionStatusType
  2. See UpdateMicrovmImageVersionResponseTypeDef
# update_microvm_image_version method usage example with argument unpacking

kwargs: UpdateMicrovmImageVersionRequestTypeDef = {  # (1)
    "imageIdentifier": ...,
    "imageVersion": ...,
    "status": ...,
}

parent.update_microvm_image_version(**kwargs)
  1. See UpdateMicrovmImageVersionRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("lambda-microvms").get_paginator method with overloads.