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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about all key pairs in the user's account.

This operation returns paginated results.

Creating a Request

data GetKeyPairs Source #

See: newGetKeyPairs smart constructor.

Constructors

GetKeyPairs'

Fields

includeDefaultKeyPair :: Maybe Bool
A Boolean value that indicates whether to include the default key pair in the response of your request.
pageToken :: Maybe Text
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetKeyPairs request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Instances

Instances details

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

newGetKeyPairs :: GetKeyPairs Source #

Create a value of GetKeyPairs 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:includeDefaultKeyPair:GetKeyPairs', getKeyPairs_includeDefaultKeyPair - A Boolean value that indicates whether to include the default key pair in the response of your request.

$sel:pageToken:GetKeyPairs', getKeyPairs_pageToken - The token to advance to the next page of results from your request.

To get a page token, perform an initial GetKeyPairs request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Request Lenses

getKeyPairs_includeDefaultKeyPair :: Lens' GetKeyPairs (Maybe Bool) Source #

A Boolean value that indicates whether to include the default key pair in the response of your request.

getKeyPairs_pageToken :: Lens' GetKeyPairs (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetKeyPairs request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Destructuring the Response

data GetKeyPairsResponse Source #

See: newGetKeyPairsResponse smart constructor.

Constructors

GetKeyPairsResponse'

Fields

keyPairs :: Maybe [KeyPair]
An array of key-value pairs containing information about the key pairs.
nextPageToken :: Maybe Text
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetKeyPairs request and specify the next page token using the pageToken parameter.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetKeyPairsResponse Source #

Arguments

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

Create a value of GetKeyPairsResponse 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:keyPairs:GetKeyPairsResponse', getKeyPairsResponse_keyPairs - An array of key-value pairs containing information about the key pairs.

$sel:nextPageToken:GetKeyPairsResponse', getKeyPairsResponse_nextPageToken - The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetKeyPairs request and specify the next page token using the pageToken parameter.

$sel:httpStatus:GetKeyPairsResponse', getKeyPairsResponse_httpStatus - The response's http status code.

Response Lenses

getKeyPairsResponse_keyPairs :: Lens' GetKeyPairsResponse (Maybe [KeyPair]) Source #

An array of key-value pairs containing information about the key pairs.

getKeyPairsResponse_nextPageToken :: Lens' GetKeyPairsResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetKeyPairs request and specify the next page token using the pageToken parameter.

getKeyPairsResponse_httpStatus :: Lens' GetKeyPairsResponse Int Source #

The response's http status code.