Class DescribeServerCommandProtected

Retrieve an existing AS2 server.

Example

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

import { As2Client, DescribeServerCommand } from "@stedi/sdk-client-as2"; // ES Modules import
// const { As2Client, DescribeServerCommand } = require("@stedi/sdk-client-as2"); // CommonJS import
const client = new As2Client(config);
const input = { // DescribeServerInput
  serverName: "STRING_VALUE", // required
};
const command = new DescribeServerCommand(input);
const response = await client.send(command);
// { // DescribeServerOutput
//   serverId: "STRING_VALUE", // required
//   serverName: "STRING_VALUE", // required
//   serverUrl: "STRING_VALUE", // required
//   resourceDetail: { // DescribeResourceDetail
//     status: "AVAILABLE" || "UNDER_CHANGE" || "CHANGE_FAILED" || "ERROR" || "CREATE_FAILED", // required
//     detailedStatus: "AVAILABLE_UPDATE_FAILED" || "UPDATE_FAILED" || "DELETE_FAILED",
//     statusMessage: "STRING_VALUE",
//     idempotencyKey: "STRING_VALUE", // required
//     createdAt: new Date("TIMESTAMP"), // required
//     updatedAt: new Date("TIMESTAMP"), // required
//   },
// };

Param

DescribeServerCommandInput

Returns

DescribeServerCommandOutput

See

• DescribeServerCommandInput for command's input shape.
• DescribeServerCommandOutput for command's response shape.
• config for As2Client's config shape.

Throws

TooManyRequestsException (client fault)

Throws

ValidationException (client fault)

Throws

AccessDeniedException (client fault)

Throws

ProductUnavailableException (client fault)

Throws

ResourceAlreadyExistsException (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

ResourceUnderChangeException (client fault)

Throws

ServiceException (server fault)

Throws

As2ServiceException

Base exception class for all service exceptions from As2 service.