Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transfer.DescribeServer

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

Creating a Request

data DescribeServer Source #

See: newDescribeServer smart constructor.

Constructors

DescribeServer'
Fields serverId :: Text A system-assigned unique identifier for a server.

Instances

Instances details

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

newDescribeServer Source #

Arguments

:: Text	`$sel:serverId:DescribeServer'`
-> DescribeServer

Create a value of DescribeServer 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:serverId:DescribeServer', describeServer_serverId - A system-assigned unique identifier for a server.

Request Lenses

describeServer_serverId :: Lens' DescribeServer Text Source #

A system-assigned unique identifier for a server.

Destructuring the Response

data DescribeServerResponse Source #

See: newDescribeServerResponse smart constructor.

Constructors

DescribeServerResponse'
Fields httpStatus :: Int The response's http status code. server :: DescribedServer An array containing the properties of a server with the `ServerID` you specified.

Instances

Instances details

Eq DescribeServerResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods (==) :: DescribeServerResponse -> DescribeServerResponse -> Bool # (/=) :: DescribeServerResponse -> DescribeServerResponse -> Bool #
Read DescribeServerResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods readsPrec :: Int -> ReadS DescribeServerResponse # readList :: ReadS [DescribeServerResponse] # readPrec :: ReadPrec DescribeServerResponse # readListPrec :: ReadPrec [DescribeServerResponse] #
Show DescribeServerResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods showsPrec :: Int -> DescribeServerResponse -> ShowS # show :: DescribeServerResponse -> String # showList :: [DescribeServerResponse] -> ShowS #
Generic DescribeServerResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Associated Types type Rep DescribeServerResponse :: Type -> Type # Methods from :: DescribeServerResponse -> Rep DescribeServerResponse x # to :: Rep DescribeServerResponse x -> DescribeServerResponse #
NFData DescribeServerResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods rnf :: DescribeServerResponse -> () #
type Rep DescribeServerResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeServer type Rep DescribeServerResponse = D1 ('MetaData "DescribeServerResponse" "Amazonka.Transfer.DescribeServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeServerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "server") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedServer)))

newDescribeServerResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeServerResponse'`
-> DescribedServer	`$sel:server:DescribeServerResponse'`
-> DescribeServerResponse

Create a value of DescribeServerResponse 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:httpStatus:DescribeServerResponse', describeServerResponse_httpStatus - The response's http status code.

$sel:server:DescribeServerResponse', describeServerResponse_server - An array containing the properties of a server with the ServerID you specified.

Response Lenses

describeServerResponse_httpStatus :: Lens' DescribeServerResponse Int Source #

The response's http status code.

describeServerResponse_server :: Lens' DescribeServerResponse DescribedServer Source #

An array containing the properties of a server with the ServerID you specified.