Amazonka.Transfer.ListServers

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

This operation returns paginated results.

Creating a Request

data ListServers

See: newListServers smart constructor.

Constructors

ListServers'

Fields

• maxResults :: Maybe Natural

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

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

Instances

ToJSON ListServers

Defined in Amazonka.Transfer.ListServers

Methods

toJSON :: ListServers -> Value

toEncoding :: ListServers -> Encoding

toJSONList :: [ListServers] -> Value

toEncodingList :: [ListServers] -> Encoding

ToHeaders ListServers

Defined in Amazonka.Transfer.ListServers

Methods

toHeaders :: ListServers -> [Header]

ToPath ListServers

Defined in Amazonka.Transfer.ListServers

Methods

toPath :: ListServers -> ByteString

ToQuery ListServers

Defined in Amazonka.Transfer.ListServers

Methods

toQuery :: ListServers -> QueryString

AWSPager ListServers

Defined in Amazonka.Transfer.ListServers

Methods

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

AWSRequest ListServers

Defined in Amazonka.Transfer.ListServers

Associated Types

type AWSResponse ListServers

Methods

request :: (Service -> Service) -> ListServers -> Request ListServers

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

Generic ListServers

Defined in Amazonka.Transfer.ListServers

Associated Types

type Rep ListServers :: Type -> Type

Methods

from :: ListServers -> Rep ListServers x

to :: Rep ListServers x -> ListServers

Read ListServers

Defined in Amazonka.Transfer.ListServers

Methods

readsPrec :: Int -> ReadS ListServers

readList :: ReadS [ListServers]

readPrec :: ReadPrec ListServers

readListPrec :: ReadPrec [ListServers]

Show ListServers

Defined in Amazonka.Transfer.ListServers

Methods

showsPrec :: Int -> ListServers -> ShowS

show :: ListServers -> String

showList :: [ListServers] -> ShowS

NFData ListServers

Defined in Amazonka.Transfer.ListServers

Methods

rnf :: ListServers -> ()

Eq ListServers

Defined in Amazonka.Transfer.ListServers

Methods

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

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

Hashable ListServers

Defined in Amazonka.Transfer.ListServers

Methods

hashWithSalt :: Int -> ListServers -> Int

hash :: ListServers -> Int

type AWSResponse ListServers

Defined in Amazonka.Transfer.ListServers

type AWSResponse ListServers = ListServersResponse

type Rep ListServers

Defined in Amazonka.Transfer.ListServers

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

newListServers :: ListServers

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:maxResults:ListServers', listServers_maxResults - Specifies the number of servers to return as a response to the ListServers query.

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.

Request Lenses

listServers_maxResults :: Lens' ListServers (Maybe Natural)

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

listServers_nextToken :: Lens' ListServers (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.

Destructuring the Response

data ListServersResponse

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

Generic ListServersResponse

Defined in Amazonka.Transfer.ListServers

Associated Types

type Rep ListServersResponse :: Type -> Type

Methods

from :: ListServersResponse -> Rep ListServersResponse x

to :: Rep ListServersResponse x -> ListServersResponse

Read ListServersResponse

Defined in Amazonka.Transfer.ListServers

Methods

readsPrec :: Int -> ReadS ListServersResponse

readList :: ReadS [ListServersResponse]

readPrec :: ReadPrec ListServersResponse

readListPrec :: ReadPrec [ListServersResponse]

Show ListServersResponse

Defined in Amazonka.Transfer.ListServers

Methods

showsPrec :: Int -> ListServersResponse -> ShowS

show :: ListServersResponse -> String

showList :: [ListServersResponse] -> ShowS

NFData ListServersResponse

Defined in Amazonka.Transfer.ListServers

Methods

rnf :: ListServersResponse -> ()

Eq ListServersResponse

Defined in Amazonka.Transfer.ListServers

Methods

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

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

type Rep ListServersResponse

Defined in Amazonka.Transfer.ListServers

type Rep ListServersResponse = D1 ('MetaData "ListServersResponse" "Amazonka.Transfer.ListServers" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" '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

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:

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)

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

The response's http status code.

listServersResponse_servers :: Lens' ListServersResponse [ListedServer]

An array of servers that were listed.