Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data SendSerialConsoleSSHPublicKey Source #

See: newSendSerialConsoleSSHPublicKey smart constructor.

Constructors

SendSerialConsoleSSHPublicKey'
Fields serialPort :: Maybe Natural The serial port of the EC2 instance. Currently only port 0 is supported. Default: 0 instanceId :: Text The ID of the EC2 instance. sSHPublicKey :: Text 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.

Instances

Instances details

Eq SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods (==) :: SendSerialConsoleSSHPublicKey -> SendSerialConsoleSSHPublicKey -> Bool # (/=) :: SendSerialConsoleSSHPublicKey -> SendSerialConsoleSSHPublicKey -> Bool #
Read SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods readsPrec :: Int -> ReadS SendSerialConsoleSSHPublicKey # readList :: ReadS [SendSerialConsoleSSHPublicKey] # readPrec :: ReadPrec SendSerialConsoleSSHPublicKey # readListPrec :: ReadPrec [SendSerialConsoleSSHPublicKey] #
Show SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods showsPrec :: Int -> SendSerialConsoleSSHPublicKey -> ShowS # show :: SendSerialConsoleSSHPublicKey -> String # showList :: [SendSerialConsoleSSHPublicKey] -> ShowS #
Generic SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Associated Types type Rep SendSerialConsoleSSHPublicKey :: Type -> Type # Methods from :: SendSerialConsoleSSHPublicKey -> Rep SendSerialConsoleSSHPublicKey x # to :: Rep SendSerialConsoleSSHPublicKey x -> SendSerialConsoleSSHPublicKey #
NFData SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods rnf :: SendSerialConsoleSSHPublicKey -> () #
Hashable SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods hashWithSalt :: Int -> SendSerialConsoleSSHPublicKey -> Int # hash :: SendSerialConsoleSSHPublicKey -> Int #
ToJSON SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods toJSON :: SendSerialConsoleSSHPublicKey -> Value # toEncoding :: SendSerialConsoleSSHPublicKey -> Encoding # toJSONList :: [SendSerialConsoleSSHPublicKey] -> Value # toEncodingList :: [SendSerialConsoleSSHPublicKey] -> Encoding #
AWSRequest SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Associated Types type AWSResponse SendSerialConsoleSSHPublicKey # Methods request :: SendSerialConsoleSSHPublicKey -> Request SendSerialConsoleSSHPublicKey # response :: MonadResource m => Logger -> Service -> Proxy SendSerialConsoleSSHPublicKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendSerialConsoleSSHPublicKey))) #
ToHeaders SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods toHeaders :: SendSerialConsoleSSHPublicKey -> [Header] #
ToPath SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods toPath :: SendSerialConsoleSSHPublicKey -> ByteString #
ToQuery SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods toQuery :: SendSerialConsoleSSHPublicKey -> QueryString #
type Rep SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey type Rep SendSerialConsoleSSHPublicKey = D1 ('MetaData "SendSerialConsoleSSHPublicKey" "Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey" "libZSservicesZSamazonka-ec2-instance-connectZSamazonka-ec2-instance-connect" 'False) (C1 ('MetaCons "SendSerialConsoleSSHPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serialPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sSHPublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse SendSerialConsoleSSHPublicKey Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey type AWSResponse SendSerialConsoleSSHPublicKey = SendSerialConsoleSSHPublicKeyResponse

newSendSerialConsoleSSHPublicKey Source #

Arguments

:: Text	`$sel:instanceId:SendSerialConsoleSSHPublicKey'`
-> Text	`$sel:sSHPublicKey:SendSerialConsoleSSHPublicKey'`
-> SendSerialConsoleSSHPublicKey

Create a value of SendSerialConsoleSSHPublicKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:serialPort:SendSerialConsoleSSHPublicKey', sendSerialConsoleSSHPublicKey_serialPort - The serial port of the EC2 instance. Currently only port 0 is supported.

Default: 0

$sel:instanceId:SendSerialConsoleSSHPublicKey', sendSerialConsoleSSHPublicKey_instanceId - The ID of the EC2 instance.

$sel:sSHPublicKey:SendSerialConsoleSSHPublicKey', sendSerialConsoleSSHPublicKey_sSHPublicKey - 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.

Request Lenses

sendSerialConsoleSSHPublicKey_serialPort :: Lens' SendSerialConsoleSSHPublicKey (Maybe Natural) Source #

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

Default: 0

sendSerialConsoleSSHPublicKey_instanceId :: Lens' SendSerialConsoleSSHPublicKey Text Source #

The ID of the EC2 instance.

sendSerialConsoleSSHPublicKey_sSHPublicKey :: Lens' SendSerialConsoleSSHPublicKey Text Source #

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.

Destructuring the Response

data SendSerialConsoleSSHPublicKeyResponse Source #

See: newSendSerialConsoleSSHPublicKeyResponse smart constructor.

Constructors

SendSerialConsoleSSHPublicKeyResponse'
Fields requestId :: Maybe Text The ID of the request. Please provide this ID when contacting AWS Support for assistance. success :: Maybe Bool Is true if the request succeeds and an error otherwise. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SendSerialConsoleSSHPublicKeyResponse Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods (==) :: SendSerialConsoleSSHPublicKeyResponse -> SendSerialConsoleSSHPublicKeyResponse -> Bool # (/=) :: SendSerialConsoleSSHPublicKeyResponse -> SendSerialConsoleSSHPublicKeyResponse -> Bool #
Read SendSerialConsoleSSHPublicKeyResponse Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods readsPrec :: Int -> ReadS SendSerialConsoleSSHPublicKeyResponse # readList :: ReadS [SendSerialConsoleSSHPublicKeyResponse] # readPrec :: ReadPrec SendSerialConsoleSSHPublicKeyResponse # readListPrec :: ReadPrec [SendSerialConsoleSSHPublicKeyResponse] #
Show SendSerialConsoleSSHPublicKeyResponse Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods showsPrec :: Int -> SendSerialConsoleSSHPublicKeyResponse -> ShowS # show :: SendSerialConsoleSSHPublicKeyResponse -> String # showList :: [SendSerialConsoleSSHPublicKeyResponse] -> ShowS #
Generic SendSerialConsoleSSHPublicKeyResponse Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Associated Types type Rep SendSerialConsoleSSHPublicKeyResponse :: Type -> Type # Methods from :: SendSerialConsoleSSHPublicKeyResponse -> Rep SendSerialConsoleSSHPublicKeyResponse x # to :: Rep SendSerialConsoleSSHPublicKeyResponse x -> SendSerialConsoleSSHPublicKeyResponse #
NFData SendSerialConsoleSSHPublicKeyResponse Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey Methods rnf :: SendSerialConsoleSSHPublicKeyResponse -> () #
type Rep SendSerialConsoleSSHPublicKeyResponse Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey type Rep SendSerialConsoleSSHPublicKeyResponse = D1 ('MetaData "SendSerialConsoleSSHPublicKeyResponse" "Amazonka.EC2InstanceConnect.SendSerialConsoleSSHPublicKey" "libZSservicesZSamazonka-ec2-instance-connectZSamazonka-ec2-instance-connect" 'False) (C1 ('MetaCons "SendSerialConsoleSSHPublicKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "success") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSendSerialConsoleSSHPublicKeyResponse Source #

Arguments

:: Int	`$sel:httpStatus:SendSerialConsoleSSHPublicKeyResponse'`
-> SendSerialConsoleSSHPublicKeyResponse

Create a value of SendSerialConsoleSSHPublicKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:requestId:SendSerialConsoleSSHPublicKeyResponse', sendSerialConsoleSSHPublicKeyResponse_requestId - The ID of the request. Please provide this ID when contacting AWS Support for assistance.

$sel:success:SendSerialConsoleSSHPublicKeyResponse', sendSerialConsoleSSHPublicKeyResponse_success - Is true if the request succeeds and an error otherwise.

$sel:httpStatus:SendSerialConsoleSSHPublicKeyResponse', sendSerialConsoleSSHPublicKeyResponse_httpStatus - The response's http status code.

Response Lenses

sendSerialConsoleSSHPublicKeyResponse_requestId :: Lens' SendSerialConsoleSSHPublicKeyResponse (Maybe Text) Source #

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

sendSerialConsoleSSHPublicKeyResponse_success :: Lens' SendSerialConsoleSSHPublicKeyResponse (Maybe Bool) Source #

Is true if the request succeeds and an error otherwise.

sendSerialConsoleSSHPublicKeyResponse_httpStatus :: Lens' SendSerialConsoleSSHPublicKeyResponse Int Source #

The response's http status code.