Class: Aws::LambdaMicrovms::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-lambdamicrovms/client.rb,
sig/client.rbs

Overview

An API client for LambdaMicrovms. To construct a client, you need to configure a :region and :credentials.

client = Aws::LambdaMicrovms::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Defined Under Namespace

Modules: _CreateMicrovmAuthTokenResponseSuccess, _CreateMicrovmImageResponseSuccess, _CreateMicrovmShellAuthTokenResponseSuccess, _DeleteMicrovmImageResponseSuccess, _DeleteMicrovmImageVersionResponseSuccess, _GetMicrovmImageBuildResponseSuccess, _GetMicrovmImageResponseSuccess, _GetMicrovmImageVersionResponseSuccess, _GetMicrovmResponseSuccess, _ListManagedMicrovmImageVersionsResponseSuccess, _ListManagedMicrovmImagesResponseSuccess, _ListMicrovmImageBuildsResponseSuccess, _ListMicrovmImageVersionsResponseSuccess, _ListMicrovmImagesResponseSuccess, _ListMicrovmsResponseSuccess, _ListTagsResponseSuccess, _ResumeMicrovmResponseSuccess, _RunMicrovmResponseSuccess, _SuspendMicrovmResponseSuccess, _TerminateMicrovmResponseSuccess, _UpdateMicrovmImageResponseSuccess, _UpdateMicrovmImageVersionResponseSuccess

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::LambdaMicrovms::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::LambdaMicrovms::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'lib/aws-sdk-lambdamicrovms/client.rb', line 471

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2001
2002
2003
 
# File 'lib/aws-sdk-lambdamicrovms/client.rb', line 2001

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2004
2005
2006
 
# File 'lib/aws-sdk-lambdamicrovms/client.rb', line 2004

def errors_module
  Errors
end

.new ⇒ Object

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/LambdaMicrovms/Client.html#initialize-instance_method



14
 
# File 'sig/client.rbs', line 14

def self.new: (

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
 
# File 'lib/aws-sdk-lambdamicrovms/client.rb', line 1974

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::LambdaMicrovms')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-lambdamicrovms'
  context[:gem_version] = '1.1.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_microvm_auth_token(params = {}) ⇒ Types::CreateMicrovmAuthTokenResponse

Creates an authentication token for accessing a running MicroVM. The token grants access to the specified ports on the MicroVM endpoint.

Examples:

Request syntax with placeholder values


resp = client.create_microvm_auth_token({
  microvm_identifier: "MicrovmIdentifier", # required
  expiration_in_minutes: 1, # required
  allowed_ports: [ # required
    {
      port: 1,
      range: {
        start_port: 1, # required
        end_port: 1, # required
      },
      all_ports: {
      },
    },
  ],
})

Response structure


resp.auth_token #=> Hash
resp.auth_token["AuthTokenKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :microvm_identifier (required, String) —

    The ID of the MicroVM to create an authentication token for.

  • :expiration_in_minutes (required, Integer) —

    The duration in minutes before the authentication token expires. Maximum: 60 minutes.

  • :allowed_ports (required, Array<Types::PortSpecification>) —

    The list of port specifications that the authentication token grants access to on the MicroVM.

Returns:

See Also:



86
 
# File 'sig/client.rbs', line 86

def create_microvm_auth_token: (

#create_microvm_image(params = {}) ⇒ Types::CreateMicrovmImageResponse

Creates a MicroVM image from the specified code artifact and base image. The build is asynchronous — the image transitions from CREATING to CREATED on success, or CREATE_FAILED on failure. Use GetMicrovmImage to poll for completion.

Examples:

Request syntax with placeholder values


resp = client.create_microvm_image({
  base_image_arn: "NonBlankString", # required
  base_image_version: "Version",
  build_role_arn: "RoleArn", # required
  description: "String",
  code_artifact: { # required
    uri: "NonBlankString",
  },
  logging: {
    disabled: {
    },
    cloud_watch: {
      log_group: "CloudWatchLoggingLogGroupString",
      log_stream: "CloudWatchLoggingLogStreamString",
    },
  },
  egress_network_connectors: ["NetworkConnector"],
  cpu_configurations: [
    {
      architecture: "ARM_64", # required, accepts ARM_64
    },
  ],
  resources: [
    {
      minimum_memory_in_mi_b: 1, # required
    },
  ],
  additional_os_capabilities: ["ALL"], # accepts ALL
  hooks: {
    port: 1,
    microvm_hooks: {
      run: "DISABLED", # accepts DISABLED, ENABLED
      run_timeout_in_seconds: 1,
      resume: "DISABLED", # accepts DISABLED, ENABLED
      resume_timeout_in_seconds: 1,
      suspend: "DISABLED", # accepts DISABLED, ENABLED
      suspend_timeout_in_seconds: 1,
      terminate: "DISABLED", # accepts DISABLED, ENABLED
      terminate_timeout_in_seconds: 1,
    },
    microvm_image_hooks: {
      ready: "DISABLED", # accepts DISABLED, ENABLED
      ready_timeout_in_seconds: 1,
      validate: "DISABLED", # accepts DISABLED, ENABLED
      validate_timeout_in_seconds: 1,
    },
  },
  environment_variables: {
    "EnvironmentVariableKey" => "EnvironmentVariableValue",
  },
  name: "ImageName", # required
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "CreateMicrovmImageRequestClientTokenString",
})

Response structure


resp.image_arn #=> String
resp.name #=> String
resp.state #=> String, one of "CREATING", "CREATED", "CREATE_FAILED", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED", "DELETED"
resp.latest_active_image_version #=> String
resp.latest_failed_image_version #=> String
resp.created_at #=> Time
resp.base_image_arn #=> String
resp.base_image_version #=> String
resp.build_role_arn #=> String
resp.description #=> String
resp.code_artifact.uri #=> String
resp.logging.cloud_watch.log_group #=> String
resp.logging.cloud_watch.log_stream #=> String
resp.egress_network_connectors #=> Array
resp.egress_network_connectors[0] #=> String
resp.cpu_configurations #=> Array
resp.cpu_configurations[0].architecture #=> String, one of "ARM_64"
resp.resources #=> Array
resp.resources[0].minimum_memory_in_mi_b #=> Integer
resp.additional_os_capabilities #=> Array
resp.additional_os_capabilities[0] #=> String, one of "ALL"
resp.hooks.port #=> Integer
resp.hooks.microvm_hooks.run #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.run_timeout_in_seconds #=> Integer
resp.hooks.microvm_hooks.resume #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.resume_timeout_in_seconds #=> Integer
resp.hooks.microvm_hooks.suspend #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.suspend_timeout_in_seconds #=> Integer
resp.hooks.microvm_hooks.terminate #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.terminate_timeout_in_seconds #=> Integer
resp.hooks.microvm_image_hooks.ready #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_image_hooks.ready_timeout_in_seconds #=> Integer
resp.hooks.microvm_image_hooks.validate #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_image_hooks.validate_timeout_in_seconds #=> Integer
resp.environment_variables #=> Hash
resp.environment_variables["EnvironmentVariableKey"] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.updated_at #=> Time
resp.image_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :base_image_arn (required, String) —

    The ARN of the Lambda-managed base MicroVM image to build upon. Use ListManagedMicrovmImages to discover available base images.

  • :base_image_version (String) —

    The specific version of the base MicroVM image to use.

  • :build_role_arn (required, String) —

    The ARN of the IAM role assumed during the image build process. This role must have permissions to access the code artifact and any required resources.

  • :description (String) —

    A description of the MicroVM image.

  • :code_artifact (required, Types::CodeArtifact) —

    The code artifact containing the application code and metadata for the MicroVM image.

  • :logging (Types::Logging) —

    The logging configuration for build-time and runtime logs. Specify {"logGroup": "..."} to stream logs to a custom CloudWatch log group, or {} to turn off logging.

  • :egress_network_connectors (Array<String>) —

    The list of egress network connectors available to the MicroVM at runtime.

  • :cpu_configurations (Array<Types::CpuConfiguration>) —

    The list of supported CPU configurations for the MicroVM.

  • :resources (Array<Types::Resources>) —

    The resource requirements for the MicroVM.

  • :additional_os_capabilities (Array<String>) —

    Additional OS capabilities granted to the MicroVM runtime environment.

  • :hooks (Types::Hooks) —

    Lifecycle hook configuration for MicroVMs and MicroVM images.

  • :environment_variables (Hash<String,String>) —

    Environment variables set in the MicroVM runtime environment.

  • :name (required, String) —

    The name of the MicroVM image. Must be unique within the AWS account.

  • :tags (Hash<String,String>) —

    A set of key-value pairs that you can attach to the resource. Use tags to categorize resources for cost allocation, access control (ABAC), and organization.

  • :client_token (String) —

    A unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the operation returns the successful response without performing any further actions.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



128
 
# File 'sig/client.rbs', line 128

def create_microvm_image: (

#create_microvm_shell_auth_token(params = {}) ⇒ Types::CreateMicrovmShellAuthTokenResponse

Creates a shell authentication token for interactive shell access to a running MicroVM. The MicroVM must have been run with the SHELL_INGRESS network connector attached.

Examples:

Request syntax with placeholder values


resp = client.create_microvm_shell_auth_token({
  microvm_identifier: "MicrovmIdentifier", # required
  expiration_in_minutes: 1, # required
})

Response structure


resp.auth_token #=> Hash
resp.auth_token["AuthTokenKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :microvm_identifier (required, String) —

    The ID of the MicroVM to create a shell authentication token for.

  • :expiration_in_minutes (required, Integer) —

    The duration in minutes before the shell authentication token expires.

Returns:

See Also:



162
 
# File 'sig/client.rbs', line 162

def create_microvm_shell_auth_token: (

#delete_microvm_image(params = {}) ⇒ Types::DeleteMicrovmImageOutput

Deletes a MicroVM image. This operation is idempotent; deleting an image that has already been deleted succeeds without error.

Examples:

Request syntax with placeholder values


resp = client.delete_microvm_image({
  image_identifier: "MicrovmImageIdentifier", # required
})

Response structure


resp.image_identifier #=> String
resp.state #=> String, one of "CREATING", "CREATED", "CREATE_FAILED", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_identifier (required, String) —

    The unique identifier (ARN or ID) of the MicroVM image to delete.

Returns:

See Also:



174
 
# File 'sig/client.rbs', line 174

def delete_microvm_image: (

#delete_microvm_image_version(params = {}) ⇒ Types::DeleteMicrovmImageVersionOutput

Deletes a specific version of a MicroVM image. This operation is idempotent; deleting a version that has already been deleted succeeds without error.

Examples:

Request syntax with placeholder values


resp = client.delete_microvm_image_version({
  image_identifier: "MicrovmImageIdentifier", # required
  image_version: "NonBlankString", # required
})

Response structure


resp.image_identifier #=> String
resp.image_version #=> String
resp.state #=> String, one of "PENDING", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "DELETING", "DELETED", "DELETE_FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_identifier (required, String) —

    The unique identifier (ARN or ID) of the MicroVM image.

  • :image_version (required, String) —

    The version of the MicroVM image to delete.

Returns:

See Also:



186
 
# File 'sig/client.rbs', line 186

def delete_microvm_image_version: (

#get_microvm(params = {}) ⇒ Types::GetMicrovmResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_microvm({
  microvm_identifier: "MicrovmIdentifier", # required
})

Response structure


resp.microvm_id #=> String
resp.state #=> String, one of "PENDING", "RUNNING", "SUSPENDING", "SUSPENDED", "TERMINATING", "TERMINATED"
resp.endpoint #=> String
resp.image_arn #=> String
resp.image_version #=> String
resp.execution_role_arn #=> String
resp.idle_policy.max_idle_duration_seconds #=> Integer
resp.idle_policy.suspended_duration_seconds #=> Integer
resp.idle_policy.auto_resume_enabled #=> Boolean
resp.maximum_duration_in_seconds #=> Integer
resp.started_at #=> Time
resp.terminated_at #=> Time
resp.state_reason #=> String
resp.ingress_network_connectors #=> Array
resp.ingress_network_connectors[0] #=> String
resp.egress_network_connectors #=> Array
resp.egress_network_connectors[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :microvm_identifier (required, String) —

    The ID of the MicroVM to retrieve.

Returns:

See Also:



209
 
# File 'sig/client.rbs', line 209

def get_microvm: (

#get_microvm_image(params = {}) ⇒ Types::GetMicrovmImageOutput

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

Examples:

Request syntax with placeholder values


resp = client.get_microvm_image({
  image_identifier: "MicrovmImageIdentifier", # required
})

Response structure


resp.image_arn #=> String
resp.name #=> String
resp.state #=> String, one of "CREATING", "CREATED", "CREATE_FAILED", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED", "DELETED"
resp.latest_active_image_version #=> String
resp.latest_failed_image_version #=> String
resp.created_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_identifier (required, String) —

    The unique identifier (ARN or ID) of the MicroVM image to retrieve.

Returns:

See Also:



226
 
# File 'sig/client.rbs', line 226

def get_microvm_image: (

#get_microvm_image_build(params = {}) ⇒ Types::GetMicrovmImageBuildOutput

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

Examples:

Request syntax with placeholder values


resp = client.get_microvm_image_build({
  image_identifier: "MicrovmImageIdentifier", # required
  image_version: "NonBlankString", # required
  build_id: "NonBlankString", # required
})

Response structure


resp.image_arn #=> String
resp.image_version #=> String
resp.build_id #=> String
resp.build_state #=> String, one of "PENDING", "IN_PROGRESS", "SUCCESSFUL", "FAILED"
resp.architecture #=> String, one of "ARM_64"
resp.chipset #=> String, one of "GRAVITON"
resp.chipset_generation #=> String
resp.state_reason #=> String
resp.created_at #=> Time
resp.snapshot_build.memory_snapshot_size_in_bytes #=> Integer
resp.snapshot_build.code_install_size_in_bytes #=> Integer
resp.snapshot_build.disk_snapshot_size_in_bytes #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_identifier (required, String) —

    The unique identifier (ARN or ID) of the MicroVM image.

  • :image_version (required, String) —

    The version of the MicroVM image.

  • :build_id (required, String) —

    The unique identifier of the build to retrieve.

Returns:

See Also:



245
 
# File 'sig/client.rbs', line 245

def get_microvm_image_build: (

#get_microvm_image_version(params = {}) ⇒ Types::GetMicrovmImageVersionOutput

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

Examples:

Request syntax with placeholder values


resp = client.get_microvm_image_version({
  image_identifier: "MicrovmImageIdentifier", # required
  image_version: "NonBlankString", # required
})

Response structure


resp.base_image_arn #=> String
resp.base_image_version #=> String
resp.build_role_arn #=> String
resp.description #=> String
resp.code_artifact.uri #=> String
resp.logging.cloud_watch.log_group #=> String
resp.logging.cloud_watch.log_stream #=> String
resp.egress_network_connectors #=> Array
resp.egress_network_connectors[0] #=> String
resp.cpu_configurations #=> Array
resp.cpu_configurations[0].architecture #=> String, one of "ARM_64"
resp.resources #=> Array
resp.resources[0].minimum_memory_in_mi_b #=> Integer
resp.additional_os_capabilities #=> Array
resp.additional_os_capabilities[0] #=> String, one of "ALL"
resp.hooks.port #=> Integer
resp.hooks.microvm_hooks.run #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.run_timeout_in_seconds #=> Integer
resp.hooks.microvm_hooks.resume #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.resume_timeout_in_seconds #=> Integer
resp.hooks.microvm_hooks.suspend #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.suspend_timeout_in_seconds #=> Integer
resp.hooks.microvm_hooks.terminate #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.terminate_timeout_in_seconds #=> Integer
resp.hooks.microvm_image_hooks.ready #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_image_hooks.ready_timeout_in_seconds #=> Integer
resp.hooks.microvm_image_hooks.validate #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_image_hooks.validate_timeout_in_seconds #=> Integer
resp.environment_variables #=> Hash
resp.environment_variables["EnvironmentVariableKey"] #=> String
resp.image_arn #=> String
resp.image_version #=> String
resp.state #=> String, one of "PENDING", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "DELETING", "DELETED", "DELETE_FAILED"
resp.status #=> String, one of "ACTIVE", "INACTIVE"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.state_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_identifier (required, String) —

    The unique identifier (ARN or ID) of the MicroVM image.

  • :image_version (required, String) —

    The version of the MicroVM image to retrieve.

Returns:

See Also:



276
 
# File 'sig/client.rbs', line 276

def get_microvm_image_version: (

#list_managed_microvm_image_versions(params = {}) ⇒ Types::ListManagedMicrovmImageVersionsOutput

Lists versions of a managed MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_managed_microvm_image_versions({
  max_results: 1,
  next_token: "String",
  image_identifier: "MicrovmImageIdentifier", # required
})

Response structure


resp.next_token #=> String
resp.items #=> Array
resp.items[0].image_arn #=> String
resp.items[0].image_version #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    The pagination token from a previous call. Use this token to retrieve the next page of results.

  • :image_identifier (required, String) —

    The unique identifier (ARN or ID) of the managed MicroVM image to list versions for.

Returns:

See Also:



288
 
# File 'sig/client.rbs', line 288

def list_managed_microvm_image_versions: (

#list_managed_microvm_images(params = {}) ⇒ Types::ListManagedMicrovmImagesOutput

Lists AWS managed MicroVM images available for use as base images. We recommend using pagination to ensure that the operation returns quickly and successfully.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_managed_microvm_images({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.items #=> Array
resp.items[0].image_arn #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    The pagination token from a previous call. Use this token to retrieve the next page of results.

Returns:

See Also:



301
 
# File 'sig/client.rbs', line 301

def list_managed_microvm_images: (

#list_microvm_image_builds(params = {}) ⇒ Types::ListMicrovmImageBuildsOutput

Lists builds for a MicroVM image version with optional filtering by architecture and chipset. We recommend using pagination to ensure that the operation returns quickly and successfully.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_microvm_image_builds({
  max_results: 1,
  next_token: "String",
  image_identifier: "MicrovmImageIdentifier", # required
  image_version: "NonBlankString", # required
  architecture: "ARM_64", # accepts ARM_64
  chipset: "GRAVITON", # accepts GRAVITON
  chipset_generation: "NonBlankString",
})

Response structure


resp.next_token #=> String
resp.items #=> Array
resp.items[0].image_arn #=> String
resp.items[0].image_version #=> String
resp.items[0].build_id #=> String
resp.items[0].build_state #=> String, one of "PENDING", "IN_PROGRESS", "SUCCESSFUL", "FAILED"
resp.items[0].architecture #=> String, one of "ARM_64"
resp.items[0].chipset #=> String, one of "GRAVITON"
resp.items[0].chipset_generation #=> String
resp.items[0].state_reason #=> String
resp.items[0].created_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    The pagination token from a previous call. Use this token to retrieve the next page of results.

  • :image_identifier (required, String) —

    The unique identifier (ARN or ID) of the MicroVM image.

  • :image_version (required, String) —

    The version of the MicroVM image to list builds for.

  • :architecture (String) —

    Filters builds by target CPU architecture.

  • :chipset (String) —

    Filters builds by target chipset.

  • :chipset_generation (String) —

    Filters builds by target chipset generation.

Returns:

See Also:



313
 
# File 'sig/client.rbs', line 313

def list_microvm_image_builds: (

#list_microvm_image_versions(params = {}) ⇒ Types::ListMicrovmImageVersionsOutput

Lists versions of a MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_microvm_image_versions({
  max_results: 1,
  next_token: "String",
  image_identifier: "MicrovmImageIdentifier", # required
})

Response structure


resp.next_token #=> String
resp.items #=> Array
resp.items[0].base_image_arn #=> String
resp.items[0].base_image_version #=> String
resp.items[0].build_role_arn #=> String
resp.items[0].description #=> String
resp.items[0].code_artifact.uri #=> String
resp.items[0].logging.cloud_watch.log_group #=> String
resp.items[0].logging.cloud_watch.log_stream #=> String
resp.items[0].egress_network_connectors #=> Array
resp.items[0].egress_network_connectors[0] #=> String
resp.items[0].cpu_configurations #=> Array
resp.items[0].cpu_configurations[0].architecture #=> String, one of "ARM_64"
resp.items[0].resources #=> Array
resp.items[0].resources[0].minimum_memory_in_mi_b #=> Integer
resp.items[0].additional_os_capabilities #=> Array
resp.items[0].additional_os_capabilities[0] #=> String, one of "ALL"
resp.items[0].hooks.port #=> Integer
resp.items[0].hooks.microvm_hooks.run #=> String, one of "DISABLED", "ENABLED"
resp.items[0].hooks.microvm_hooks.run_timeout_in_seconds #=> Integer
resp.items[0].hooks.microvm_hooks.resume #=> String, one of "DISABLED", "ENABLED"
resp.items[0].hooks.microvm_hooks.resume_timeout_in_seconds #=> Integer
resp.items[0].hooks.microvm_hooks.suspend #=> String, one of "DISABLED", "ENABLED"
resp.items[0].hooks.microvm_hooks.suspend_timeout_in_seconds #=> Integer
resp.items[0].hooks.microvm_hooks.terminate #=> String, one of "DISABLED", "ENABLED"
resp.items[0].hooks.microvm_hooks.terminate_timeout_in_seconds #=> Integer
resp.items[0].hooks.microvm_image_hooks.ready #=> String, one of "DISABLED", "ENABLED"
resp.items[0].hooks.microvm_image_hooks.ready_timeout_in_seconds #=> Integer
resp.items[0].hooks.microvm_image_hooks.validate #=> String, one of "DISABLED", "ENABLED"
resp.items[0].hooks.microvm_image_hooks.validate_timeout_in_seconds #=> Integer
resp.items[0].environment_variables #=> Hash
resp.items[0].environment_variables["EnvironmentVariableKey"] #=> String
resp.items[0].image_arn #=> String
resp.items[0].image_version #=> String
resp.items[0].state #=> String, one of "PENDING", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "DELETING", "DELETED", "DELETE_FAILED"
resp.items[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].state_reason #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    The pagination token from a previous call. Use this token to retrieve the next page of results.

  • :image_identifier (required, String) —

    The unique identifier (ARN or ID) of the MicroVM image to list versions for.

Returns:

See Also:



330
 
# File 'sig/client.rbs', line 330

def list_microvm_image_versions: (

#list_microvm_images(params = {}) ⇒ Types::ListMicrovmImagesResponse

Lists MicroVM images in the account with optional name filtering. We recommend using pagination to ensure that the operation returns quickly and successfully.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_microvm_images({
  max_results: 1,
  next_token: "String",
  name_filter: "NonBlankString",
})

Response structure


resp.next_token #=> String
resp.items #=> Array
resp.items[0].image_arn #=> String
resp.items[0].name #=> String
resp.items[0].state #=> String, one of "CREATING", "CREATED", "CREATE_FAILED", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED", "DELETED"
resp.items[0].latest_active_image_version #=> String
resp.items[0].latest_failed_image_version #=> String
resp.items[0].created_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    The pagination token from a previous call. Use this token to retrieve the next page of results.

  • :name_filter (String) —

    Filters images whose name contains the specified string.

Returns:

See Also:



343
 
# File 'sig/client.rbs', line 343

def list_microvm_images: (

#list_microvms(params = {}) ⇒ Types::ListMicrovmsResponse

Lists MicroVMs in the account with optional filtering by image and version. We recommend using pagination to ensure that the operation returns quickly and successfully.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_microvms({
  max_results: 1,
  next_token: "String",
  image_identifier: "MicrovmImageIdentifier",
  image_version: "String",
})

Response structure


resp.next_token #=> String
resp.items #=> Array
resp.items[0].microvm_id #=> String
resp.items[0].state #=> String, one of "PENDING", "RUNNING", "SUSPENDING", "SUSPENDED", "TERMINATING", "TERMINATED"
resp.items[0].image_arn #=> String
resp.items[0].image_version #=> String
resp.items[0].started_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    The pagination token from a previous call. Use this token to retrieve the next page of results.

  • :image_identifier (String) —

    Optional filter to list only MicroVMs running the specified image.

  • :image_version (String) —

    Optional filter to list only MicroVMs running the specified image version.

Returns:

See Also:



356
 
# File 'sig/client.rbs', line 356

def list_microvms: (

#list_tags(params = {}) ⇒ Types::ListTagsResponse

Lists the tags associated with a Lambda MicroVM resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags({
  resource: "TaggableResource", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource (required, String) —

    The ARN of the resource to list tags for.

Returns:

See Also:



369
 
# File 'sig/client.rbs', line 369

def list_tags: (

#resume_microvm(params = {}) ⇒ Struct

Resumes a suspended MicroVM, restoring it to RUNNING state with all state intact. The MicroVM must be in SUSPENDED state.

Examples:

Request syntax with placeholder values


resp = client.resume_microvm({
  microvm_identifier: "MicrovmIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :microvm_identifier (required, String) —

    The ID of the MicroVM to resume.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



378
 
# File 'sig/client.rbs', line 378

def resume_microvm: (

#run_microvm(params = {}) ⇒ Types::RunMicrovmResponse

Runs a new MicroVM from the specified image. The MicroVM starts in PENDING state and transitions to RUNNING once provisioning completes. To connect, generate an authentication token using CreateMicrovmAuthToken.

Examples:

Request syntax with placeholder values


resp = client.run_microvm({
  ingress_network_connectors: ["NetworkConnector"],
  egress_network_connectors: ["NetworkConnector"],
  image_identifier: "MicrovmImageIdentifier", # required
  image_version: "Version",
  execution_role_arn: "RoleArn",
  idle_policy: {
    max_idle_duration_seconds: 1, # required
    suspended_duration_seconds: 1, # required
    auto_resume_enabled: false, # required
  },
  logging: {
    disabled: {
    },
    cloud_watch: {
      log_group: "CloudWatchLoggingLogGroupString",
      log_stream: "CloudWatchLoggingLogStreamString",
    },
  },
  run_hook_payload: "RunMicrovmRequestRunHookPayloadString",
  maximum_duration_in_seconds: 1,
  client_token: "RunMicrovmRequestClientTokenString",
})

Response structure


resp.microvm_id #=> String
resp.state #=> String, one of "PENDING", "RUNNING", "SUSPENDING", "SUSPENDED", "TERMINATING", "TERMINATED"
resp.endpoint #=> String
resp.image_arn #=> String
resp.image_version #=> String
resp.execution_role_arn #=> String
resp.idle_policy.max_idle_duration_seconds #=> Integer
resp.idle_policy.suspended_duration_seconds #=> Integer
resp.idle_policy.auto_resume_enabled #=> Boolean
resp.maximum_duration_in_seconds #=> Integer
resp.started_at #=> Time
resp.terminated_at #=> Time
resp.state_reason #=> String
resp.ingress_network_connectors #=> Array
resp.ingress_network_connectors[0] #=> String
resp.egress_network_connectors #=> Array
resp.egress_network_connectors[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ingress_network_connectors (Array<String>) —

    The list of ingress network connectors to configure for the MicroVM.

  • :egress_network_connectors (Array<String>) —

    The list of egress network connectors to configure for the MicroVM.

  • :image_identifier (required, String) —

    The identifier (ARN or ID) of the MicroVM image to run.

  • :image_version (String) —

    The version of the MicroVM image to run.

  • :execution_role_arn (String) —

    The ARN of the IAM role to be assumed by the MicroVM during execution.

  • :idle_policy (Types::IdlePolicy) —

    Configuration to control auto-suspend and auto-resume behavior.

  • :logging (Types::Logging) —

    The logging configuration for this MicroVM instance. Specify {"logGroup": "..."} to stream application logs to a custom CloudWatch log group, or {} to turn off logging.

  • :run_hook_payload (String) —

    Per-MicroVM initialization data delivered as the request body of the /run lifecycle hook. Use to pass tenant-specific configuration such as session IDs or secret references. Maximum: 16,384 bytes.

  • :maximum_duration_in_seconds (Integer) —

    The maximum duration in seconds that the MicroVM can exist before being terminated by the platform. Valid range: 1–28,800 (8 hours).

  • :client_token (String) —

    A unique, case-sensitive identifier you provide to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



400
 
# File 'sig/client.rbs', line 400

def run_microvm: (

#suspend_microvm(params = {}) ⇒ Struct

Suspends a running MicroVM, preserving its full memory and disk state. The MicroVM transitions through SUSPENDING to SUSPENDED. To restore, call ResumeMicrovm or send traffic to the endpoint if autoResumeEnabled is true.

Examples:

Request syntax with placeholder values


resp = client.suspend_microvm({
  microvm_identifier: "MicrovmIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :microvm_identifier (required, String) —

    The ID of the MicroVM to suspend.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



422
 
# File 'sig/client.rbs', line 422

def suspend_microvm: (

#tag_resource(params = {}) ⇒ Struct

Adds tags to a Lambda MicroVM resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource: "TaggableResource", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource (required, String) —

    The ARN of the resource to tag.

  • :tags (required, Hash<String,String>) —

    The key-value pairs of tags to add to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



428
 
# File 'sig/client.rbs', line 428

def tag_resource: (

#terminate_microvm(params = {}) ⇒ Struct

Terminates a MicroVM. This operation is idempotent; terminating a MicroVM that has already been terminated succeeds without error.

Examples:

Request syntax with placeholder values


resp = client.terminate_microvm({
  microvm_identifier: "MicrovmIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :microvm_identifier (required, String) —

    The ID of the MicroVM to terminate.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



438
 
# File 'sig/client.rbs', line 438

def terminate_microvm: (

#untag_resource(params = {}) ⇒ Struct

Removes tags from a Lambda MicroVM resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource: "TaggableResource", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource (required, String) —

    The ARN of the resource to remove tags from.

  • :tag_keys (required, Array<String>) —

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



444
 
# File 'sig/client.rbs', line 444

def untag_resource: (

#update_microvm_image(params = {}) ⇒ Types::UpdateMicrovmImageResponse

Updates the configuration of a MicroVM image and triggers a new version build. This operation uses PUT semantics — all required fields (codeArtifact, baseImageArn, buildRoleArn) must be provided with every request.

Examples:

Request syntax with placeholder values


resp = client.update_microvm_image({
  base_image_arn: "NonBlankString", # required
  base_image_version: "Version",
  build_role_arn: "RoleArn", # required
  description: "String",
  code_artifact: { # required
    uri: "NonBlankString",
  },
  logging: {
    disabled: {
    },
    cloud_watch: {
      log_group: "CloudWatchLoggingLogGroupString",
      log_stream: "CloudWatchLoggingLogStreamString",
    },
  },
  egress_network_connectors: ["NetworkConnector"],
  cpu_configurations: [
    {
      architecture: "ARM_64", # required, accepts ARM_64
    },
  ],
  resources: [
    {
      minimum_memory_in_mi_b: 1, # required
    },
  ],
  additional_os_capabilities: ["ALL"], # accepts ALL
  hooks: {
    port: 1,
    microvm_hooks: {
      run: "DISABLED", # accepts DISABLED, ENABLED
      run_timeout_in_seconds: 1,
      resume: "DISABLED", # accepts DISABLED, ENABLED
      resume_timeout_in_seconds: 1,
      suspend: "DISABLED", # accepts DISABLED, ENABLED
      suspend_timeout_in_seconds: 1,
      terminate: "DISABLED", # accepts DISABLED, ENABLED
      terminate_timeout_in_seconds: 1,
    },
    microvm_image_hooks: {
      ready: "DISABLED", # accepts DISABLED, ENABLED
      ready_timeout_in_seconds: 1,
      validate: "DISABLED", # accepts DISABLED, ENABLED
      validate_timeout_in_seconds: 1,
    },
  },
  environment_variables: {
    "EnvironmentVariableKey" => "EnvironmentVariableValue",
  },
  image_identifier: "MicrovmImageIdentifier", # required
  client_token: "UpdateMicrovmImageRequestClientTokenString",
})

Response structure


resp.image_arn #=> String
resp.name #=> String
resp.state #=> String, one of "CREATING", "CREATED", "CREATE_FAILED", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED", "DELETED"
resp.latest_active_image_version #=> String
resp.latest_failed_image_version #=> String
resp.created_at #=> Time
resp.base_image_arn #=> String
resp.base_image_version #=> String
resp.build_role_arn #=> String
resp.description #=> String
resp.code_artifact.uri #=> String
resp.logging.cloud_watch.log_group #=> String
resp.logging.cloud_watch.log_stream #=> String
resp.egress_network_connectors #=> Array
resp.egress_network_connectors[0] #=> String
resp.cpu_configurations #=> Array
resp.cpu_configurations[0].architecture #=> String, one of "ARM_64"
resp.resources #=> Array
resp.resources[0].minimum_memory_in_mi_b #=> Integer
resp.additional_os_capabilities #=> Array
resp.additional_os_capabilities[0] #=> String, one of "ALL"
resp.hooks.port #=> Integer
resp.hooks.microvm_hooks.run #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.run_timeout_in_seconds #=> Integer
resp.hooks.microvm_hooks.resume #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.resume_timeout_in_seconds #=> Integer
resp.hooks.microvm_hooks.suspend #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.suspend_timeout_in_seconds #=> Integer
resp.hooks.microvm_hooks.terminate #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.terminate_timeout_in_seconds #=> Integer
resp.hooks.microvm_image_hooks.ready #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_image_hooks.ready_timeout_in_seconds #=> Integer
resp.hooks.microvm_image_hooks.validate #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_image_hooks.validate_timeout_in_seconds #=> Integer
resp.environment_variables #=> Hash
resp.environment_variables["EnvironmentVariableKey"] #=> String
resp.updated_at #=> Time
resp.image_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :base_image_arn (required, String) —

    The ARN of the base MicroVM image.

  • :base_image_version (String) —

    The specific version of the base MicroVM image to use.

  • :build_role_arn (required, String) —

    The ARN of the IAM build role.

  • :description (String) —

    The description of the MicroVM image.

  • :code_artifact (required, Types::CodeArtifact) —

    The code artifact containing the application code and metadata for the MicroVM image.

  • :logging (Types::Logging) —

    The logging configuration for build-time and runtime logs. Specify {"logGroup": "..."} to stream logs to a custom CloudWatch log group, or {} to turn off logging.

  • :egress_network_connectors (Array<String>) —

    The list of egress network connectors available to the MicroVM at runtime.

  • :cpu_configurations (Array<Types::CpuConfiguration>) —

    The list of supported CPU configurations for the MicroVM.

  • :resources (Array<Types::Resources>) —

    The resource requirements for the MicroVM.

  • :additional_os_capabilities (Array<String>) —

    Additional OS capabilities granted to the MicroVM runtime environment.

  • :hooks (Types::Hooks) —

    Lifecycle hook configuration for MicroVMs and MicroVM images.

  • :environment_variables (Hash<String,String>) —

    Environment variables set in the MicroVM runtime environment.

  • :image_identifier (required, String) —

    The unique identifier (ARN or ID) of the MicroVM image to update.

  • :client_token (String) —

    A unique, case-sensitive identifier you provide to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



474
 
# File 'sig/client.rbs', line 474

def update_microvm_image: (

#update_microvm_image_version(params = {}) ⇒ Types::UpdateMicrovmImageVersionResponse

Updates the status of a specific MicroVM image version.

Examples:

Request syntax with placeholder values


resp = client.update_microvm_image_version({
  image_identifier: "MicrovmImageIdentifier", # required
  image_version: "NonBlankString", # required
  status: "ACTIVE", # required, accepts ACTIVE, INACTIVE
})

Response structure


resp.base_image_arn #=> String
resp.base_image_version #=> String
resp.build_role_arn #=> String
resp.description #=> String
resp.code_artifact.uri #=> String
resp.logging.cloud_watch.log_group #=> String
resp.logging.cloud_watch.log_stream #=> String
resp.egress_network_connectors #=> Array
resp.egress_network_connectors[0] #=> String
resp.cpu_configurations #=> Array
resp.cpu_configurations[0].architecture #=> String, one of "ARM_64"
resp.resources #=> Array
resp.resources[0].minimum_memory_in_mi_b #=> Integer
resp.additional_os_capabilities #=> Array
resp.additional_os_capabilities[0] #=> String, one of "ALL"
resp.hooks.port #=> Integer
resp.hooks.microvm_hooks.run #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.run_timeout_in_seconds #=> Integer
resp.hooks.microvm_hooks.resume #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.resume_timeout_in_seconds #=> Integer
resp.hooks.microvm_hooks.suspend #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.suspend_timeout_in_seconds #=> Integer
resp.hooks.microvm_hooks.terminate #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_hooks.terminate_timeout_in_seconds #=> Integer
resp.hooks.microvm_image_hooks.ready #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_image_hooks.ready_timeout_in_seconds #=> Integer
resp.hooks.microvm_image_hooks.validate #=> String, one of "DISABLED", "ENABLED"
resp.hooks.microvm_image_hooks.validate_timeout_in_seconds #=> Integer
resp.environment_variables #=> Hash
resp.environment_variables["EnvironmentVariableKey"] #=> String
resp.image_arn #=> String
resp.image_version #=> String
resp.state #=> String, one of "PENDING", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "DELETING", "DELETED", "DELETE_FAILED"
resp.status #=> String, one of "ACTIVE", "INACTIVE"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.state_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :image_identifier (required, String) —

    The unique identifier (ARN or ID) of the MicroVM image.

  • :image_version (required, String) —

    The version of the MicroVM image to update.

  • :status (required, String) —

    The new status to set for the MicroVM image version.

Returns:

See Also:



526
 
# File 'sig/client.rbs', line 526

def update_microvm_image_version: (

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1994
1995
1996
 
# File 'lib/aws-sdk-lambdamicrovms/client.rb', line 1994

def waiter_names
  []
end