amazonka-transfer-2.0: Amazon Transfer Family SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transfer.ListHostKeys

Description

Returns a list of host keys for the server that's specified by the ServerId parameter.

Synopsis

Creating a Request

data ListHostKeys Source #

See: newListHostKeys smart constructor.

Constructors

ListHostKeys' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of host keys to return.

  • nextToken :: Maybe Text

    When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListHostKeys to continue listing results.

  • serverId :: Text

    The identifier of the server that contains the host keys that you want to view.

Instances

Instances details
ToJSON ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

toJSON :: ListHostKeys -> Value #

toEncoding :: ListHostKeys -> Encoding #

toJSONList :: [ListHostKeys] -> Value #

toEncodingList :: [ListHostKeys] -> Encoding #

ToHeaders ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

toHeaders :: ListHostKeys -> [Header] #

ToPath ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

toPath :: ListHostKeys -> ByteString #

ToQuery ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

toQuery :: ListHostKeys -> QueryString #

AWSRequest ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Associated Types

type AWSResponse ListHostKeys #

Methods

request :: (Service -> Service) -> ListHostKeys -> Request ListHostKeys #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListHostKeys -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListHostKeys))) #

Generic ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Associated Types

type Rep ListHostKeys :: Type -> Type #

Methods

from :: ListHostKeys -> Rep ListHostKeys x #

to :: Rep ListHostKeys x -> ListHostKeys #

Read ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

readsPrec :: Int -> ReadS ListHostKeys #

readList :: ReadS [ListHostKeys] #

readPrec :: ReadPrec ListHostKeys #

readListPrec :: ReadPrec [ListHostKeys] #

Show ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

showsPrec :: Int -> ListHostKeys -> ShowS #

show :: ListHostKeys -> String #

showList :: [ListHostKeys] -> ShowS #

NFData ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

rnf :: ListHostKeys -> () #

Eq ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

(==) :: ListHostKeys -> ListHostKeys -> Bool #

(/=) :: ListHostKeys -> ListHostKeys -> Bool #

Hashable ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

hashWithSalt :: Int -> ListHostKeys -> Int #

hash :: ListHostKeys -> Int #

type AWSResponse ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

type AWSResponse ListHostKeys = ListHostKeysResponse
type Rep ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

type Rep ListHostKeys = D1 ('MetaData "ListHostKeys" "Amazonka.Transfer.ListHostKeys" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListHostKeys'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListHostKeys Source #

Arguments

:: Text

ListHostKeys

-> ListHostKeys 

Create a value of ListHostKeys 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:maxResults:ListHostKeys', listHostKeys_maxResults - The maximum number of host keys to return.

ListHostKeys, listHostKeys_nextToken - When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListHostKeys to continue listing results.

ListHostKeys, listHostKeys_serverId - The identifier of the server that contains the host keys that you want to view.

Request Lenses

listHostKeys_maxResults :: Lens' ListHostKeys (Maybe Natural) Source #

The maximum number of host keys to return.

listHostKeys_nextToken :: Lens' ListHostKeys (Maybe Text) Source #

When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListHostKeys to continue listing results.

listHostKeys_serverId :: Lens' ListHostKeys Text Source #

The identifier of the server that contains the host keys that you want to view.

Destructuring the Response

data ListHostKeysResponse Source #

See: newListHostKeysResponse smart constructor.

Constructors

ListHostKeysResponse' 

Fields

  • nextToken :: Maybe Text

    Returns a token that you can use to call ListHostKeys again and receive additional results, if there are any.

  • httpStatus :: Int

    The response's http status code.

  • serverId :: Text

    Returns the server identifier that contains the listed host keys.

  • hostKeys :: [ListedHostKey]

    Returns an array, where each item contains the details of a host key.

Instances

Instances details
Generic ListHostKeysResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Associated Types

type Rep ListHostKeysResponse :: Type -> Type #

Methods

from :: ListHostKeysResponse -> Rep ListHostKeysResponse x #

to :: Rep ListHostKeysResponse x -> ListHostKeysResponse #

Read ListHostKeysResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

readsPrec :: Int -> ReadS ListHostKeysResponse #

readList :: ReadS [ListHostKeysResponse] #

readPrec :: ReadPrec ListHostKeysResponse #

readListPrec :: ReadPrec [ListHostKeysResponse] #

Show ListHostKeysResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

showsPrec :: Int -> ListHostKeysResponse -> ShowS #

show :: ListHostKeysResponse -> String #

showList :: [ListHostKeysResponse] -> ShowS #

NFData ListHostKeysResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

rnf :: ListHostKeysResponse -> () #

Eq ListHostKeysResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

(==) :: ListHostKeysResponse -> ListHostKeysResponse -> Bool #

(/=) :: ListHostKeysResponse -> ListHostKeysResponse -> Bool #

type Rep ListHostKeysResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

type Rep ListHostKeysResponse = D1 ('MetaData "ListHostKeysResponse" "Amazonka.Transfer.ListHostKeys" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListHostKeysResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "hostKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedHostKey]))))

newListHostKeysResponse Source #

Arguments

:: Int

$sel:httpStatus:ListHostKeysResponse'

-> Text

ListHostKeys

-> ListHostKeysResponse 

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

ListHostKeys, listHostKeysResponse_nextToken - Returns a token that you can use to call ListHostKeys again and receive additional results, if there are any.

$sel:httpStatus:ListHostKeysResponse', listHostKeysResponse_httpStatus - The response's http status code.

ListHostKeys, listHostKeysResponse_serverId - Returns the server identifier that contains the listed host keys.

$sel:hostKeys:ListHostKeysResponse', listHostKeysResponse_hostKeys - Returns an array, where each item contains the details of a host key.

Response Lenses

listHostKeysResponse_nextToken :: Lens' ListHostKeysResponse (Maybe Text) Source #

Returns a token that you can use to call ListHostKeys again and receive additional results, if there are any.

listHostKeysResponse_httpStatus :: Lens' ListHostKeysResponse Int Source #

The response's http status code.

listHostKeysResponse_serverId :: Lens' ListHostKeysResponse Text Source #

Returns the server identifier that contains the listed host keys.

listHostKeysResponse_hostKeys :: Lens' ListHostKeysResponse [ListedHostKey] Source #

Returns an array, where each item contains the details of a host key.