LambdaMicroVMs / Client / create_microvm_shell_auth_token

create_microvm_shell_auth_token

LambdaMicroVMs.Client.create_microvm_shell_auth_token(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_microvm_shell_auth_token(
    microvmIdentifier='string',
    expirationInMinutes=123
)

Parameters:

• microvmIdentifier (string) –

  [REQUIRED]

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

• expirationInMinutes (integer) –

  [REQUIRED]

  The duration in minutes before the shell authentication token expires.

Return type:

dict

Returns:

Response Syntax

{
    'authToken': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  • authToken (dict) –

    The generated shell authentication token key-value pairs for accessing the MicroVM.

    • (string) –

      • (string) –

Exceptions

• LambdaMicroVMs.Client.exceptions.InternalServerException

• LambdaMicroVMs.Client.exceptions.AccessDeniedException

• LambdaMicroVMs.Client.exceptions.ResourceNotFoundException

• LambdaMicroVMs.Client.exceptions.ThrottlingException

• LambdaMicroVMs.Client.exceptions.ValidationException