Class DescribeProfileCommandProtected

Retrieve an existing AS2 profile.

Example

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

import { As2Client, DescribeProfileCommand } from "@stedi/sdk-client-as2"; // ES Modules import
// const { As2Client, DescribeProfileCommand } = require("@stedi/sdk-client-as2"); // CommonJS import
const client = new As2Client(config);
const input = { // DescribeProfileInput
  profileName: "STRING_VALUE", // required
};
const command = new DescribeProfileCommand(input);
const response = await client.send(command);
// { // DescribeProfileOutput
//   profileId: "STRING_VALUE", // required
//   as2Id: "STRING_VALUE", // required
//   profileType: "LOCAL" || "PARTNER", // required
//   certificateIds: [ // CertificateIds
//     "STRING_VALUE",
//   ],
//   profileName: "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

DescribeProfileCommandInput

Returns

DescribeProfileCommandOutput

See

• DescribeProfileCommandInput for command's input shape.
• DescribeProfileCommandOutput 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.