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.SendSSHPublicKey

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data SendSSHPublicKey = SendSSHPublicKey' {
- instanceId :: Text
- instanceOSUser :: Text
- sSHPublicKey :: Text
- availabilityZone :: Text
}
newSendSSHPublicKey :: Text -> Text -> Text -> Text -> SendSSHPublicKey
sendSSHPublicKey_instanceId :: Lens' SendSSHPublicKey Text
sendSSHPublicKey_instanceOSUser :: Lens' SendSSHPublicKey Text
sendSSHPublicKey_sSHPublicKey :: Lens' SendSSHPublicKey Text
sendSSHPublicKey_availabilityZone :: Lens' SendSSHPublicKey Text
data SendSSHPublicKeyResponse = SendSSHPublicKeyResponse' {
- requestId :: Maybe Text
- success :: Maybe Bool
- httpStatus :: Int
}
newSendSSHPublicKeyResponse :: Int -> SendSSHPublicKeyResponse
sendSSHPublicKeyResponse_requestId :: Lens' SendSSHPublicKeyResponse (Maybe Text)
sendSSHPublicKeyResponse_success :: Lens' SendSSHPublicKeyResponse (Maybe Bool)
sendSSHPublicKeyResponse_httpStatus :: Lens' SendSSHPublicKeyResponse Int

Creating a Request

data SendSSHPublicKey Source #

See: newSendSSHPublicKey smart constructor.

Constructors

SendSSHPublicKey'
Fields instanceId :: Text The ID of the EC2 instance. instanceOSUser :: Text The OS user on the EC2 instance for whom the key can be used to authenticate. sSHPublicKey :: Text The public key material. To use the public key, you must have the matching private key. availabilityZone :: Text The Availability Zone in which the EC2 instance was launched.

Instances

Instances details

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

newSendSSHPublicKey Source #

Arguments

:: Text	`$sel:instanceId:SendSSHPublicKey'`
-> Text	`$sel:instanceOSUser:SendSSHPublicKey'`
-> Text	`$sel:sSHPublicKey:SendSSHPublicKey'`
-> Text	`$sel:availabilityZone:SendSSHPublicKey'`
-> SendSSHPublicKey

Create a value of SendSSHPublicKey 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:instanceId:SendSSHPublicKey', sendSSHPublicKey_instanceId - The ID of the EC2 instance.

$sel:instanceOSUser:SendSSHPublicKey', sendSSHPublicKey_instanceOSUser - The OS user on the EC2 instance for whom the key can be used to authenticate.

$sel:sSHPublicKey:SendSSHPublicKey', sendSSHPublicKey_sSHPublicKey - The public key material. To use the public key, you must have the matching private key.

$sel:availabilityZone:SendSSHPublicKey', sendSSHPublicKey_availabilityZone - The Availability Zone in which the EC2 instance was launched.

Request Lenses

sendSSHPublicKey_instanceId :: Lens' SendSSHPublicKey Text Source #

The ID of the EC2 instance.

sendSSHPublicKey_instanceOSUser :: Lens' SendSSHPublicKey Text Source #

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

sendSSHPublicKey_sSHPublicKey :: Lens' SendSSHPublicKey Text Source #

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

sendSSHPublicKey_availabilityZone :: Lens' SendSSHPublicKey Text Source #

The Availability Zone in which the EC2 instance was launched.

Destructuring the Response

data SendSSHPublicKeyResponse Source #

See: newSendSSHPublicKeyResponse smart constructor.

Constructors

SendSSHPublicKeyResponse'
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 SendSSHPublicKeyResponse Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSSHPublicKey Methods (==) :: SendSSHPublicKeyResponse -> SendSSHPublicKeyResponse -> Bool # (/=) :: SendSSHPublicKeyResponse -> SendSSHPublicKeyResponse -> Bool #
Read SendSSHPublicKeyResponse Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSSHPublicKey Methods readsPrec :: Int -> ReadS SendSSHPublicKeyResponse # readList :: ReadS [SendSSHPublicKeyResponse] # readPrec :: ReadPrec SendSSHPublicKeyResponse # readListPrec :: ReadPrec [SendSSHPublicKeyResponse] #
Show SendSSHPublicKeyResponse Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSSHPublicKey Methods showsPrec :: Int -> SendSSHPublicKeyResponse -> ShowS # show :: SendSSHPublicKeyResponse -> String # showList :: [SendSSHPublicKeyResponse] -> ShowS #
Generic SendSSHPublicKeyResponse Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSSHPublicKey Associated Types type Rep SendSSHPublicKeyResponse :: Type -> Type # Methods from :: SendSSHPublicKeyResponse -> Rep SendSSHPublicKeyResponse x # to :: Rep SendSSHPublicKeyResponse x -> SendSSHPublicKeyResponse #
NFData SendSSHPublicKeyResponse Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSSHPublicKey Methods rnf :: SendSSHPublicKeyResponse -> () #
type Rep SendSSHPublicKeyResponse Source #
Instance details Defined in Amazonka.EC2InstanceConnect.SendSSHPublicKey type Rep SendSSHPublicKeyResponse = D1 ('MetaData "SendSSHPublicKeyResponse" "Amazonka.EC2InstanceConnect.SendSSHPublicKey" "libZSservicesZSamazonka-ec2-instance-connectZSamazonka-ec2-instance-connect" 'False) (C1 ('MetaCons "SendSSHPublicKeyResponse'" '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))))

newSendSSHPublicKeyResponse Source #

Arguments

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

Create a value of SendSSHPublicKeyResponse 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:SendSSHPublicKeyResponse', sendSSHPublicKeyResponse_requestId - The ID of the request. Please provide this ID when contacting AWS Support for assistance.

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

$sel:httpStatus:SendSSHPublicKeyResponse', sendSSHPublicKeyResponse_httpStatus - The response's http status code.

Response Lenses

sendSSHPublicKeyResponse_requestId :: Lens' SendSSHPublicKeyResponse (Maybe Text) Source #

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

sendSSHPublicKeyResponse_success :: Lens' SendSSHPublicKeyResponse (Maybe Bool) Source #

Is true if the request succeeds and an error otherwise.

sendSSHPublicKeyResponse_httpStatus :: Lens' SendSSHPublicKeyResponse Int Source #

The response's http status code.