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

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.

Synopsis

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
ToJSON DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

ToHeaders DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

ToPath DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

ToQuery DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

AWSRequest DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Associated Types

type AWSResponse DescribeServer #

Generic DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Associated Types

type Rep DescribeServer :: Type -> Type #

Read DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Show DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

NFData DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Methods

rnf :: DescribeServer -> () #

Eq DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Hashable DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

type AWSResponse DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

type Rep DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

type Rep DescribeServer = D1 ('MetaData "DescribeServer" "Amazonka.Transfer.DescribeServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeServer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeServer Source #

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:

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

Instances

Instances details
Generic DescribeServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Associated Types

type Rep DescribeServerResponse :: Type -> Type #

Read DescribeServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Show DescribeServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

NFData DescribeServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Methods

rnf :: DescribeServerResponse -> () #

Eq DescribeServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

type Rep DescribeServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

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

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_server :: Lens' DescribeServerResponse DescribedServer Source #

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