Class CreateAgreementCommandProtected

Create an AS2 agreement.

Example

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

import { As2Client, CreateAgreementCommand } from "@stedi/sdk-client-as2"; // ES Modules import
// const { As2Client, CreateAgreementCommand } = require("@stedi/sdk-client-as2"); // CommonJS import
const client = new As2Client(config);
const input = { // CreateAgreementInput
  idempotencyKey: "STRING_VALUE",
  serverId: "STRING_VALUE", // required
  localProfileId: "STRING_VALUE", // required
  partnerProfileId: "STRING_VALUE", // required
  baseDirectory: "STRING_VALUE", // required
  status: "ACTIVE" || "INACTIVE", // required
  description: "STRING_VALUE",
  agreementName: "STRING_VALUE", // required
};
const command = new CreateAgreementCommand(input);
const response = await client.send(command);
// { // CreateAgreementOutput
//   agreementName: "STRING_VALUE", // required
//   resourceDetail: { // CreateResourceDetail
//     idempotencyKey: "STRING_VALUE", // required
//   },
// };

Param

CreateAgreementCommandInput

Returns

CreateAgreementCommandOutput

See

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