Pushes an SSH public key to the specified EC2 instance for use by the specified user. The key remains for 60 seconds. For more information, see Connect to your Linux instance using EC2 Instance Connect in the Amazon EC2 User Guide.
" }, "SendSerialConsoleSSHPublicKey":{ "name":"SendSerialConsoleSSHPublicKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SendSerialConsoleSSHPublicKeyRequest"}, "output":{"shape":"SendSerialConsoleSSHPublicKeyResponse"}, "errors":[ {"shape":"AuthException"}, {"shape":"SerialConsoleAccessDisabledException"}, {"shape":"InvalidArgsException"}, {"shape":"ServiceException"}, {"shape":"ThrottlingException"}, {"shape":"EC2InstanceNotFoundException"}, {"shape":"EC2InstanceTypeInvalidException"}, {"shape":"SerialConsoleSessionLimitExceededException"}, {"shape":"SerialConsoleSessionUnavailableException"}, {"shape":"EC2InstanceStateInvalidException"}, {"shape":"EC2InstanceUnavailableException"}, {"shape":"SerialConsoleSessionUnsupportedException"} ], "documentation":"Pushes an SSH public key to the specified EC2 instance. The key remains for 60 seconds, which gives you 60 seconds to establish a serial console connection to the instance using SSH. For more information, see EC2 Serial Console in the Amazon EC2 User Guide.
" } }, "shapes":{ "AuthException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"Either your AWS credentials are not valid or you do not have access to the EC2 instance.
", "exception":true }, "AvailabilityZone":{ "type":"string", "max":32, "min":6, "pattern":"^(\\w+-){2,3}\\d+\\w+$" }, "EC2InstanceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The specified instance was not found.
", "exception":true }, "EC2InstanceStateInvalidException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"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.
", "exception":true }, "EC2InstanceTypeInvalidException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The instance type is not supported for connecting via the serial console. Only Nitro instance types are currently supported.
", "exception":true }, "EC2InstanceUnavailableException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The instance is currently unavailable. Wait a few minutes and try again.
", "exception":true }, "InstanceId":{ "type":"string", "max":32, "min":10, "pattern":"^i-[a-f0-9]+$" }, "InstanceOSUser":{ "type":"string", "max":32, "min":1, "pattern":"(^[A-Za-z_][A-Za-z0-9\\@\\._-]{0,30}[A-Za-z0-9\\$_-]?$)|(^(?=.{2,32}$)[0-9]{1,32}[A-Za-z\\@\\._-][A-Za-z0-9\\@\\._-]*[A-Za-z0-9\\$_-]?$)" }, "InvalidArgsException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"One of the parameters is not valid.
", "exception":true }, "RequestId":{"type":"string"}, "SSHPublicKey":{ "type":"string", "max":4096, "min":80 }, "SendSSHPublicKeyRequest":{ "type":"structure", "required":[ "InstanceId", "InstanceOSUser", "SSHPublicKey" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"The ID of the EC2 instance.
" }, "InstanceOSUser":{ "shape":"InstanceOSUser", "documentation":"The OS user on the EC2 instance for whom the key can be used to authenticate.
" }, "SSHPublicKey":{ "shape":"SSHPublicKey", "documentation":"The public key material. To use the public key, you must have the matching private key.
" }, "AvailabilityZone":{ "shape":"AvailabilityZone", "documentation":"The Availability Zone in which the EC2 instance was launched.
" } } }, "SendSSHPublicKeyResponse":{ "type":"structure", "members":{ "RequestId":{ "shape":"RequestId", "documentation":"The ID of the request. Please provide this ID when contacting AWS Support for assistance.
" }, "Success":{ "shape":"Success", "documentation":"Is true if the request succeeds and an error otherwise.
" } } }, "SendSerialConsoleSSHPublicKeyRequest":{ "type":"structure", "required":[ "InstanceId", "SSHPublicKey" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"The ID of the EC2 instance.
" }, "SerialPort":{ "shape":"SerialPort", "documentation":"The serial port of the EC2 instance. Currently only port 0 is supported.
Default: 0
" }, "SSHPublicKey":{ "shape":"SSHPublicKey", "documentation":"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.
" } } }, "SendSerialConsoleSSHPublicKeyResponse":{ "type":"structure", "members":{ "RequestId":{ "shape":"RequestId", "documentation":"The ID of the request. Please provide this ID when contacting AWS Support for assistance.
" }, "Success":{ "shape":"Success", "documentation":"Is true if the request succeeds and an error otherwise.
" } } }, "SerialConsoleAccessDisabledException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"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.
", "exception":true }, "SerialConsoleSessionLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The instance currently has 1 active serial console session. Only 1 session is supported at a time.
", "exception":true }, "SerialConsoleSessionUnavailableException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"Unable to start a serial console session. Please try again.
", "exception":true, "fault":true }, "SerialConsoleSessionUnsupportedException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"Your instance's BIOS version is unsupported for serial console connection. Reboot your instance to update its BIOS, and then try again to connect.
", "exception":true }, "SerialPort":{ "type":"integer", "max":0, "min":0 }, "ServiceException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The service encountered an error. Follow the instructions in the error message and try again.
", "exception":true, "fault":true }, "String":{"type":"string"}, "Success":{"type":"boolean"}, "ThrottlingException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"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.
", "exception":true } }, "documentation":"This is the Amazon EC2 Instance Connect API Reference. It provides descriptions, syntax, and usage examples for each of the actions for Amazon EC2 Instance Connect. Amazon EC2 Instance Connect enables system administrators to publish one-time use SSH public keys to EC2, providing users a simple and secure way to connect to their instances.
To view the Amazon EC2 Instance Connect content in the Amazon EC2 User Guide, see Connect to your Linux instance using EC2 Instance Connect.
For Amazon EC2 APIs, see the Amazon EC2 API Reference.
" }