Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Lightsail.GetInstanceAccessDetails

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

Creating a Request

data GetInstanceAccessDetails Source #

See: newGetInstanceAccessDetails smart constructor.

Constructors

GetInstanceAccessDetails'
Fields protocol :: Maybe InstanceAccessProtocol The protocol to use to connect to your instance. Defaults to `ssh`. instanceName :: Text The name of the instance to access.

Instances

Instances details

ToJSON GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods toJSON :: GetInstanceAccessDetails -> Value # toEncoding :: GetInstanceAccessDetails -> Encoding # toJSONList :: [GetInstanceAccessDetails] -> Value # toEncodingList :: [GetInstanceAccessDetails] -> Encoding #
ToHeaders GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods toHeaders :: GetInstanceAccessDetails -> [Header] #
ToPath GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods toPath :: GetInstanceAccessDetails -> ByteString #
ToQuery GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods toQuery :: GetInstanceAccessDetails -> QueryString #
AWSRequest GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Associated Types type AWSResponse GetInstanceAccessDetails # Methods request :: (Service -> Service) -> GetInstanceAccessDetails -> Request GetInstanceAccessDetails # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetInstanceAccessDetails -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetInstanceAccessDetails))) #
Generic GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Associated Types type Rep GetInstanceAccessDetails :: Type -> Type # Methods from :: GetInstanceAccessDetails -> Rep GetInstanceAccessDetails x # to :: Rep GetInstanceAccessDetails x -> GetInstanceAccessDetails #
Read GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods readsPrec :: Int -> ReadS GetInstanceAccessDetails # readList :: ReadS [GetInstanceAccessDetails] # readPrec :: ReadPrec GetInstanceAccessDetails # readListPrec :: ReadPrec [GetInstanceAccessDetails] #
Show GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods showsPrec :: Int -> GetInstanceAccessDetails -> ShowS # show :: GetInstanceAccessDetails -> String # showList :: [GetInstanceAccessDetails] -> ShowS #
NFData GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods rnf :: GetInstanceAccessDetails -> () #
Eq GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods (==) :: GetInstanceAccessDetails -> GetInstanceAccessDetails -> Bool # (/=) :: GetInstanceAccessDetails -> GetInstanceAccessDetails -> Bool #
Hashable GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods hashWithSalt :: Int -> GetInstanceAccessDetails -> Int # hash :: GetInstanceAccessDetails -> Int #
type AWSResponse GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails type AWSResponse GetInstanceAccessDetails = GetInstanceAccessDetailsResponse
type Rep GetInstanceAccessDetails Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails type Rep GetInstanceAccessDetails = D1 ('MetaData "GetInstanceAccessDetails" "Amazonka.Lightsail.GetInstanceAccessDetails" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "GetInstanceAccessDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceAccessProtocol)) :*: S1 ('MetaSel ('Just "instanceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetInstanceAccessDetails Source #

Arguments

:: Text	`GetInstanceAccessDetails`
-> GetInstanceAccessDetails

Create a value of GetInstanceAccessDetails 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:

GetInstanceAccessDetails, getInstanceAccessDetails_protocol - The protocol to use to connect to your instance. Defaults to ssh.

GetInstanceAccessDetails, getInstanceAccessDetails_instanceName - The name of the instance to access.

Request Lenses

getInstanceAccessDetails_protocol :: Lens' GetInstanceAccessDetails (Maybe InstanceAccessProtocol) Source #

The protocol to use to connect to your instance. Defaults to ssh.

getInstanceAccessDetails_instanceName :: Lens' GetInstanceAccessDetails Text Source #

The name of the instance to access.

Destructuring the Response

data GetInstanceAccessDetailsResponse Source #

See: newGetInstanceAccessDetailsResponse smart constructor.

Constructors

GetInstanceAccessDetailsResponse'
Fields accessDetails :: Maybe InstanceAccessDetails An array of key-value pairs containing information about a get instance access request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetInstanceAccessDetailsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Associated Types type Rep GetInstanceAccessDetailsResponse :: Type -> Type # Methods from :: GetInstanceAccessDetailsResponse -> Rep GetInstanceAccessDetailsResponse x # to :: Rep GetInstanceAccessDetailsResponse x -> GetInstanceAccessDetailsResponse #
Read GetInstanceAccessDetailsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods readsPrec :: Int -> ReadS GetInstanceAccessDetailsResponse # readList :: ReadS [GetInstanceAccessDetailsResponse] # readPrec :: ReadPrec GetInstanceAccessDetailsResponse # readListPrec :: ReadPrec [GetInstanceAccessDetailsResponse] #
Show GetInstanceAccessDetailsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods showsPrec :: Int -> GetInstanceAccessDetailsResponse -> ShowS # show :: GetInstanceAccessDetailsResponse -> String # showList :: [GetInstanceAccessDetailsResponse] -> ShowS #
NFData GetInstanceAccessDetailsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods rnf :: GetInstanceAccessDetailsResponse -> () #
Eq GetInstanceAccessDetailsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails Methods (==) :: GetInstanceAccessDetailsResponse -> GetInstanceAccessDetailsResponse -> Bool # (/=) :: GetInstanceAccessDetailsResponse -> GetInstanceAccessDetailsResponse -> Bool #
type Rep GetInstanceAccessDetailsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetInstanceAccessDetails type Rep GetInstanceAccessDetailsResponse = D1 ('MetaData "GetInstanceAccessDetailsResponse" "Amazonka.Lightsail.GetInstanceAccessDetails" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "GetInstanceAccessDetailsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceAccessDetails)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetInstanceAccessDetailsResponse Source #

Arguments

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

Create a value of GetInstanceAccessDetailsResponse 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:accessDetails:GetInstanceAccessDetailsResponse', getInstanceAccessDetailsResponse_accessDetails - An array of key-value pairs containing information about a get instance access request.

$sel:httpStatus:GetInstanceAccessDetailsResponse', getInstanceAccessDetailsResponse_httpStatus - The response's http status code.

Response Lenses

getInstanceAccessDetailsResponse_accessDetails :: Lens' GetInstanceAccessDetailsResponse (Maybe InstanceAccessDetails) Source #

An array of key-value pairs containing information about a get instance access request.

getInstanceAccessDetailsResponse_httpStatus :: Lens' GetInstanceAccessDetailsResponse Int Source #

The response's http status code.