Amazonka.Transfer.DescribeServer

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

See: newDescribeServer smart constructor.

Constructors

DescribeServer'

Fields

• serverId :: Text

  A system-assigned unique identifier for a server.

Instances

ToJSON DescribeServer

Defined in Amazonka.Transfer.DescribeServer

Methods

toJSON :: DescribeServer -> Value

toEncoding :: DescribeServer -> Encoding

toJSONList :: [DescribeServer] -> Value

toEncodingList :: [DescribeServer] -> Encoding

ToHeaders DescribeServer

Defined in Amazonka.Transfer.DescribeServer

Methods

toHeaders :: DescribeServer -> [Header]

ToPath DescribeServer

Defined in Amazonka.Transfer.DescribeServer

Methods

toPath :: DescribeServer -> ByteString

ToQuery DescribeServer

Defined in Amazonka.Transfer.DescribeServer

Methods

toQuery :: DescribeServer -> QueryString

AWSRequest DescribeServer

Defined in Amazonka.Transfer.DescribeServer

Associated Types

type AWSResponse DescribeServer

Methods

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

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

Generic DescribeServer

Defined in Amazonka.Transfer.DescribeServer

Associated Types

type Rep DescribeServer :: Type -> Type

Methods

from :: DescribeServer -> Rep DescribeServer x

to :: Rep DescribeServer x -> DescribeServer

Read DescribeServer

Defined in Amazonka.Transfer.DescribeServer

Methods

readsPrec :: Int -> ReadS DescribeServer

readList :: ReadS [DescribeServer]

readPrec :: ReadPrec DescribeServer

readListPrec :: ReadPrec [DescribeServer]

Show DescribeServer

Defined in Amazonka.Transfer.DescribeServer

Methods

showsPrec :: Int -> DescribeServer -> ShowS

show :: DescribeServer -> String

showList :: [DescribeServer] -> ShowS

NFData DescribeServer

Defined in Amazonka.Transfer.DescribeServer

Methods

rnf :: DescribeServer -> ()

Eq DescribeServer

Defined in Amazonka.Transfer.DescribeServer

Methods

(==) :: DescribeServer -> DescribeServer -> Bool

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

Hashable DescribeServer

Defined in Amazonka.Transfer.DescribeServer

Methods

hashWithSalt :: Int -> DescribeServer -> Int

hash :: DescribeServer -> Int

type AWSResponse DescribeServer

Defined in Amazonka.Transfer.DescribeServer

type AWSResponse DescribeServer = DescribeServerResponse

type Rep DescribeServer

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

Arguments

:: Text

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:

DescribeServer, describeServer_serverId - A system-assigned unique identifier for a server.

Request Lenses

describeServer_serverId :: Lens' DescribeServer Text

A system-assigned unique identifier for a server.

Destructuring the Response

data DescribeServerResponse

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

Generic DescribeServerResponse

Defined in Amazonka.Transfer.DescribeServer

Associated Types

type Rep DescribeServerResponse :: Type -> Type

Methods

from :: DescribeServerResponse -> Rep DescribeServerResponse x

to :: Rep DescribeServerResponse x -> DescribeServerResponse

Read DescribeServerResponse

Defined in Amazonka.Transfer.DescribeServer

Methods

readsPrec :: Int -> ReadS DescribeServerResponse

readList :: ReadS [DescribeServerResponse]

readPrec :: ReadPrec DescribeServerResponse

readListPrec :: ReadPrec [DescribeServerResponse]

Show DescribeServerResponse

Defined in Amazonka.Transfer.DescribeServer

Methods

showsPrec :: Int -> DescribeServerResponse -> ShowS

show :: DescribeServerResponse -> String

showList :: [DescribeServerResponse] -> ShowS

NFData DescribeServerResponse

Defined in Amazonka.Transfer.DescribeServer

Methods

rnf :: DescribeServerResponse -> ()

Eq DescribeServerResponse

Defined in Amazonka.Transfer.DescribeServer

Methods

(==) :: DescribeServerResponse -> DescribeServerResponse -> Bool

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

type Rep DescribeServerResponse

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

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

The response's http status code.

describeServerResponse_server :: Lens' DescribeServerResponse DescribedServer

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