Module Smaws_Client_EC2InstanceConnect.Types

type nonrec string_ = string
type nonrec throttling_exception = {
  1. message : string_ option;
}

The requests were made too frequently and have been throttled. Wait a while and try again. To increase the limit on your request frequency, contact AWS Support.

type nonrec success = bool
type nonrec service_exception = {
  1. message : string_ option;
}

The service encountered an error. Follow the instructions in the error message and try again.

type nonrec serial_port = int
type nonrec serial_console_session_unsupported_exception = {
  1. message : string_ option;
}

Your instance's BIOS version is unsupported for serial console connection. Reboot your instance to update its BIOS, and then try again to connect.

type nonrec serial_console_session_unavailable_exception = {
  1. message : string_ option;
}

Unable to start a serial console session. Please try again.

type nonrec serial_console_session_limit_exceeded_exception = {
  1. message : string_ option;
}

The instance currently has 1 active serial console session. Only 1 session is supported at a time.

type nonrec serial_console_access_disabled_exception = {
  1. message : string_ option;
}

Your account is not authorized to use the EC2 Serial Console. To authorize your account, run the EnableSerialConsoleAccess API. For more information, see EnableSerialConsoleAccess in the Amazon EC2 API Reference.

type nonrec request_id = string
type nonrec send_serial_console_ssh_public_key_response = {
  1. success : success option;
    (*

    Is true if the request succeeds and an error otherwise.

    *)
  2. request_id : request_id option;
    (*

    The ID of the request. Please provide this ID when contacting AWS Support for assistance.

    *)
}
type nonrec instance_id = string
type nonrec ssh_public_key = string
type nonrec send_serial_console_ssh_public_key_request = {
  1. ssh_public_key : ssh_public_key;
    (*

    The public key material. To use the public key, you must have the matching private key. For information about the supported key formats and lengths, see Requirements for key pairs in the Amazon EC2 User Guide.

    *)
  2. serial_port : serial_port option;
    (*

    The serial port of the EC2 instance. Currently only port 0 is supported.

    Default: 0

    *)
  3. instance_id : instance_id;
    (*

    The ID of the EC2 instance.

    *)
}
type nonrec invalid_args_exception = {
  1. message : string_ option;
}

One of the parameters is not valid.

type nonrec ec2_instance_unavailable_exception = {
  1. message : string_ option;
}

The instance is currently unavailable. Wait a few minutes and try again.

type nonrec ec2_instance_type_invalid_exception = {
  1. message : string_ option;
}

The instance type is not supported for connecting via the serial console. Only Nitro instance types are currently supported.

type nonrec ec2_instance_state_invalid_exception = {
  1. message : string_ option;
}

Unable to connect because the instance is not in a valid state. Connecting to a stopped or terminated instance is not supported. If the instance is stopped, start your instance, and try to connect again.

type nonrec ec2_instance_not_found_exception = {
  1. message : string_ option;
}

The specified instance was not found.

type nonrec auth_exception = {
  1. message : string_ option;
}

Either your AWS credentials are not valid or you do not have access to the EC2 instance.

type nonrec send_ssh_public_key_response = {
  1. success : success option;
    (*

    Is true if the request succeeds and an error otherwise.

    *)
  2. request_id : request_id option;
    (*

    The ID of the request. Please provide this ID when contacting AWS Support for assistance.

    *)
}
type nonrec instance_os_user = string
type nonrec availability_zone = string
type nonrec send_ssh_public_key_request = {
  1. availability_zone : availability_zone option;
    (*

    The Availability Zone in which the EC2 instance was launched.

    *)
  2. ssh_public_key : ssh_public_key;
    (*

    The public key material. To use the public key, you must have the matching private key.

    *)
  3. instance_os_user : instance_os_user;
    (*

    The OS user on the EC2 instance for whom the key can be used to authenticate.

    *)
  4. instance_id : instance_id;
    (*

    The ID of the EC2 instance.

    *)
}