libZSservicesZSamazonka-transferZSamazonka-transfer
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Transfer.ListServers

Description

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

This operation returns paginated results.

Synopsis

Creating a Request

data ListServers Source #

See: newListServers smart constructor.

Constructors

ListServers' 

Fields

  • nextToken :: Maybe Text

    When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

  • maxResults :: Maybe Natural

    Specifies the number of servers to return as a response to the ListServers query.

Instances

Instances details
Eq ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

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

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

Read ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

readsPrec :: Int -> ReadS ListServers #

readList :: ReadS [ListServers] #

readPrec :: ReadPrec ListServers #

readListPrec :: ReadPrec [ListServers] #

Show ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

showsPrec :: Int -> ListServers -> ShowS #

show :: ListServers -> String #

showList :: [ListServers] -> ShowS #

Generic ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Associated Types

type Rep ListServers :: Type -> Type #

Methods

from :: ListServers -> Rep ListServers x #

to :: Rep ListServers x -> ListServers #

NFData ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

rnf :: ListServers -> () #

Hashable ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

hashWithSalt :: Int -> ListServers -> Int #

hash :: ListServers -> Int #

ToJSON ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

toJSON :: ListServers -> Value #

toEncoding :: ListServers -> Encoding #

toJSONList :: [ListServers] -> Value #

toEncodingList :: [ListServers] -> Encoding #

AWSPager ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

page :: ListServers -> AWSResponse ListServers -> Maybe ListServers #

AWSRequest ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Associated Types

type AWSResponse ListServers #

Methods

request :: ListServers -> Request ListServers #

response :: MonadResource m => Logger -> Service -> Proxy ListServers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListServers))) #

ToHeaders ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

toHeaders :: ListServers -> [Header] #

ToPath ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

toPath :: ListServers -> ByteString #

ToQuery ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

toQuery :: ListServers -> QueryString #

type Rep ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

type Rep ListServers = D1 ('MetaData "ListServers" "Amazonka.Transfer.ListServers" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListServers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

type AWSResponse ListServers = ListServersResponse

newListServers :: ListServers Source #

Create a value of ListServers 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:nextToken:ListServers', listServers_nextToken - When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

$sel:maxResults:ListServers', listServers_maxResults - Specifies the number of servers to return as a response to the ListServers query.

Request Lenses

listServers_nextToken :: Lens' ListServers (Maybe Text) Source #

When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

listServers_maxResults :: Lens' ListServers (Maybe Natural) Source #

Specifies the number of servers to return as a response to the ListServers query.

Destructuring the Response

data ListServersResponse Source #

See: newListServersResponse smart constructor.

Constructors

ListServersResponse' 

Fields

  • nextToken :: Maybe Text

    When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.

  • httpStatus :: Int

    The response's http status code.

  • servers :: [ListedServer]

    An array of servers that were listed.

Instances

Instances details
Eq ListServersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

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

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

Read ListServersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

readsPrec :: Int -> ReadS ListServersResponse #

readList :: ReadS [ListServersResponse] #

readPrec :: ReadPrec ListServersResponse #

readListPrec :: ReadPrec [ListServersResponse] #

Show ListServersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

showsPrec :: Int -> ListServersResponse -> ShowS #

show :: ListServersResponse -> String #

showList :: [ListServersResponse] -> ShowS #

Generic ListServersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Associated Types

type Rep ListServersResponse :: Type -> Type #

Methods

from :: ListServersResponse -> Rep ListServersResponse x #

to :: Rep ListServersResponse x -> ListServersResponse #

NFData ListServersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

rnf :: ListServersResponse -> () #

type Rep ListServersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

type Rep ListServersResponse = D1 ('MetaData "ListServersResponse" "Amazonka.Transfer.ListServers" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListServersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "servers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedServer]))))

newListServersResponse Source #

Arguments

:: Int

$sel:httpStatus:ListServersResponse'

-> ListServersResponse 

Create a value of ListServersResponse 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:nextToken:ListServers', listServersResponse_nextToken - When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.

$sel:httpStatus:ListServersResponse', listServersResponse_httpStatus - The response's http status code.

$sel:servers:ListServersResponse', listServersResponse_servers - An array of servers that were listed.

Response Lenses

listServersResponse_nextToken :: Lens' ListServersResponse (Maybe Text) Source #

When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.

listServersResponse_httpStatus :: Lens' ListServersResponse Int Source #

The response's http status code.

listServersResponse_servers :: Lens' ListServersResponse [ListedServer] Source #

An array of servers that were listed.