DescribeServerCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { TransferClient, DescribeServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import
// const { TransferClient, DescribeServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
const client = new TransferClient(config);
const input = { // DescribeServerRequest
  ServerId: "STRING_VALUE", // required
};
const command = new DescribeServerCommand(input);
const response = await client.send(command);
// { // DescribeServerResponse
//   Server: { // DescribedServer
//     Arn: "STRING_VALUE", // required
//     Certificate: "STRING_VALUE",
//     ProtocolDetails: { // ProtocolDetails
//       PassiveIp: "STRING_VALUE",
//       TlsSessionResumptionMode: "DISABLED" || "ENABLED" || "ENFORCED",
//       SetStatOption: "DEFAULT" || "ENABLE_NO_OP",
//       As2Transports: [ // As2Transports
//         "HTTP",
//       ],
//     },
//     Domain: "S3" || "EFS",
//     EndpointDetails: { // EndpointDetails
//       AddressAllocationIds: [ // AddressAllocationIds
//         "STRING_VALUE",
//       ],
//       SubnetIds: [ // SubnetIds
//         "STRING_VALUE",
//       ],
//       VpcEndpointId: "STRING_VALUE",
//       VpcId: "STRING_VALUE",
//       SecurityGroupIds: [ // SecurityGroupIds
//         "STRING_VALUE",
//       ],
//     },
//     EndpointType: "PUBLIC" || "VPC" || "VPC_ENDPOINT",
//     HostKeyFingerprint: "STRING_VALUE",
//     IdentityProviderDetails: { // IdentityProviderDetails
//       Url: "STRING_VALUE",
//       InvocationRole: "STRING_VALUE",
//       DirectoryId: "STRING_VALUE",
//       Function: "STRING_VALUE",
//       SftpAuthenticationMethods: "PASSWORD" || "PUBLIC_KEY" || "PUBLIC_KEY_OR_PASSWORD" || "PUBLIC_KEY_AND_PASSWORD",
//     },
//     IdentityProviderType: "SERVICE_MANAGED" || "API_GATEWAY" || "AWS_DIRECTORY_SERVICE" || "AWS_LAMBDA",
//     LoggingRole: "STRING_VALUE",
//     PostAuthenticationLoginBanner: "STRING_VALUE",
//     PreAuthenticationLoginBanner: "STRING_VALUE",
//     Protocols: [ // Protocols
//       "SFTP" || "FTP" || "FTPS" || "AS2",
//     ],
//     SecurityPolicyName: "STRING_VALUE",
//     ServerId: "STRING_VALUE",
//     State: "OFFLINE" || "ONLINE" || "STARTING" || "STOPPING" || "START_FAILED" || "STOP_FAILED",
//     Tags: [ // Tags
//       { // Tag
//         Key: "STRING_VALUE", // required
//         Value: "STRING_VALUE", // required
//       },
//     ],
//     UserCount: Number("int"),
//     WorkflowDetails: { // WorkflowDetails
//       OnUpload: [ // OnUploadWorkflowDetails
//         { // WorkflowDetail
//           WorkflowId: "STRING_VALUE", // required
//           ExecutionRole: "STRING_VALUE", // required
//         },
//       ],
//       OnPartialUpload: [ // OnPartialUploadWorkflowDetails
//         {
//           WorkflowId: "STRING_VALUE", // required
//           ExecutionRole: "STRING_VALUE", // required
//         },
//       ],
//     },
//     StructuredLogDestinations: [ // StructuredLogDestinations
//       "STRING_VALUE",
//     ],
//     S3StorageOptions: { // S3StorageOptions
//       DirectoryListingOptimization: "ENABLED" || "DISABLED",
//     },
//     As2ServiceManagedEgressIpAddresses: [ // ServiceManagedEgressIpAddresses
//       "STRING_VALUE",
//     ],
//   },
// };

DescribeServerCommand Input

See DescribeServerCommandInput for more details

Parameter
Type
Description
ServerId
Required
string | undefined

A system-assigned unique identifier for a server.

DescribeServerCommand Output

See DescribeServerCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Server
Required
DescribedServer | undefined

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

Throws

Name
Fault
Details
InternalServiceError
server

This exception is thrown when an error occurs in the Transfer Family service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

ResourceNotFoundException
client

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

ServiceUnavailableException
server

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

TransferServiceException
Base exception class for all service exceptions from Transfer service.