Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.
+ *If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template. + * The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it + * into the JSON or XML file that is used to generate the EDI.
+ *If you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the templateDetails
parameter.
+ *
Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { B2biClient, CreateStarterMappingTemplateCommand } from "@aws-sdk/client-b2bi"; // ES Modules import + * // const { B2biClient, CreateStarterMappingTemplateCommand } = require("@aws-sdk/client-b2bi"); // CommonJS import + * const client = new B2biClient(config); + * const input = { // CreateStarterMappingTemplateRequest + * outputSampleLocation: { // S3Location + * bucketName: "STRING_VALUE", + * key: "STRING_VALUE", + * }, + * mappingType: "JSONATA" || "XSLT", // required + * templateDetails: { // TemplateDetails Union: only one key present + * x12: { // X12Details + * transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", + * version: "VERSION_4010" || "VERSION_4030" || "VERSION_5010" || "VERSION_5010_HIPAA", + * }, + * }, + * }; + * const command = new CreateStarterMappingTemplateCommand(input); + * const response = await client.send(command); + * // { // CreateStarterMappingTemplateResponse + * // mappingTemplate: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param CreateStarterMappingTemplateCommandInput - {@link CreateStarterMappingTemplateCommandInput} + * @returns {@link CreateStarterMappingTemplateCommandOutput} + * @see {@link CreateStarterMappingTemplateCommandInput} for command's `input` shape. + * @see {@link CreateStarterMappingTemplateCommandOutput} for command's `response` shape. + * @see {@link B2biClientResolvedConfig | config} for B2biClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
+ * + * @throws {@link ValidationException} (client fault) + *Occurs when a B2BI object cannot be validated against a request from another object.
+ * + * @throws {@link B2biServiceException} + *Base exception class for all service exceptions from B2bi service.
+ * + * @public + */ +export class CreateStarterMappingTemplateCommand extends $Command + .classBuilder< + CreateStarterMappingTemplateCommandInput, + CreateStarterMappingTemplateCommandOutput, + B2biClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: B2biClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("B2BI", "CreateStarterMappingTemplate", {}) + .n("B2biClient", "CreateStarterMappingTemplateCommand") + .f(void 0, void 0) + .ser(se_CreateStarterMappingTemplateCommand) + .de(de_CreateStarterMappingTemplateCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateStarterMappingTemplateRequest; + output: CreateStarterMappingTemplateResponse; + }; + sdk: { + input: CreateStarterMappingTemplateCommandInput; + output: CreateStarterMappingTemplateCommandOutput; + }; + }; +} diff --git a/clients/client-b2bi/src/commands/CreateTransformerCommand.ts b/clients/client-b2bi/src/commands/CreateTransformerCommand.ts index 4f802fa428b9..1f6727cd360d 100644 --- a/clients/client-b2bi/src/commands/CreateTransformerCommand.ts +++ b/clients/client-b2bi/src/commands/CreateTransformerCommand.ts @@ -28,9 +28,39 @@ export interface CreateTransformerCommandInput extends CreateTransformerRequest export interface CreateTransformerCommandOutput extends CreateTransformerResponse, __MetadataBearer {} /** - *Creates a transformer. A transformer - * describes how to process the incoming EDI documents and extract the necessary - * information to the output file.
+ *Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:
+ *+ * Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange + * converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, + * in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
+ *+ * Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use + * in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate + * a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.
+ *The following fields are provided for backwards compatibility only: fileFormat
,
+ * mappingTemplate
, ediType
, and sampleDocument
.
Use the mapping
data type in place of mappingTemplate
and fileFormat
+ *
Use the sampleDocuments
data type in place of sampleDocument
+ *
Use either the inputConversion
or outputConversion
in place of ediType
+ *
Deletes the specified transformer. A transformer - * describes how to process the incoming EDI documents and extract the necessary - * information to the output file.
+ *Deletes the specified transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, + * a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-b2bi/src/commands/GetCapabilityCommand.ts b/clients/client-b2bi/src/commands/GetCapabilityCommand.ts index 67d636008a51..e5eed0d23e48 100644 --- a/clients/client-b2bi/src/commands/GetCapabilityCommand.ts +++ b/clients/client-b2bi/src/commands/GetCapabilityCommand.ts @@ -47,6 +47,7 @@ export interface GetCapabilityCommandOutput extends GetCapabilityResponse, __Met * // type: "edi", // required * // configuration: { // CapabilityConfiguration Union: only one key present * // edi: { // EdiConfiguration + * // capabilityDirection: "INBOUND" || "OUTBOUND", * // type: { // EdiType Union: only one key present * // x12Details: { // X12Details * // transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", diff --git a/clients/client-b2bi/src/commands/GetPartnershipCommand.ts b/clients/client-b2bi/src/commands/GetPartnershipCommand.ts index 1ef958305855..17c11d021d68 100644 --- a/clients/client-b2bi/src/commands/GetPartnershipCommand.ts +++ b/clients/client-b2bi/src/commands/GetPartnershipCommand.ts @@ -55,6 +55,34 @@ export interface GetPartnershipCommandOutput extends GetPartnershipResponse, __M * // capabilities: [ // PartnershipCapabilities * // "STRING_VALUE", * // ], + * // capabilityOptions: { // CapabilityOptions + * // outboundEdi: { // OutboundEdiOptions Union: only one key present + * // x12: { // X12Envelope + * // common: { // X12OutboundEdiHeaders + * // interchangeControlHeaders: { // X12InterchangeControlHeaders + * // senderIdQualifier: "STRING_VALUE", + * // senderId: "STRING_VALUE", + * // receiverIdQualifier: "STRING_VALUE", + * // receiverId: "STRING_VALUE", + * // repetitionSeparator: "STRING_VALUE", + * // acknowledgmentRequestedCode: "STRING_VALUE", + * // usageIndicatorCode: "STRING_VALUE", + * // }, + * // functionalGroupHeaders: { // X12FunctionalGroupHeaders + * // applicationSenderCode: "STRING_VALUE", + * // applicationReceiverCode: "STRING_VALUE", + * // responsibleAgencyCode: "STRING_VALUE", + * // }, + * // delimiters: { // X12Delimiters + * // componentSeparator: "STRING_VALUE", + * // dataElementSeparator: "STRING_VALUE", + * // segmentTerminator: "STRING_VALUE", + * // }, + * // validateEdi: true || false, + * // }, + * // }, + * // }, + * // }, * // tradingPartnerId: "STRING_VALUE", * // createdAt: new Date("TIMESTAMP"), // required * // modifiedAt: new Date("TIMESTAMP"), diff --git a/clients/client-b2bi/src/commands/GetTransformerCommand.ts b/clients/client-b2bi/src/commands/GetTransformerCommand.ts index 1d8bc1ac446d..f113f59c7b61 100644 --- a/clients/client-b2bi/src/commands/GetTransformerCommand.ts +++ b/clients/client-b2bi/src/commands/GetTransformerCommand.ts @@ -28,9 +28,8 @@ export interface GetTransformerCommandInput extends GetTransformerRequest {} export interface GetTransformerCommandOutput extends GetTransformerResponse, __MetadataBearer {} /** - *Retrieves the details for the transformer specified by the transformer ID. A transformer - * describes how to process the incoming EDI documents and extract the necessary - * information to the output file.
+ *Retrieves the details for the transformer specified by the transformer ID. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, + * a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -46,9 +45,11 @@ export interface GetTransformerCommandOutput extends GetTransformerResponse, __M * // transformerId: "STRING_VALUE", // required * // transformerArn: "STRING_VALUE", // required * // name: "STRING_VALUE", // required - * // fileFormat: "XML" || "JSON", // required - * // mappingTemplate: "STRING_VALUE", // required * // status: "active" || "inactive", // required + * // createdAt: new Date("TIMESTAMP"), // required + * // modifiedAt: new Date("TIMESTAMP"), + * // fileFormat: "XML" || "JSON" || "NOT_USED", + * // mappingTemplate: "STRING_VALUE", * // ediType: { // EdiType Union: only one key present * // x12Details: { // X12Details * // transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", @@ -56,8 +57,37 @@ export interface GetTransformerCommandOutput extends GetTransformerResponse, __M * // }, * // }, * // sampleDocument: "STRING_VALUE", - * // createdAt: new Date("TIMESTAMP"), // required - * // modifiedAt: new Date("TIMESTAMP"), + * // inputConversion: { // InputConversion + * // fromFormat: "X12", // required + * // formatOptions: { // FormatOptions Union: only one key present + * // x12: { + * // transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", + * // version: "VERSION_4010" || "VERSION_4030" || "VERSION_5010" || "VERSION_5010_HIPAA", + * // }, + * // }, + * // }, + * // mapping: { // Mapping + * // templateLanguage: "XSLT" || "JSONATA", // required + * // template: "STRING_VALUE", + * // }, + * // outputConversion: { // OutputConversion + * // toFormat: "X12", // required + * // formatOptions: {// Union: only one key present + * // x12: { + * // transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", + * // version: "VERSION_4010" || "VERSION_4030" || "VERSION_5010" || "VERSION_5010_HIPAA", + * // }, + * // }, + * // }, + * // sampleDocuments: { // SampleDocuments + * // bucketName: "STRING_VALUE", // required + * // keys: [ // KeyList // required + * // { // SampleDocumentKeys + * // input: "STRING_VALUE", + * // output: "STRING_VALUE", + * // }, + * // ], + * // }, * // }; * * ``` diff --git a/clients/client-b2bi/src/commands/ListPartnershipsCommand.ts b/clients/client-b2bi/src/commands/ListPartnershipsCommand.ts index e2071df2211c..9b51da2769b2 100644 --- a/clients/client-b2bi/src/commands/ListPartnershipsCommand.ts +++ b/clients/client-b2bi/src/commands/ListPartnershipsCommand.ts @@ -52,6 +52,34 @@ export interface ListPartnershipsCommandOutput extends ListPartnershipsResponse, * // capabilities: [ // PartnershipCapabilities * // "STRING_VALUE", * // ], + * // capabilityOptions: { // CapabilityOptions + * // outboundEdi: { // OutboundEdiOptions Union: only one key present + * // x12: { // X12Envelope + * // common: { // X12OutboundEdiHeaders + * // interchangeControlHeaders: { // X12InterchangeControlHeaders + * // senderIdQualifier: "STRING_VALUE", + * // senderId: "STRING_VALUE", + * // receiverIdQualifier: "STRING_VALUE", + * // receiverId: "STRING_VALUE", + * // repetitionSeparator: "STRING_VALUE", + * // acknowledgmentRequestedCode: "STRING_VALUE", + * // usageIndicatorCode: "STRING_VALUE", + * // }, + * // functionalGroupHeaders: { // X12FunctionalGroupHeaders + * // applicationSenderCode: "STRING_VALUE", + * // applicationReceiverCode: "STRING_VALUE", + * // responsibleAgencyCode: "STRING_VALUE", + * // }, + * // delimiters: { // X12Delimiters + * // componentSeparator: "STRING_VALUE", + * // dataElementSeparator: "STRING_VALUE", + * // segmentTerminator: "STRING_VALUE", + * // }, + * // validateEdi: true || false, + * // }, + * // }, + * // }, + * // }, * // tradingPartnerId: "STRING_VALUE", * // createdAt: new Date("TIMESTAMP"), // required * // modifiedAt: new Date("TIMESTAMP"), diff --git a/clients/client-b2bi/src/commands/ListTransformersCommand.ts b/clients/client-b2bi/src/commands/ListTransformersCommand.ts index ab4f6168f4b0..2404f3316f9f 100644 --- a/clients/client-b2bi/src/commands/ListTransformersCommand.ts +++ b/clients/client-b2bi/src/commands/ListTransformersCommand.ts @@ -28,9 +28,8 @@ export interface ListTransformersCommandInput extends ListTransformersRequest {} export interface ListTransformersCommandOutput extends ListTransformersResponse, __MetadataBearer {} /** - *Lists the available transformers. A transformer - * describes how to process the incoming EDI documents and extract the necessary - * information to the output file.
+ *Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, + * a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -48,9 +47,11 @@ export interface ListTransformersCommandOutput extends ListTransformersResponse, * // { // TransformerSummary * // transformerId: "STRING_VALUE", // required * // name: "STRING_VALUE", // required - * // fileFormat: "XML" || "JSON", // required - * // mappingTemplate: "STRING_VALUE", // required * // status: "active" || "inactive", // required + * // createdAt: new Date("TIMESTAMP"), // required + * // modifiedAt: new Date("TIMESTAMP"), + * // fileFormat: "XML" || "JSON" || "NOT_USED", + * // mappingTemplate: "STRING_VALUE", * // ediType: { // EdiType Union: only one key present * // x12Details: { // X12Details * // transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", @@ -58,8 +59,37 @@ export interface ListTransformersCommandOutput extends ListTransformersResponse, * // }, * // }, * // sampleDocument: "STRING_VALUE", - * // createdAt: new Date("TIMESTAMP"), // required - * // modifiedAt: new Date("TIMESTAMP"), + * // inputConversion: { // InputConversion + * // fromFormat: "X12", // required + * // formatOptions: { // FormatOptions Union: only one key present + * // x12: { + * // transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", + * // version: "VERSION_4010" || "VERSION_4030" || "VERSION_5010" || "VERSION_5010_HIPAA", + * // }, + * // }, + * // }, + * // mapping: { // Mapping + * // templateLanguage: "XSLT" || "JSONATA", // required + * // template: "STRING_VALUE", + * // }, + * // outputConversion: { // OutputConversion + * // toFormat: "X12", // required + * // formatOptions: {// Union: only one key present + * // x12: { + * // transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", + * // version: "VERSION_4010" || "VERSION_4030" || "VERSION_5010" || "VERSION_5010_HIPAA", + * // }, + * // }, + * // }, + * // sampleDocuments: { // SampleDocuments + * // bucketName: "STRING_VALUE", // required + * // keys: [ // KeyList // required + * // { // SampleDocumentKeys + * // input: "STRING_VALUE", + * // output: "STRING_VALUE", + * // }, + * // ], + * // }, * // }, * // ], * // nextToken: "STRING_VALUE", diff --git a/clients/client-b2bi/src/commands/StartTransformerJobCommand.ts b/clients/client-b2bi/src/commands/StartTransformerJobCommand.ts index ea27fcba1917..317858f27809 100644 --- a/clients/client-b2bi/src/commands/StartTransformerJobCommand.ts +++ b/clients/client-b2bi/src/commands/StartTransformerJobCommand.ts @@ -28,7 +28,7 @@ export interface StartTransformerJobCommandInput extends StartTransformerJobRequ export interface StartTransformerJobCommandOutput extends StartTransformerJobResponse, __MetadataBearer {} /** - *Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2BI Data Interchange.
+ *Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.
*If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just
* create and configure a transformer, and then run the StartTransformerJob
API to process your files.
This operation mimics the latter half of a typical Outbound EDI request. It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI string, and return that string.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { B2biClient, TestConversionCommand } from "@aws-sdk/client-b2bi"; // ES Modules import + * // const { B2biClient, TestConversionCommand } = require("@aws-sdk/client-b2bi"); // CommonJS import + * const client = new B2biClient(config); + * const input = { // TestConversionRequest + * source: { // ConversionSource + * fileFormat: "JSON" || "XML", // required + * inputFile: { // InputFileSource Union: only one key present + * fileContent: "STRING_VALUE", + * }, + * }, + * target: { // ConversionTarget + * fileFormat: "X12", // required + * formatDetails: { // ConversionTargetFormatDetails Union: only one key present + * x12: { // X12Details + * transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", + * version: "VERSION_4010" || "VERSION_4030" || "VERSION_5010" || "VERSION_5010_HIPAA", + * }, + * }, + * outputSampleFile: { // OutputSampleFileSource Union: only one key present + * fileLocation: { // S3Location + * bucketName: "STRING_VALUE", + * key: "STRING_VALUE", + * }, + * }, + * }, + * }; + * const command = new TestConversionCommand(input); + * const response = await client.send(command); + * // { // TestConversionResponse + * // convertedFileContent: "STRING_VALUE", // required + * // validationMessages: [ // ValidationMessages + * // "STRING_VALUE", + * // ], + * // }; + * + * ``` + * + * @param TestConversionCommandInput - {@link TestConversionCommandInput} + * @returns {@link TestConversionCommandOutput} + * @see {@link TestConversionCommandInput} for command's `input` shape. + * @see {@link TestConversionCommandOutput} for command's `response` shape. + * @see {@link B2biClientResolvedConfig | config} for B2biClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
+ * + * @throws {@link ValidationException} (client fault) + *Occurs when a B2BI object cannot be validated against a request from another object.
+ * + * @throws {@link B2biServiceException} + *Base exception class for all service exceptions from B2bi service.
+ * + * @public + */ +export class TestConversionCommand extends $Command + .classBuilder< + TestConversionCommandInput, + TestConversionCommandOutput, + B2biClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: B2biClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("B2BI", "TestConversion", {}) + .n("B2biClient", "TestConversionCommand") + .f(void 0, void 0) + .ser(se_TestConversionCommand) + .de(de_TestConversionCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: TestConversionRequest; + output: TestConversionResponse; + }; + sdk: { + input: TestConversionCommandInput; + output: TestConversionCommandOutput; + }; + }; +} diff --git a/clients/client-b2bi/src/commands/TestMappingCommand.ts b/clients/client-b2bi/src/commands/TestMappingCommand.ts index 58da404c4fac..a5b4dfb4dbb3 100644 --- a/clients/client-b2bi/src/commands/TestMappingCommand.ts +++ b/clients/client-b2bi/src/commands/TestMappingCommand.ts @@ -38,7 +38,7 @@ export interface TestMappingCommandOutput extends TestMappingResponse, __Metadat * const input = { // TestMappingRequest * inputFileContent: "STRING_VALUE", // required * mappingTemplate: "STRING_VALUE", // required - * fileFormat: "XML" || "JSON", // required + * fileFormat: "XML" || "JSON" || "NOT_USED", // required * }; * const command = new TestMappingCommand(input); * const response = await client.send(command); diff --git a/clients/client-b2bi/src/commands/TestParsingCommand.ts b/clients/client-b2bi/src/commands/TestParsingCommand.ts index 9a0356e5a152..42e7e015e89b 100644 --- a/clients/client-b2bi/src/commands/TestParsingCommand.ts +++ b/clients/client-b2bi/src/commands/TestParsingCommand.ts @@ -40,7 +40,7 @@ export interface TestParsingCommandOutput extends TestParsingResponse, __Metadat * bucketName: "STRING_VALUE", * key: "STRING_VALUE", * }, - * fileFormat: "XML" || "JSON", // required + * fileFormat: "XML" || "JSON" || "NOT_USED", // required * ediType: { // EdiType Union: only one key present * x12Details: { // X12Details * transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", diff --git a/clients/client-b2bi/src/commands/UpdateCapabilityCommand.ts b/clients/client-b2bi/src/commands/UpdateCapabilityCommand.ts index db65d5c707ee..622bd9dbd3ff 100644 --- a/clients/client-b2bi/src/commands/UpdateCapabilityCommand.ts +++ b/clients/client-b2bi/src/commands/UpdateCapabilityCommand.ts @@ -41,6 +41,7 @@ export interface UpdateCapabilityCommandOutput extends UpdateCapabilityResponse, * name: "STRING_VALUE", * configuration: { // CapabilityConfiguration Union: only one key present * edi: { // EdiConfiguration + * capabilityDirection: "INBOUND" || "OUTBOUND", * type: { // EdiType Union: only one key present * x12Details: { // X12Details * transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", @@ -74,6 +75,7 @@ export interface UpdateCapabilityCommandOutput extends UpdateCapabilityResponse, * // type: "edi", // required * // configuration: { // CapabilityConfiguration Union: only one key present * // edi: { // EdiConfiguration + * // capabilityDirection: "INBOUND" || "OUTBOUND", * // type: { // EdiType Union: only one key present * // x12Details: { // X12Details * // transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", diff --git a/clients/client-b2bi/src/commands/UpdatePartnershipCommand.ts b/clients/client-b2bi/src/commands/UpdatePartnershipCommand.ts index 70eece7e57a0..ef6ad4a7ceed 100644 --- a/clients/client-b2bi/src/commands/UpdatePartnershipCommand.ts +++ b/clients/client-b2bi/src/commands/UpdatePartnershipCommand.ts @@ -46,6 +46,34 @@ export interface UpdatePartnershipCommandOutput extends UpdatePartnershipRespons * capabilities: [ // PartnershipCapabilities * "STRING_VALUE", * ], + * capabilityOptions: { // CapabilityOptions + * outboundEdi: { // OutboundEdiOptions Union: only one key present + * x12: { // X12Envelope + * common: { // X12OutboundEdiHeaders + * interchangeControlHeaders: { // X12InterchangeControlHeaders + * senderIdQualifier: "STRING_VALUE", + * senderId: "STRING_VALUE", + * receiverIdQualifier: "STRING_VALUE", + * receiverId: "STRING_VALUE", + * repetitionSeparator: "STRING_VALUE", + * acknowledgmentRequestedCode: "STRING_VALUE", + * usageIndicatorCode: "STRING_VALUE", + * }, + * functionalGroupHeaders: { // X12FunctionalGroupHeaders + * applicationSenderCode: "STRING_VALUE", + * applicationReceiverCode: "STRING_VALUE", + * responsibleAgencyCode: "STRING_VALUE", + * }, + * delimiters: { // X12Delimiters + * componentSeparator: "STRING_VALUE", + * dataElementSeparator: "STRING_VALUE", + * segmentTerminator: "STRING_VALUE", + * }, + * validateEdi: true || false, + * }, + * }, + * }, + * }, * }; * const command = new UpdatePartnershipCommand(input); * const response = await client.send(command); @@ -59,6 +87,34 @@ export interface UpdatePartnershipCommandOutput extends UpdatePartnershipRespons * // capabilities: [ // PartnershipCapabilities * // "STRING_VALUE", * // ], + * // capabilityOptions: { // CapabilityOptions + * // outboundEdi: { // OutboundEdiOptions Union: only one key present + * // x12: { // X12Envelope + * // common: { // X12OutboundEdiHeaders + * // interchangeControlHeaders: { // X12InterchangeControlHeaders + * // senderIdQualifier: "STRING_VALUE", + * // senderId: "STRING_VALUE", + * // receiverIdQualifier: "STRING_VALUE", + * // receiverId: "STRING_VALUE", + * // repetitionSeparator: "STRING_VALUE", + * // acknowledgmentRequestedCode: "STRING_VALUE", + * // usageIndicatorCode: "STRING_VALUE", + * // }, + * // functionalGroupHeaders: { // X12FunctionalGroupHeaders + * // applicationSenderCode: "STRING_VALUE", + * // applicationReceiverCode: "STRING_VALUE", + * // responsibleAgencyCode: "STRING_VALUE", + * // }, + * // delimiters: { // X12Delimiters + * // componentSeparator: "STRING_VALUE", + * // dataElementSeparator: "STRING_VALUE", + * // segmentTerminator: "STRING_VALUE", + * // }, + * // validateEdi: true || false, + * // }, + * // }, + * // }, + * // }, * // tradingPartnerId: "STRING_VALUE", * // createdAt: new Date("TIMESTAMP"), // required * // modifiedAt: new Date("TIMESTAMP"), diff --git a/clients/client-b2bi/src/commands/UpdateTransformerCommand.ts b/clients/client-b2bi/src/commands/UpdateTransformerCommand.ts index 819c1489c09b..c4d2fd2b533d 100644 --- a/clients/client-b2bi/src/commands/UpdateTransformerCommand.ts +++ b/clients/client-b2bi/src/commands/UpdateTransformerCommand.ts @@ -28,9 +28,8 @@ export interface UpdateTransformerCommandInput extends UpdateTransformerRequest export interface UpdateTransformerCommandOutput extends UpdateTransformerResponse, __MetadataBearer {} /** - *Updates the specified parameters for a transformer. A transformer - * describes how to process the incoming EDI documents and extract the necessary - * information to the output file.
+ *Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, + * a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -40,9 +39,9 @@ export interface UpdateTransformerCommandOutput extends UpdateTransformerRespons * const input = { // UpdateTransformerRequest * transformerId: "STRING_VALUE", // required * name: "STRING_VALUE", - * fileFormat: "XML" || "JSON", - * mappingTemplate: "STRING_VALUE", * status: "active" || "inactive", + * fileFormat: "XML" || "JSON" || "NOT_USED", + * mappingTemplate: "STRING_VALUE", * ediType: { // EdiType Union: only one key present * x12Details: { // X12Details * transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", @@ -50,6 +49,37 @@ export interface UpdateTransformerCommandOutput extends UpdateTransformerRespons * }, * }, * sampleDocument: "STRING_VALUE", + * inputConversion: { // InputConversion + * fromFormat: "X12", // required + * formatOptions: { // FormatOptions Union: only one key present + * x12: { + * transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", + * version: "VERSION_4010" || "VERSION_4030" || "VERSION_5010" || "VERSION_5010_HIPAA", + * }, + * }, + * }, + * mapping: { // Mapping + * templateLanguage: "XSLT" || "JSONATA", // required + * template: "STRING_VALUE", + * }, + * outputConversion: { // OutputConversion + * toFormat: "X12", // required + * formatOptions: {// Union: only one key present + * x12: { + * transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", + * version: "VERSION_4010" || "VERSION_4030" || "VERSION_5010" || "VERSION_5010_HIPAA", + * }, + * }, + * }, + * sampleDocuments: { // SampleDocuments + * bucketName: "STRING_VALUE", // required + * keys: [ // KeyList // required + * { // SampleDocumentKeys + * input: "STRING_VALUE", + * output: "STRING_VALUE", + * }, + * ], + * }, * }; * const command = new UpdateTransformerCommand(input); * const response = await client.send(command); @@ -57,9 +87,11 @@ export interface UpdateTransformerCommandOutput extends UpdateTransformerRespons * // transformerId: "STRING_VALUE", // required * // transformerArn: "STRING_VALUE", // required * // name: "STRING_VALUE", // required - * // fileFormat: "XML" || "JSON", // required - * // mappingTemplate: "STRING_VALUE", // required * // status: "active" || "inactive", // required + * // createdAt: new Date("TIMESTAMP"), // required + * // modifiedAt: new Date("TIMESTAMP"), // required + * // fileFormat: "XML" || "JSON" || "NOT_USED", + * // mappingTemplate: "STRING_VALUE", * // ediType: { // EdiType Union: only one key present * // x12Details: { // X12Details * // transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", @@ -67,8 +99,37 @@ export interface UpdateTransformerCommandOutput extends UpdateTransformerRespons * // }, * // }, * // sampleDocument: "STRING_VALUE", - * // createdAt: new Date("TIMESTAMP"), // required - * // modifiedAt: new Date("TIMESTAMP"), // required + * // inputConversion: { // InputConversion + * // fromFormat: "X12", // required + * // formatOptions: { // FormatOptions Union: only one key present + * // x12: { + * // transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", + * // version: "VERSION_4010" || "VERSION_4030" || "VERSION_5010" || "VERSION_5010_HIPAA", + * // }, + * // }, + * // }, + * // mapping: { // Mapping + * // templateLanguage: "XSLT" || "JSONATA", // required + * // template: "STRING_VALUE", + * // }, + * // outputConversion: { // OutputConversion + * // toFormat: "X12", // required + * // formatOptions: {// Union: only one key present + * // x12: { + * // transactionSet: "X12_110" || "X12_180" || "X12_204" || "X12_210" || "X12_211" || "X12_214" || "X12_215" || "X12_259" || "X12_260" || "X12_266" || "X12_269" || "X12_270" || "X12_271" || "X12_274" || "X12_275" || "X12_276" || "X12_277" || "X12_278" || "X12_310" || "X12_315" || "X12_322" || "X12_404" || "X12_410" || "X12_417" || "X12_421" || "X12_426" || "X12_810" || "X12_820" || "X12_824" || "X12_830" || "X12_832" || "X12_834" || "X12_835" || "X12_837" || "X12_844" || "X12_846" || "X12_849" || "X12_850" || "X12_852" || "X12_855" || "X12_856" || "X12_860" || "X12_861" || "X12_864" || "X12_865" || "X12_869" || "X12_870" || "X12_940" || "X12_945" || "X12_990" || "X12_997" || "X12_999" || "X12_270_X279" || "X12_271_X279" || "X12_275_X210" || "X12_275_X211" || "X12_276_X212" || "X12_277_X212" || "X12_277_X214" || "X12_277_X364" || "X12_278_X217" || "X12_820_X218" || "X12_820_X306" || "X12_824_X186" || "X12_834_X220" || "X12_834_X307" || "X12_834_X318" || "X12_835_X221" || "X12_837_X222" || "X12_837_X223" || "X12_837_X224" || "X12_837_X291" || "X12_837_X292" || "X12_837_X298" || "X12_999_X231", + * // version: "VERSION_4010" || "VERSION_4030" || "VERSION_5010" || "VERSION_5010_HIPAA", + * // }, + * // }, + * // }, + * // sampleDocuments: { // SampleDocuments + * // bucketName: "STRING_VALUE", // required + * // keys: [ // KeyList // required + * // { // SampleDocumentKeys + * // input: "STRING_VALUE", + * // output: "STRING_VALUE", + * // }, + * // ], + * // }, * // }; * * ``` diff --git a/clients/client-b2bi/src/commands/index.ts b/clients/client-b2bi/src/commands/index.ts index 974e161a567a..e21b52225470 100644 --- a/clients/client-b2bi/src/commands/index.ts +++ b/clients/client-b2bi/src/commands/index.ts @@ -2,6 +2,7 @@ export * from "./CreateCapabilityCommand"; export * from "./CreatePartnershipCommand"; export * from "./CreateProfileCommand"; +export * from "./CreateStarterMappingTemplateCommand"; export * from "./CreateTransformerCommand"; export * from "./DeleteCapabilityCommand"; export * from "./DeletePartnershipCommand"; @@ -19,6 +20,7 @@ export * from "./ListTagsForResourceCommand"; export * from "./ListTransformersCommand"; export * from "./StartTransformerJobCommand"; export * from "./TagResourceCommand"; +export * from "./TestConversionCommand"; export * from "./TestMappingCommand"; export * from "./TestParsingCommand"; export * from "./UntagResourceCommand"; diff --git a/clients/client-b2bi/src/models/models_0.ts b/clients/client-b2bi/src/models/models_0.ts index 185b4980d55e..38802e3df5c5 100644 --- a/clients/client-b2bi/src/models/models_0.ts +++ b/clients/client-b2bi/src/models/models_0.ts @@ -44,7 +44,21 @@ export class ConflictException extends __BaseException { } /** - *Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2BI Data Interchange. File + * @public + * @enum + */ +export const CapabilityDirection = { + INBOUND: "INBOUND", + OUTBOUND: "OUTBOUND", +} as const; + +/** + * @public + */ +export type CapabilityDirection = (typeof CapabilityDirection)[keyof typeof CapabilityDirection]; + +/** + *
Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File * locations in Amazon S3 are identified using a combination of the bucket and key.
* @public */ @@ -180,18 +194,16 @@ export interface X12Details { transactionSet?: X12TransactionSet; /** - *Returns the version to use for the specified X12 transaction set. - * - * - * - *
+ *Returns the version to use for the specified X12 transaction set.
* @public */ version?: X12Version; } /** - *Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
+ *Specifies the details for the EDI standard that is being used for the transformer. + * Currently, only X12 is supported. X12 is a set of standards and corresponding messages + * that define specific business documents.
* @public */ export type EdiType = EdiType.X12DetailsMember | EdiType.$UnknownMember; @@ -233,6 +245,12 @@ export namespace EdiType { * @public */ export interface EdiConfiguration { + /** + *Specifies whether this is capability is for inbound or outbound transformations.
+ * @public + */ + capabilityDirection?: CapabilityDirection; + /** *Returns the type of the capability. Currently, only edi
is supported.
A data structure that contains the information to use when generating a mapping template.
+ * @public + */ +export type TemplateDetails = TemplateDetails.X12Member | TemplateDetails.$UnknownMember; + +/** + * @public + */ +export namespace TemplateDetails { + /** + *A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
+ *If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.
+ *Specify the location of the sample EDI file that is used to generate the mapping template.
+ * @public + */ + outputSampleLocation?: S3Location; + + /** + *Specify the format for the mapping template: either JSONATA or XSLT.
+ * @public + */ + mappingType: MappingType | undefined; + + /** + *+ * Describes the details needed for generating the template. Specify the X12 transaction set and version for which the template is used: + * currently, we only support X12. + *
+ * @public + */ + templateDetails: TemplateDetails | undefined; +} + +/** + * @public + */ +export interface CreateStarterMappingTemplateResponse { + /** + *Returns a string that represents the mapping template.
+ * @public + */ + mappingTemplate: string | undefined; +} + /** * @public */ @@ -873,6 +983,229 @@ export interface ListTagsForResourceResponse { Tags?: Tag[]; } +/** + *In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header. + * The delimiters are part of the message's syntax and divide up its different elements.
+ * @public + */ +export interface X12Delimiters { + /** + *The component, or sub-element, separator. The default value is :
(colon).
The data element separator. The default value is *
(asterisk).
The segment terminator. The default value is ~
(tilde).
Part of the X12 message structure. These are the functional group headers for the X12 EDI object.
+ * @public + */ +export interface X12FunctionalGroupHeaders { + /** + *A value representing the code used to identify the party transmitting a message, at position GS-02.
+ * @public + */ + applicationSenderCode?: string; + + /** + *A value representing the code used to identify the party receiving a message, at position GS-03.
+ * @public + */ + applicationReceiverCode?: string; + + /** + *A code that identifies the issuer of the standard, at position GS-07.
+ * @public + */ + responsibleAgencyCode?: string; +} + +/** + *In X12, the Interchange Control Header is the first segment of an EDI document and is + * part of the Interchange Envelope. It contains information about the sender and receiver, + * the date and time of transmission, and the X12 version being used. It also includes + * delivery information, such as the sender and receiver IDs.
+ * @public + */ +export interface X12InterchangeControlHeaders { + /** + *Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
+ * @public + */ + senderIdQualifier?: string; + + /** + *Located at position ISA-06 in the header. This value (along with the senderIdQualifier
) identifies the sender of the interchange.
Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
+ * @public + */ + receiverIdQualifier?: string; + + /** + *Located at position ISA-08 in the header. This value (along with the receiverIdQualifier
) identifies the intended recipient of the interchange.
Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
+ *This parameter is only honored for version greater than 401 (VERSION_4010
and higher).
For versions less than 401, this field is called StandardsId, in which case our service
+ * sets the value to U
.
Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.
+ * @public + */ + acknowledgmentRequestedCode?: string; + + /** + *Located at position ISA-15 in the header. Specifies how this interchange is being used:
+ *
+ * T
indicates this interchange is for testing.
+ * P
indicates this interchange is for production.
+ * I
indicates this interchange is informational.
A structure containing the details for an outbound EDI object.
+ * @public + */ +export interface X12OutboundEdiHeaders { + /** + *In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
+ * @public + */ + interchangeControlHeaders?: X12InterchangeControlHeaders; + + /** + *The functional group headers for the X12 object.
+ * @public + */ + functionalGroupHeaders?: X12FunctionalGroupHeaders; + + /** + *The delimiters, for example semicolon (;
), that separates sections of the headers for the X12 object.
Specifies whether or not to validate the EDI for this X12 object: TRUE
or FALSE
.
A wrapper structure for an X12 definition object.
+ *the X12 envelope ensures the integrity of the data and the efficiency of the information exchange. The X12 message structure has hierarchical levels. From highest to the lowest, they are:
+ *Interchange Envelope
+ *Functional Group
+ *Transaction Set
+ *A container for the X12 outbound EDI headers.
+ * @public + */ + common?: X12OutboundEdiHeaders; +} + +/** + *A container for outbound EDI options.
+ * @public + */ +export type OutboundEdiOptions = OutboundEdiOptions.X12Member | OutboundEdiOptions.$UnknownMember; + +/** + * @public + */ +export namespace OutboundEdiOptions { + /** + *A structure that contains an X12 envelope structure.
+ * @public + */ + export interface X12Member { + x12: X12Envelope; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + x12?: never; + $unknown: [string, any]; + } + + export interface VisitorContains the details for an Outbound EDI capability.
+ * @public + */ +export interface CapabilityOptions { + /** + *A structure that contains the outbound EDI options.
+ * @public + */ + outboundEdi?: OutboundEdiOptions; +} + /** * @public */ @@ -907,6 +1240,12 @@ export interface CreatePartnershipRequest { */ capabilities: string[] | undefined; + /** + *Specify the structure that contains the details for the associated capabilities.
+ * @public + */ + capabilityOptions?: CapabilityOptions; + /** *Reserved for future use.
* @public @@ -966,6 +1305,12 @@ export interface CreatePartnershipResponse { */ capabilities?: string[]; + /** + *Returns the structure that contains the details for the associated capabilities.
+ * @public + */ + capabilityOptions?: CapabilityOptions; + /** *Returns the unique, system-generated identifier for a trading partner.
* @public @@ -1047,6 +1392,12 @@ export interface GetPartnershipResponse { */ capabilities?: string[]; + /** + *Contains the details for an Outbound EDI capability.
+ * @public + */ + capabilityOptions?: CapabilityOptions; + /** *Returns the unique identifier for the partner for this partnership.
* @public @@ -1120,6 +1471,12 @@ export interface PartnershipSummary { */ capabilities?: string[]; + /** + *Contains the details for an Outbound EDI capability.
+ * @public + */ + capabilityOptions?: CapabilityOptions; + /** *Returns the unique, system-generated identifier for a trading partner.
* @public @@ -1178,6 +1535,12 @@ export interface UpdatePartnershipRequest { * @public */ capabilities?: string[]; + + /** + *To update, specify the structure that contains the details for the associated capabilities.
+ * @public + */ + capabilityOptions?: CapabilityOptions; } /** @@ -1226,6 +1589,12 @@ export interface UpdatePartnershipResponse { */ capabilities?: string[]; + /** + *Returns the structure that contains the details for the associated capabilities.
+ * @public + */ + capabilityOptions?: CapabilityOptions; + /** *Returns the unique, system-generated identifier for a trading partner.
* @public @@ -1698,7 +2067,7 @@ export interface TagResourceRequest { * @public * @enum */ -export const FileFormat = { +export const ConversionSourceFormat = { JSON: "JSON", XML: "XML", } as const; @@ -1706,32 +2075,260 @@ export const FileFormat = { /** * @public */ -export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat]; +export type ConversionSourceFormat = (typeof ConversionSourceFormat)[keyof typeof ConversionSourceFormat]; /** + *The input file to use for an outbound transformation.
* @public */ -export interface TestMappingRequest { - /** - *Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.
- * @public - */ - inputFileContent: string | undefined; +export type InputFileSource = InputFileSource.FileContentMember | InputFileSource.$UnknownMember; +/** + * @public + */ +export namespace InputFileSource { /** - *Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ *Specify the input contents, as a string, for the source of an outbound transformation.
* @public */ - mappingTemplate: string | undefined; + export interface FileContentMember { + fileContent: string; + $unknown?: never; + } /** - *Specifies that the currently supported file formats for EDI transformations are JSON
and XML
.
Describes the input for an outbound transformation.
+ * @public + */ +export interface ConversionSource { + /** + *The format for the input file: either JSON or XML.
+ * @public + */ + fileFormat: ConversionSourceFormat | undefined; + + /** + * File to be converted + * @public + */ + inputFile: InputFileSource | undefined; +} + +/** + * @public + * @enum + */ +export const ConversionTargetFormat = { + X12: "X12", +} as const; + +/** + * @public + */ +export type ConversionTargetFormat = (typeof ConversionTargetFormat)[keyof typeof ConversionTargetFormat]; + +/** + *Contains a structure describing the X12 details for the conversion target.
+ * @public + */ +export type ConversionTargetFormatDetails = + | ConversionTargetFormatDetails.X12Member + | ConversionTargetFormatDetails.$UnknownMember; + +/** + * @public + */ +export namespace ConversionTargetFormatDetails { + /** + *A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
+ *If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.
+ *Container for the location of a sample file used for outbound transformations.
+ * @public + */ +export type OutputSampleFileSource = OutputSampleFileSource.FileLocationMember | OutputSampleFileSource.$UnknownMember; + +/** + * @public + */ +export namespace OutputSampleFileSource { + /** + *Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File + * locations in Amazon S3 are identified using a combination of the bucket and key.
+ * @public + */ + export interface FileLocationMember { + fileLocation: S3Location; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + fileLocation?: never; + $unknown: [string, any]; + } + + export interface VisitorProvide a sample of what the output of the transformation should look like.
+ * @public + */ +export interface ConversionTarget { + /** + *Currently, only X12 format is supported.
+ * @public + */ + fileFormat: ConversionTargetFormat | undefined; + + /** + *A structure that contains the formatting details for the conversion target.
+ * @public + */ + formatDetails?: ConversionTargetFormatDetails; + + /** + * Customer uses this to provide a sample on what should file look like after conversion + * X12 EDI use case around this would be discovering the file syntax + * @public + */ + outputSampleFile?: OutputSampleFileSource; +} + +/** + * @public + */ +export interface TestConversionRequest { + /** + *Specify the source file for an outbound EDI request.
+ * @public + */ + source: ConversionSource | undefined; + + /** + *Specify the format (X12 is the only currently supported format), and other details for the conversion target.
+ * @public + */ + target: ConversionTarget | undefined; +} + +/** + * @public + */ +export interface TestConversionResponse { + /** + *Returns the converted file content.
+ * @public + */ + convertedFileContent: string | undefined; + + /** + *Returns an array of strings, each containing a message that Amazon Web Services B2B Data Interchange generates during the conversion.
+ * @public + */ + validationMessages?: string[]; +} + +/** + * @public + * @enum + */ +export const FileFormat = { + JSON: "JSON", + NOT_USED: "NOT_USED", + XML: "XML", +} as const; + +/** + * @public + */ +export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat]; + +/** + * @public + */ +export interface TestMappingRequest { + /** + *Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.
+ * @public + */ + inputFileContent: string | undefined; + + /** + *Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ *This parameter is available for backwards compatibility. Use the Mapping data type instead.
+ *Specifies that the currently supported file formats for EDI transformations are JSON
and XML
.
Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
* @public */ - ediType: EdiType | undefined; + ediType: EdiType | undefined; +} + +/** + * @public + */ +export interface TestParsingResponse { + /** + *Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.
+ * @public + */ + parsedFileContent: string | undefined; +} + +/** + *A structure that contains the X12 transaction set and version.
+ * @public + */ +export type FormatOptions = FormatOptions.X12Member | FormatOptions.$UnknownMember; + +/** + * @public + */ +export namespace FormatOptions { + /** + *A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
+ *If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.
+ *Contains the input formatting options for an inbound transformer (takes an X12-formatted + * EDI document as input and converts it to JSON or XML.
+ * @public + */ +export interface InputConversion { + /** + *The format for the transformer input: currently on X12
is supported.
A structure that contains the formatting options for an inbound transformer.
+ * @public + */ + formatOptions?: FormatOptions; +} + +/** + * @public + * @enum + */ +export const MappingTemplateLanguage = { + JSONATA: "JSONATA", + XSLT: "XSLT", +} as const; + +/** + * @public + */ +export type MappingTemplateLanguage = (typeof MappingTemplateLanguage)[keyof typeof MappingTemplateLanguage]; + +/** + *Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ * @public + */ +export interface Mapping { + /** + *The transformation language for the template, either XSLT or JSONATA.
+ * @public + */ + templateLanguage: MappingTemplateLanguage | undefined; + + /** + *A string that represents the mapping template, in the transformation language specified in templateLanguage
.
Contains the formatting options for an outbound transformer (takes JSON or XML as input and converts it to an EDI document (currently only X12 format is supported).
+ * @public + */ +export interface OutputConversion { + /** + *The format for the output from an outbound transformer: only X12 is currently supported.
+ * @public + */ + toFormat: ToFormat | undefined; + + /** + *A structure that contains the X12 transaction set and version for the transformer output.
+ * @public + */ + formatOptions?: FormatOptions; +} + +/** + *An array of the Amazon S3 keys used to identify the location for your sample documents.
+ * @public + */ +export interface SampleDocumentKeys { + /** + *An array of keys for your input sample documents.
+ * @public + */ + input?: string; + + /** + *An array of keys for your output sample documents.
+ * @public + */ + output?: string; } /** + *Describes a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
* @public */ -export interface TestParsingResponse { +export interface SampleDocuments { /** - *Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.
+ *Contains the Amazon S3 bucket that is used to hold your sample documents.
* @public */ - parsedFileContent: string | undefined; + bucketName: string | undefined; + + /** + *Contains an array of the Amazon S3 keys used to identify the location for your sample documents.
+ * @public + */ + keys: SampleDocumentKeys[] | undefined; } /** @@ -1787,40 +2556,75 @@ export interface CreateTransformerRequest { name: string | undefined; /** + *Reserved for future use.
+ * @public + */ + clientToken?: string; + + /** + *Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
+ * @public + */ + tags?: Tag[]; + + /** + * @deprecated + * *Specifies that the currently supported file formats for EDI transformations are JSON
and XML
.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ *This parameter is available for backwards compatibility. Use the Mapping data type instead.
+ *Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
* @public */ - ediType: EdiType | undefined; + ediType?: EdiType; /** + * @deprecated + * *Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
* @public */ sampleDocument?: string; /** - *Reserved for future use.
+ *Specify the InputConversion
object, which contains the format options for the inbound transformation.
Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
+ *Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
* @public */ - tags?: Tag[]; + mapping?: Mapping; + + /** + *A structure that contains the OutputConversion
object, which contains the format options for the outbound transformation.
Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
+ * @public + */ + sampleDocuments?: SampleDocuments; } /** @@ -1860,42 +2664,74 @@ export interface CreateTransformerResponse { name: string | undefined; /** - *Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the state of the newly created transformer. The transformer can be either
+ * active
or inactive
. For the transformer to be used in a
+ * capability, its status must active
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ *Returns a timestamp for creation date and time of the transformer.
* @public */ - mappingTemplate: string | undefined; + createdAt: Date | undefined; /** - *Returns the state of the newly created transformer. The transformer can be either
- * active
or inactive
. For the transformer to be used in a
- * capability, its status must active
.
Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ * @public + */ + mappingTemplate?: string; /** + * @deprecated + * *Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
* @public */ - ediType: EdiType | undefined; + ediType?: EdiType; /** + * @deprecated + * *Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
* @public */ sampleDocument?: string; /** - *Returns a timestamp for creation date and time of the transformer.
+ *Returns the InputConversion
object, which contains the format options for the inbound transformation.
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
+ * @public + */ + mapping?: Mapping; + + /** + *Returns the OutputConversion
object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
+ * @public + */ + sampleDocuments?: SampleDocuments; } /** @@ -1943,48 +2779,80 @@ export interface GetTransformerResponse { name: string | undefined; /** - *Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the state of the newly created transformer. The transformer can be either
+ * active
or inactive
. For the transformer to be used in a
+ * capability, its status must active
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ *Returns a timestamp for creation date and time of the transformer.
* @public */ - mappingTemplate: string | undefined; + createdAt: Date | undefined; /** - *Returns the state of the newly created transformer. The transformer can be either
- * active
or inactive
. For the transformer to be used in a
- * capability, its status must active
.
Returns a timestamp for last time the transformer was modified.
* @public */ - status: TransformerStatus | undefined; + modifiedAt?: Date; + + /** + * @deprecated + * + *Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ * @public + */ + mappingTemplate?: string; /** + * @deprecated + * *Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
* @public */ - ediType: EdiType | undefined; + ediType?: EdiType; /** + * @deprecated + * *Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
* @public */ sampleDocument?: string; /** - *Returns a timestamp for creation date and time of the transformer.
+ *Returns the InputConversion
object, which contains the format options for the inbound transformation.
Returns a timestamp for last time the transformer was modified.
+ *Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
* @public */ - modifiedAt?: Date; + mapping?: Mapping; + + /** + *Returns the OutputConversion
object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
+ * @public + */ + sampleDocuments?: SampleDocuments; } /** @@ -2006,9 +2874,8 @@ export interface ListTransformersRequest { } /** - *Contains the details for a transformer object. A transformer - * describes how to process the incoming EDI documents and extract the necessary - * information to the output file.
+ *Contains the details for a transformer object. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, + * a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
* @public */ export interface TransformerSummary { @@ -2025,49 +2892,81 @@ export interface TransformerSummary { name: string | undefined; /** - *Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the state of the newly created transformer. The transformer can be either
+ * active
or inactive
. For the transformer to be used in a
+ * capability, its status must active
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ *Returns a timestamp indicating when the transformer was created. For example,
+ * 2023-07-20T19:58:44.624Z
.
Returns the state of the newly created transformer. The transformer can be either
- * active
or inactive
. For the transformer to be used in a
- * capability, its status must active
.
Returns a timestamp representing the date and time for the most recent change for the transformer object.
* @public */ - status: TransformerStatus | undefined; + modifiedAt?: Date; + + /** + * @deprecated + * + *Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ * @public + */ + mappingTemplate?: string; /** + * @deprecated + * *Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
* @public */ - ediType: EdiType | undefined; + ediType?: EdiType; /** + * @deprecated + * *Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
* @public */ sampleDocument?: string; /** - *Returns a timestamp indicating when the transformer was created. For example,
- * 2023-07-20T19:58:44.624Z
.
Returns a structure that contains the format options for the transformation.
* @public */ - createdAt: Date | undefined; + inputConversion?: InputConversion; /** - *Returns a timestamp representing the date and time for the most recent change for the transformer object.
+ *Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
* @public */ - modifiedAt?: Date; + mapping?: Mapping; + + /** + *Returns the OutputConversion
object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
+ * @public + */ + sampleDocuments?: SampleDocuments; } /** @@ -2107,34 +3006,69 @@ export interface UpdateTransformerRequest { name?: string; /** - *Specifies that the currently supported file formats for EDI transformations are JSON
and XML
.
Specifies the transformer's status. You can update the state of the transformer, from active
to inactive
, or inactive
to active
.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ * @deprecated + * + *Specifies that the currently supported file formats for EDI transformations are JSON
and XML
.
Specifies the transformer's status. You can update the state of the transformer, from active
to inactive
, or inactive
to active
.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ *This parameter is available for backwards compatibility. Use the Mapping data type instead.
+ *Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
* @public */ ediType?: EdiType; /** + * @deprecated + * *Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
* @public */ sampleDocument?: string; + + /** + *To update, specify the InputConversion
object, which contains the format options for the inbound transformation.
Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
+ * @public + */ + mapping?: Mapping; + + /** + *To update, specify the OutputConversion
object, which contains the format options for the outbound transformation.
Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
+ * @public + */ + sampleDocuments?: SampleDocuments; } /** @@ -2160,48 +3094,80 @@ export interface UpdateTransformerResponse { name: string | undefined; /** - *Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the state of the newly created transformer. The transformer can be either
+ * active
or inactive
. For the transformer to be used in a
+ * capability, its status must active
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ *Returns a timestamp for creation date and time of the transformer.
* @public */ - mappingTemplate: string | undefined; + createdAt: Date | undefined; /** - *Returns the state of the newly created transformer. The transformer can be either
- * active
or inactive
. For the transformer to be used in a
- * capability, its status must active
.
Returns a timestamp for last time the transformer was modified.
* @public */ - status: TransformerStatus | undefined; + modifiedAt: Date | undefined; + + /** + * @deprecated + * + *Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
+ * @public + */ + mappingTemplate?: string; /** + * @deprecated + * *Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
* @public */ - ediType: EdiType | undefined; + ediType?: EdiType; /** + * @deprecated + * *Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
* @public */ sampleDocument?: string; /** - *Returns a timestamp for creation date and time of the transformer.
+ *Returns the InputConversion
object, which contains the format options for the inbound transformation.
Returns a timestamp for last time the transformer was modified.
+ *Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
* @public */ - modifiedAt: Date | undefined; + mapping?: Mapping; + + /** + *Returns the OutputConversion
object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
+ * @public + */ + sampleDocuments?: SampleDocuments; } /** @@ -2228,6 +3194,7 @@ export const CreatePartnershipRequestFilterSensitiveLog = (obj: CreatePartnershi ...obj, ...(obj.email && { email: SENSITIVE_STRING }), ...(obj.phone && { phone: SENSITIVE_STRING }), + ...(obj.capabilityOptions && { capabilityOptions: obj.capabilityOptions }), }); /** @@ -2237,6 +3204,7 @@ export const CreatePartnershipResponseFilterSensitiveLog = (obj: CreatePartnersh ...obj, ...(obj.email && { email: SENSITIVE_STRING }), ...(obj.phone && { phone: SENSITIVE_STRING }), + ...(obj.capabilityOptions && { capabilityOptions: obj.capabilityOptions }), }); /** @@ -2246,6 +3214,7 @@ export const GetPartnershipResponseFilterSensitiveLog = (obj: GetPartnershipResp ...obj, ...(obj.email && { email: SENSITIVE_STRING }), ...(obj.phone && { phone: SENSITIVE_STRING }), + ...(obj.capabilityOptions && { capabilityOptions: obj.capabilityOptions }), }); /** @@ -2255,6 +3224,7 @@ export const UpdatePartnershipResponseFilterSensitiveLog = (obj: UpdatePartnersh ...obj, ...(obj.email && { email: SENSITIVE_STRING }), ...(obj.phone && { phone: SENSITIVE_STRING }), + ...(obj.capabilityOptions && { capabilityOptions: obj.capabilityOptions }), }); /** diff --git a/clients/client-b2bi/src/protocols/Aws_json1_0.ts b/clients/client-b2bi/src/protocols/Aws_json1_0.ts index eba424971c82..980133c3818f 100644 --- a/clients/client-b2bi/src/protocols/Aws_json1_0.ts +++ b/clients/client-b2bi/src/protocols/Aws_json1_0.ts @@ -27,6 +27,10 @@ import { v4 as generateIdempotencyToken } from "uuid"; import { CreateCapabilityCommandInput, CreateCapabilityCommandOutput } from "../commands/CreateCapabilityCommand"; import { CreatePartnershipCommandInput, CreatePartnershipCommandOutput } from "../commands/CreatePartnershipCommand"; import { CreateProfileCommandInput, CreateProfileCommandOutput } from "../commands/CreateProfileCommand"; +import { + CreateStarterMappingTemplateCommandInput, + CreateStarterMappingTemplateCommandOutput, +} from "../commands/CreateStarterMappingTemplateCommand"; import { CreateTransformerCommandInput, CreateTransformerCommandOutput } from "../commands/CreateTransformerCommand"; import { DeleteCapabilityCommandInput, DeleteCapabilityCommandOutput } from "../commands/DeleteCapabilityCommand"; import { DeletePartnershipCommandInput, DeletePartnershipCommandOutput } from "../commands/DeletePartnershipCommand"; @@ -50,6 +54,7 @@ import { StartTransformerJobCommandOutput, } from "../commands/StartTransformerJobCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand"; +import { TestConversionCommandInput, TestConversionCommandOutput } from "../commands/TestConversionCommand"; import { TestMappingCommandInput, TestMappingCommandOutput } from "../commands/TestMappingCommand"; import { TestParsingCommandInput, TestParsingCommandOutput } from "../commands/TestParsingCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand"; @@ -61,14 +66,19 @@ import { B2biServiceException as __BaseException } from "../models/B2biServiceEx import { AccessDeniedException, CapabilityConfiguration, + CapabilityOptions, CapabilitySummary, ConflictException, + ConversionSource, + ConversionTarget, + ConversionTargetFormatDetails, CreateCapabilityRequest, CreateCapabilityResponse, CreatePartnershipRequest, CreatePartnershipResponse, CreateProfileRequest, CreateProfileResponse, + CreateStarterMappingTemplateRequest, CreateTransformerRequest, CreateTransformerResponse, DeleteCapabilityRequest, @@ -77,6 +87,7 @@ import { DeleteTransformerRequest, EdiConfiguration, EdiType, + FormatOptions, GetCapabilityRequest, GetCapabilityResponse, GetPartnershipRequest, @@ -86,6 +97,8 @@ import { GetTransformerJobRequest, GetTransformerRequest, GetTransformerResponse, + InputConversion, + InputFileSource, InternalServerException, ListCapabilitiesRequest, ListCapabilitiesResponse, @@ -96,14 +109,22 @@ import { ListTagsForResourceRequest, ListTransformersRequest, ListTransformersResponse, + Mapping, + OutboundEdiOptions, + OutputConversion, + OutputSampleFileSource, PartnershipSummary, ProfileSummary, ResourceNotFoundException, S3Location, + SampleDocumentKeys, + SampleDocuments, ServiceQuotaExceededException, StartTransformerJobRequest, Tag, TagResourceRequest, + TemplateDetails, + TestConversionRequest, TestMappingRequest, TestParsingRequest, ThrottlingException, @@ -118,7 +139,12 @@ import { UpdateTransformerRequest, UpdateTransformerResponse, ValidationException, + X12Delimiters, X12Details, + X12Envelope, + X12FunctionalGroupHeaders, + X12InterchangeControlHeaders, + X12OutboundEdiHeaders, } from "../models/models_0"; /** @@ -160,6 +186,19 @@ export const se_CreateProfileCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_0CreateStarterMappingTemplateCommand + */ +export const se_CreateStarterMappingTemplateCommand = async ( + input: CreateStarterMappingTemplateCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("CreateStarterMappingTemplate"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_0CreateTransformerCommand */ @@ -381,6 +420,19 @@ export const se_TagResourceCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_0TestConversionCommand + */ +export const se_TestConversionCommand = async ( + input: TestConversionCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("TestConversion"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_0TestMappingCommand */ @@ -532,6 +584,26 @@ export const de_CreateProfileCommand = async ( return response; }; +/** + * deserializeAws_json1_0CreateStarterMappingTemplateCommand + */ +export const de_CreateStarterMappingTemplateCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseA capability object. Currently, only EDI (electronic data interchange) capabilities are supported. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
" } }, + "com.amazonaws.b2bi#CapabilityDirection": { + "type": "enum", + "members": { + "INBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INBOUND" + } + }, + "OUTBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTBOUND" + } + } + } + }, "com.amazonaws.b2bi#CapabilityId": { "type": "string", "traits": { @@ -838,6 +861,20 @@ } } }, + "com.amazonaws.b2bi#CapabilityOptions": { + "type": "structure", + "members": { + "outboundEdi": { + "target": "com.amazonaws.b2bi#OutboundEdiOptions", + "traits": { + "smithy.api#documentation": "A structure that contains the outbound EDI options.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the details for an Outbound EDI capability.
" + } + }, "com.amazonaws.b2bi#CapabilitySummary": { "type": "structure", "members": { @@ -907,6 +944,94 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.b2bi#ConversionSource": { + "type": "structure", + "members": { + "fileFormat": { + "target": "com.amazonaws.b2bi#ConversionSourceFormat", + "traits": { + "smithy.api#documentation": "The format for the input file: either JSON or XML.
", + "smithy.api#required": {} + } + }, + "inputFile": { + "target": "com.amazonaws.b2bi#InputFileSource", + "traits": { + "smithy.api#documentation": "File to be converted", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the input for an outbound transformation.
" + } + }, + "com.amazonaws.b2bi#ConversionSourceFormat": { + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "XML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XML" + } + } + } + }, + "com.amazonaws.b2bi#ConversionTarget": { + "type": "structure", + "members": { + "fileFormat": { + "target": "com.amazonaws.b2bi#ConversionTargetFormat", + "traits": { + "smithy.api#documentation": "Currently, only X12 format is supported.
", + "smithy.api#required": {} + } + }, + "formatDetails": { + "target": "com.amazonaws.b2bi#ConversionTargetFormatDetails", + "traits": { + "smithy.api#documentation": "A structure that contains the formatting details for the conversion target.
" + } + }, + "outputSampleFile": { + "target": "com.amazonaws.b2bi#OutputSampleFileSource", + "traits": { + "smithy.api#documentation": "Customer uses this to provide a sample on what should file look like after conversion\nX12 EDI use case around this would be discovering the file syntax" + } + } + }, + "traits": { + "smithy.api#documentation": "Provide a sample of what the output of the transformation should look like.
" + } + }, + "com.amazonaws.b2bi#ConversionTargetFormat": { + "type": "enum", + "members": { + "X12": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12" + } + } + } + }, + "com.amazonaws.b2bi#ConversionTargetFormatDetails": { + "type": "union", + "members": { + "x12": { + "target": "com.amazonaws.b2bi#X12Details" + } + }, + "traits": { + "smithy.api#documentation": "Contains a structure describing the X12 details for the conversion target.
" + } + }, "com.amazonaws.b2bi#CreateCapability": { "type": "operation", "input": { @@ -1236,6 +1361,12 @@ "smithy.api#required": {} } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions", + "traits": { + "smithy.api#documentation": "Specify the structure that contains the details for the associated capabilities.
" + } + }, "clientToken": { "target": "smithy.api#String", "traits": { @@ -1303,6 +1434,12 @@ "smithy.api#documentation": "Returns one or more capabilities associated with this partnership.
" } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions", + "traits": { + "smithy.api#documentation": "Returns the structure that contains the details for the associated capabilities.
" + } + }, "tradingPartnerId": { "target": "com.amazonaws.b2bi#TradingPartnerId", "traits": { @@ -1529,6 +1666,101 @@ "smithy.api#output": {} } }, + "com.amazonaws.b2bi#CreateStarterMappingTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#CreateStarterMappingTemplateRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#CreateStarterMappingTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.
\nIf you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template.\n The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it\n into the JSON or XML file that is used to generate the EDI.
\nIf you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the templateDetails
parameter.\n
Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.
", + "smithy.api#examples": [ + { + "title": "Sample CreateStarterMappingTemplate call", + "input": { + "mappingType": "JSONATA", + "templateDetails": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "outputSampleLocation": { + "bucketName": "output-sample-bucket", + "key": "output-sample-key" + } + }, + "output": { + "mappingTemplate": "Example Mapping Template" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/createmappingstarttemplate", + "method": "POST" + } + } + }, + "com.amazonaws.b2bi#CreateStarterMappingTemplateRequest": { + "type": "structure", + "members": { + "outputSampleLocation": { + "target": "com.amazonaws.b2bi#S3Location", + "traits": { + "smithy.api#documentation": "Specify the location of the sample EDI file that is used to generate the mapping template.
" + } + }, + "mappingType": { + "target": "com.amazonaws.b2bi#MappingType", + "traits": { + "smithy.api#documentation": "Specify the format for the mapping template: either JSONATA or XSLT.
", + "smithy.api#required": {} + } + }, + "templateDetails": { + "target": "com.amazonaws.b2bi#TemplateDetails", + "traits": { + "smithy.api#documentation": "\n Describes the details needed for generating the template. Specify the X12 transaction set and version for which the template is used:\n currently, we only support X12.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#CreateStarterMappingTemplateResponse": { + "type": "structure", + "members": { + "mappingTemplate": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Returns a string that represents the mapping template.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.b2bi#CreateTransformer": { "type": "operation", "input": { @@ -1561,23 +1793,47 @@ } ], "traits": { - "aws.iam#requiredActions": ["b2bi:TagResource"], - "smithy.api#documentation": "Creates a transformer. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.
", + "aws.iam#requiredActions": [ + "b2bi:TagResource", + "b2bi:UpdateTransformer", + "logs:CreateLogDelivery", + "logs:CreateLogGroup", + "logs:CreateLogStream", + "logs:DescribeLogGroups", + "logs:DescribeLogStreams", + "logs:DescribeResourcePolicies", + "logs:ListLogDeliveries", + "logs:PutLogEvents", + "logs:PutResourcePolicy" + ], + "smithy.api#documentation": "Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:
\n\n Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange \n converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer,\n in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
\n\n Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use\n in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate\n a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.
\nThe following fields are provided for backwards compatibility only: fileFormat
,\n mappingTemplate
, ediType
, and sampleDocument
.
Use the mapping
data type in place of mappingTemplate
and fileFormat
\n
Use the sampleDocuments
data type in place of sampleDocument
\n
Use either the inputConversion
or outputConversion
in place of ediType
\n
Reserved for future use.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.b2bi#TagList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
" + } + }, "fileFormat": { "target": "com.amazonaws.b2bi#FileFormat", "traits": { - "smithy.api#documentation": "Specifies that the currently supported file formats for EDI transformations are JSON
and XML
.
Specifies that the currently supported file formats for EDI transformations are JSON
and XML
.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
\nThis parameter is available for backwards compatibility. Use the Mapping data type instead.
\nSpecifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" } }, - "clientToken": { - "target": "smithy.api#String", + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", "traits": { - "smithy.api#documentation": "Reserved for future use.
", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "Specify the InputConversion
object, which contains the format options for the inbound transformation.
Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
" + "smithy.api#documentation": "Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "A structure that contains the OutputConversion
object, which contains the format options for the outbound transformation.
Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, @@ -1691,20 +1992,6 @@ "smithy.api#required": {} } }, - "fileFormat": { - "target": "com.amazonaws.b2bi#FileFormat", - "traits": { - "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", - "smithy.api#required": {} - } - }, "status": { "target": "com.amazonaws.b2bi#TransformerStatus", "traits": { @@ -1712,24 +1999,75 @@ "smithy.api#required": {} } }, - "ediType": { - "target": "com.amazonaws.b2bi#EdiType", + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", "traits": { - "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", + "smithy.api#documentation": "Returns a timestamp for creation date and time of the transformer.
", "smithy.api#required": {} } }, - "sampleDocument": { - "target": "com.amazonaws.b2bi#FileLocation", + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", "traits": { - "smithy.api#documentation": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns a timestamp for creation date and time of the transformer.
", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" + } + }, + "ediType": { + "target": "com.amazonaws.b2bi#EdiType", + "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" + } + }, + "sampleDocument": { + "target": "com.amazonaws.b2bi#FileLocation", + "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" + } + }, + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", + "traits": { + "smithy.api#documentation": "Returns the InputConversion
object, which contains the format options for the inbound transformation.
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "Returns the OutputConversion
object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, @@ -1959,7 +2297,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified transformer. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.
", + "smithy.api#documentation": "Deletes the specified transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
", "smithy.api#examples": [ { "title": "Sample DeleteTransformer call", @@ -1995,6 +2333,12 @@ "com.amazonaws.b2bi#EdiConfiguration": { "type": "structure", "members": { + "capabilityDirection": { + "target": "com.amazonaws.b2bi#CapabilityDirection", + "traits": { + "smithy.api#documentation": "Specifies whether this is capability is for inbound or outbound transformations.
" + } + }, "type": { "target": "com.amazonaws.b2bi#EdiType", "traits": { @@ -2039,7 +2383,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" + "smithy.api#documentation": "Specifies the details for the EDI standard that is being used for the transformer.\n Currently, only X12 is supported. X12 is a set of standards and corresponding messages \n that define specific business documents.
" } }, "com.amazonaws.b2bi#Email": { @@ -2076,6 +2420,12 @@ "traits": { "smithy.api#enumValue": "JSON" } + }, + "NOT_USED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_USED" + } } } }, @@ -2088,6 +2438,28 @@ } } }, + "com.amazonaws.b2bi#FormatOptions": { + "type": "union", + "members": { + "x12": { + "target": "com.amazonaws.b2bi#X12Details" + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains the X12 transaction set and version.
" + } + }, + "com.amazonaws.b2bi#FromFormat": { + "type": "enum", + "members": { + "X12": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12" + } + } + } + }, "com.amazonaws.b2bi#GetCapability": { "type": "operation", "input": { @@ -2361,6 +2733,9 @@ "smithy.api#documentation": "Returns one or more capabilities associated with this partnership.
" } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions" + }, "tradingPartnerId": { "target": "com.amazonaws.b2bi#TradingPartnerId", "traits": { @@ -2556,7 +2931,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the details for the transformer specified by the transformer ID. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.
", + "smithy.api#documentation": "Retrieves the details for the transformer specified by the transformer ID. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
", "smithy.api#examples": [ { "title": "Sample GetTransformer call", @@ -2565,17 +2940,28 @@ }, "output": { "createdAt": "2023-11-01T21:51:05.504Z", - "ediType": { - "x12Details": { - "transactionSet": "X12_110", - "version": "VERSION_4010" + "name": "transformX12", + "inputConversion": { + "fromFormat": "X12", + "formatOptions": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } } }, - "fileFormat": "JSON", - "mappingTemplate": "$", - "modifiedAt": "2023-11-01T21:51:05.504Z", - "name": "transformJSON", - "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "mapping": { + "templateLanguage": "JSONATA", + "template": "{}" + }, + "sampleDocuments": { + "bucketName": "test-bucket", + "keys": [ + { + "input": "sampleDoc.txt" + } + ] + }, "status": "inactive", "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", "transformerId": "tr-974c129999f84d8c9" @@ -2734,51 +3120,88 @@ "smithy.api#required": {} } }, - "fileFormat": { - "target": "com.amazonaws.b2bi#FileFormat", + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", "traits": { - "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the state of the newly created transformer. The transformer can be either\n active
or inactive
. For the transformer to be used in a\n capability, its status must active
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", + "smithy.api#documentation": "Returns a timestamp for creation date and time of the transformer.
", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.b2bi#TransformerStatus", + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", "traits": { - "smithy.api#documentation": "Returns the state of the newly created transformer. The transformer can be either\n active
or inactive
. For the transformer to be used in a\n capability, its status must active
.
Returns a timestamp for last time the transformer was modified.
" + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" } }, "ediType": { "target": "com.amazonaws.b2bi#EdiType", "traits": { - "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" } }, - "createdAt": { - "target": "com.amazonaws.b2bi#CreatedDate", + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", "traits": { - "smithy.api#documentation": "Returns a timestamp for creation date and time of the transformer.
", - "smithy.api#required": {} + "smithy.api#documentation": "Returns the InputConversion
object, which contains the format options for the inbound transformation.
Returns a timestamp for last time the transformer was modified.
" + "smithy.api#documentation": "Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "Returns the OutputConversion
object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, @@ -2786,6 +3209,45 @@ "smithy.api#output": {} } }, + "com.amazonaws.b2bi#InputConversion": { + "type": "structure", + "members": { + "fromFormat": { + "target": "com.amazonaws.b2bi#FromFormat", + "traits": { + "smithy.api#documentation": "The format for the transformer input: currently on X12
is supported.
A structure that contains the formatting options for an inbound transformer.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the input formatting options for an inbound transformer (takes an X12-formatted\n EDI document as input and converts it to JSON or XML.
" + } + }, + "com.amazonaws.b2bi#InputFileSource": { + "type": "union", + "members": { + "fileContent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specify the input contents, as a string, for the source of an outbound transformation.
", + "smithy.api#length": { + "min": 1, + "max": 5000000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The input file to use for an outbound transformation.
" + } + }, "com.amazonaws.b2bi#InstructionsDocuments": { "type": "list", "member": { @@ -2822,6 +3284,12 @@ "smithy.api#retryable": {} } }, + "com.amazonaws.b2bi#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#SampleDocumentKeys" + } + }, "com.amazonaws.b2bi#ListCapabilities": { "type": "operation", "input": { @@ -3240,7 +3708,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the available transformers. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.
", + "smithy.api#documentation": "Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
", "smithy.api#examples": [ { "title": "Sample ListTransformers call", @@ -3354,6 +3822,27 @@ } } }, + "com.amazonaws.b2bi#Mapping": { + "type": "structure", + "members": { + "templateLanguage": { + "target": "com.amazonaws.b2bi#MappingTemplateLanguage", + "traits": { + "smithy.api#documentation": "The transformation language for the template, either XSLT or JSONATA.
", + "smithy.api#required": {} + } + }, + "template": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#documentation": "A string that represents the mapping template, in the transformation language specified in templateLanguage
.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" + } + }, "com.amazonaws.b2bi#MappingTemplate": { "type": "string", "traits": { @@ -3363,6 +3852,40 @@ } } }, + "com.amazonaws.b2bi#MappingTemplateLanguage": { + "type": "enum", + "members": { + "XSLT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XSLT" + } + }, + "JSONATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSONATA" + } + } + } + }, + "com.amazonaws.b2bi#MappingType": { + "type": "enum", + "members": { + "JSONATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSONATA" + } + }, + "XSLT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XSLT" + } + } + } + }, "com.amazonaws.b2bi#MaxResults": { "type": "integer", "traits": { @@ -3378,6 +3901,52 @@ "smithy.api#timestampFormat": "date-time" } }, + "com.amazonaws.b2bi#OutboundEdiOptions": { + "type": "union", + "members": { + "x12": { + "target": "com.amazonaws.b2bi#X12Envelope", + "traits": { + "smithy.api#documentation": "A structure that contains an X12 envelope structure.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A container for outbound EDI options.
" + } + }, + "com.amazonaws.b2bi#OutputConversion": { + "type": "structure", + "members": { + "toFormat": { + "target": "com.amazonaws.b2bi#ToFormat", + "traits": { + "smithy.api#documentation": "The format for the output from an outbound transformer: only X12 is currently supported.
", + "smithy.api#required": {} + } + }, + "formatOptions": { + "target": "com.amazonaws.b2bi#FormatOptions", + "traits": { + "smithy.api#documentation": "A structure that contains the X12 transaction set and version for the transformer output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the formatting options for an outbound transformer (takes JSON or XML as input and converts it to an EDI document (currently only X12 format is supported).
" + } + }, + "com.amazonaws.b2bi#OutputSampleFileSource": { + "type": "union", + "members": { + "fileLocation": { + "target": "com.amazonaws.b2bi#S3Location" + } + }, + "traits": { + "smithy.api#documentation": "Container for the location of a sample file used for outbound transformations.
" + } + }, "com.amazonaws.b2bi#PageToken": { "type": "string", "traits": { @@ -3482,6 +4051,9 @@ "smithy.api#documentation": "Returns one or more capabilities associated with this partnership.
" } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions" + }, "tradingPartnerId": { "target": "com.amazonaws.b2bi#TradingPartnerId", "traits": { @@ -3692,7 +4264,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2BI Data Interchange. File\n locations in Amazon S3 are identified using a combination of the bucket and key.
" + "smithy.api#documentation": "Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File\n locations in Amazon S3 are identified using a combination of the bucket and key.
" } }, "com.amazonaws.b2bi#S3LocationList": { @@ -3701,6 +4273,48 @@ "target": "com.amazonaws.b2bi#S3Location" } }, + "com.amazonaws.b2bi#SampleDocumentKeys": { + "type": "structure", + "members": { + "input": { + "target": "com.amazonaws.b2bi#S3Key", + "traits": { + "smithy.api#documentation": "An array of keys for your input sample documents.
" + } + }, + "output": { + "target": "com.amazonaws.b2bi#S3Key", + "traits": { + "smithy.api#documentation": "An array of keys for your output sample documents.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An array of the Amazon S3 keys used to identify the location for your sample documents.
" + } + }, + "com.amazonaws.b2bi#SampleDocuments": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.b2bi#BucketName", + "traits": { + "smithy.api#documentation": "Contains the Amazon S3 bucket that is used to hold your sample documents.
", + "smithy.api#required": {} + } + }, + "keys": { + "target": "com.amazonaws.b2bi#KeyList", + "traits": { + "smithy.api#documentation": "Contains an array of the Amazon S3 keys used to identify the location for your sample documents.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" + } + }, "com.amazonaws.b2bi#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -3774,7 +4388,7 @@ } ], "traits": { - "smithy.api#documentation": "Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2BI Data Interchange.
\nIf you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just\n create and configure a transformer, and then run the StartTransformerJob
API to process your files.
Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.
\nIf you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just\n create and configure a transformer, and then run the StartTransformerJob
API to process your files.
A data structure that contains the information to use when generating a mapping template.
" + } + }, + "com.amazonaws.b2bi#TestConversion": { "type": "operation", "input": { - "target": "com.amazonaws.b2bi#TestMappingRequest" + "target": "com.amazonaws.b2bi#TestConversionRequest" }, "output": { - "target": "com.amazonaws.b2bi#TestMappingResponse" + "target": "com.amazonaws.b2bi#TestConversionResponse" }, "errors": [ { @@ -4011,17 +4636,121 @@ } ], "traits": { - "smithy.api#documentation": "Maps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the inputFileContent
parameter.
This operation mimics the latter half of a typical Outbound EDI request. It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI string, and return that string.
", "smithy.api#examples": [ { - "title": "Sample TestMapping call", + "title": "Sample TestConversion call", "input": { - "fileFormat": "JSON", - "inputFileContent": "Sample file content", - "mappingTemplate": "$" - }, - "output": { - "mappedFileContent": "Sample file content" + "source": { + "fileFormat": "JSON", + "inputFile": { + "fileContent": "Sample file content" + } + }, + "target": { + "fileFormat": "X12", + "formatDetails": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + } + } + }, + "output": { + "convertedFileContent": "Sample converted file content", + "validationMessages": [] + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/testconversion", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#TestConversionRequest": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.b2bi#ConversionSource", + "traits": { + "smithy.api#documentation": "Specify the source file for an outbound EDI request.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.b2bi#ConversionTarget", + "traits": { + "smithy.api#documentation": "Specify the format (X12 is the only currently supported format), and other details for the conversion target.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#TestConversionResponse": { + "type": "structure", + "members": { + "convertedFileContent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Returns the converted file content.
", + "smithy.api#required": {} + } + }, + "validationMessages": { + "target": "com.amazonaws.b2bi#ValidationMessages", + "traits": { + "smithy.api#documentation": "Returns an array of strings, each containing a message that Amazon Web Services B2B Data Interchange generates during the conversion.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#TestMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#TestMappingRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#TestMappingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Maps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the inputFileContent
parameter.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", + "smithy.api#documentation": "Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
\nThis parameter is available for backwards compatibility. Use the Mapping data type instead.
\nReturns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the state of the newly created transformer. The transformer can be either\n active
or inactive
. For the transformer to be used in a\n capability, its status must active
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", + "smithy.api#documentation": "Returns a timestamp indicating when the transformer was created. For example,\n 2023-07-20T19:58:44.624Z
.
Returns the state of the newly created transformer. The transformer can be either\n active
or inactive
. For the transformer to be used in a\n capability, its status must active
.
Returns a timestamp representing the date and time for the most recent change for the transformer object.
" + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" } }, "ediType": { "target": "com.amazonaws.b2bi#EdiType", "traits": { - "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" } }, - "createdAt": { - "target": "com.amazonaws.b2bi#CreatedDate", + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", "traits": { - "smithy.api#documentation": "Returns a timestamp indicating when the transformer was created. For example,\n 2023-07-20T19:58:44.624Z
.
Returns a structure that contains the format options for the transformation.
" } }, - "modifiedAt": { - "target": "com.amazonaws.b2bi#ModifiedDate", + "mapping": { + "target": "com.amazonaws.b2bi#Mapping", "traits": { - "smithy.api#documentation": "Returns a timestamp representing the date and time for the most recent change for the transformer object.
" + "smithy.api#documentation": "Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "Returns the OutputConversion
object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, "traits": { - "smithy.api#documentation": "Contains the details for a transformer object. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.
", + "smithy.api#documentation": "Contains the details for a transformer object. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
", "smithy.api#references": [ { "resource": "com.amazonaws.b2bi#Transformer" @@ -4757,6 +5535,12 @@ "traits": { "smithy.api#documentation": "List of the capabilities associated with this partnership.
" } + }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions", + "traits": { + "smithy.api#documentation": "To update, specify the structure that contains the details for the associated capabilities.
" + } } }, "traits": { @@ -4811,6 +5595,12 @@ "smithy.api#documentation": "Returns one or more capabilities associated with this partnership.
" } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions", + "traits": { + "smithy.api#documentation": "Returns the structure that contains the details for the associated capabilities.
" + } + }, "tradingPartnerId": { "target": "com.amazonaws.b2bi#TradingPartnerId", "traits": { @@ -5048,39 +5838,63 @@ ], "traits": { "aws.iam#requiredActions": ["b2bi:TagResource", "b2bi:UntagResource"], - "smithy.api#documentation": "Updates the specified parameters for a transformer. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.
", + "smithy.api#documentation": "Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
", "smithy.api#examples": [ { "title": "Sample UpdateTransformer call", "input": { - "ediType": { - "x12Details": { - "transactionSet": "X12_110", - "version": "VERSION_4010" + "inputConversion": { + "fromFormat": "X12", + "formatOptions": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } } }, - "fileFormat": "JSON", - "mappingTemplate": "{}", - "name": "transformJSON", - "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "mapping": { + "templateLanguage": "JSONATA", + "template": "{}" + }, + "sampleDocuments": { + "bucketName": "test-bucket", + "keys": [ + { + "input": "sampleDoc.txt" + } + ] + }, + "name": "transformX12", "status": "inactive", "transformerId": "tr-974c129999f84d8c9" }, "output": { "createdAt": "2023-11-01T21:51:05.504Z", - "ediType": { - "x12Details": { - "transactionSet": "X12_110", - "version": "VERSION_4010" + "modifiedAt": "2023-11-02T22:31:05.504Z", + "name": "transformX12", + "inputConversion": { + "fromFormat": "X12", + "formatOptions": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } } }, - "fileFormat": "JSON", - "mappingTemplate": "$", - "modifiedAt": "2023-11-01T21:51:05.504Z", - "name": "transformJSON", - "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "mapping": { + "templateLanguage": "JSONATA", + "template": "{}" + }, + "sampleDocuments": { + "bucketName": "test-bucket", + "keys": [ + { + "input": "sampleDoc.txt" + } + ] + }, "status": "inactive", - "transformerArn": "arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9", + "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", "transformerId": "tr-974c129999f84d8c9" } } @@ -5110,35 +5924,71 @@ "smithy.api#documentation": "Specify a new name for the transformer, if you want to update it.
" } }, + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", + "traits": { + "smithy.api#documentation": "Specifies the transformer's status. You can update the state of the transformer, from active
to inactive
, or inactive
to active
.
Specifies that the currently supported file formats for EDI transformations are JSON
and XML
.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" - } - }, - "status": { - "target": "com.amazonaws.b2bi#TransformerStatus", - "traits": { - "smithy.api#documentation": "Specifies the transformer's status. You can update the state of the transformer, from active
to inactive
, or inactive
to active
.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
\nThis parameter is available for backwards compatibility. Use the Mapping data type instead.
\nSpecifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" } + }, + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", + "traits": { + "smithy.api#documentation": "To update, specify the InputConversion
object, which contains the format options for the inbound transformation.
Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "To update, specify the OutputConversion
object, which contains the format options for the outbound transformation.
Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" + } } }, "traits": { @@ -5169,52 +6019,89 @@ "smithy.api#required": {} } }, - "fileFormat": { - "target": "com.amazonaws.b2bi#FileFormat", + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", "traits": { - "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the state of the newly created transformer. The transformer can be either\n active
or inactive
. For the transformer to be used in a\n capability, its status must active
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", + "smithy.api#documentation": "Returns a timestamp for creation date and time of the transformer.
", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.b2bi#TransformerStatus", + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", "traits": { - "smithy.api#documentation": "Returns the state of the newly created transformer. The transformer can be either\n active
or inactive
. For the transformer to be used in a\n capability, its status must active
.
Returns a timestamp for last time the transformer was modified.
", "smithy.api#required": {} } }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns that the currently supported file formats for EDI transformations are JSON
and XML
.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" + } + }, "ediType": { "target": "com.amazonaws.b2bi#EdiType", "traits": { - "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" } }, - "createdAt": { - "target": "com.amazonaws.b2bi#CreatedDate", + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", "traits": { - "smithy.api#documentation": "Returns a timestamp for creation date and time of the transformer.
", - "smithy.api#required": {} + "smithy.api#documentation": "Returns the InputConversion
object, which contains the format options for the inbound transformation.
Returns a timestamp for last time the transformer was modified.
", - "smithy.api#required": {} + "smithy.api#documentation": "Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "Returns the OutputConversion
object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, @@ -5238,6 +6125,88 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.b2bi#ValidationMessages": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.b2bi#X12AcknowledgmentRequestedCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12ApplicationReceiverCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 15 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12ApplicationSenderCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 15 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12ComponentSeparator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]$" + } + }, + "com.amazonaws.b2bi#X12DataElementSeparator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]$" + } + }, + "com.amazonaws.b2bi#X12Delimiters": { + "type": "structure", + "members": { + "componentSeparator": { + "target": "com.amazonaws.b2bi#X12ComponentSeparator", + "traits": { + "smithy.api#documentation": "The component, or sub-element, separator. The default value is :
(colon).
The data element separator. The default value is *
(asterisk).
The segment terminator. The default value is ~
(tilde).
In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.\n The delimiters are part of the message's syntax and divide up its different elements.
" + } + }, "com.amazonaws.b2bi#X12Details": { "type": "structure", "members": { @@ -5250,7 +6219,7 @@ "version": { "target": "com.amazonaws.b2bi#X12Version", "traits": { - "smithy.api#documentation": "Returns the version to use for the specified X12 transaction set.\n \n \n \n
" + "smithy.api#documentation": "Returns the version to use for the specified X12 transaction set.
" } } }, @@ -5258,6 +6227,187 @@ "smithy.api#documentation": "A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
\nIf an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.
\nA container for the X12 outbound EDI headers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A wrapper structure for an X12 definition object.
\nthe X12 envelope ensures the integrity of the data and the efficiency of the information exchange. The X12 message structure has hierarchical levels. From highest to the lowest, they are:
\nInterchange Envelope
\nFunctional Group
\nTransaction Set
\nA value representing the code used to identify the party transmitting a message, at position GS-02.
" + } + }, + "applicationReceiverCode": { + "target": "com.amazonaws.b2bi#X12ApplicationReceiverCode", + "traits": { + "smithy.api#documentation": "A value representing the code used to identify the party receiving a message, at position GS-03.
" + } + }, + "responsibleAgencyCode": { + "target": "com.amazonaws.b2bi#X12ResponsibleAgencyCode", + "traits": { + "smithy.api#documentation": "A code that identifies the issuer of the standard, at position GS-07.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Part of the X12 message structure. These are the functional group headers for the X12 EDI object.
" + } + }, + "com.amazonaws.b2bi#X12IdQualifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12InterchangeControlHeaders": { + "type": "structure", + "members": { + "senderIdQualifier": { + "target": "com.amazonaws.b2bi#X12IdQualifier", + "traits": { + "smithy.api#documentation": "Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
" + } + }, + "senderId": { + "target": "com.amazonaws.b2bi#X12SenderId", + "traits": { + "smithy.api#documentation": "Located at position ISA-06 in the header. This value (along with the senderIdQualifier
) identifies the sender of the interchange.
Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
" + } + }, + "receiverId": { + "target": "com.amazonaws.b2bi#X12ReceiverId", + "traits": { + "smithy.api#documentation": "Located at position ISA-08 in the header. This value (along with the receiverIdQualifier
) identifies the intended recipient of the interchange.
Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
\nThis parameter is only honored for version greater than 401 (VERSION_4010
and higher).
For versions less than 401, this field is called StandardsId, in which case our service\n sets the value to U
.
Located at position ISA-14 in the header. The value \"1\" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value \"0\" is used otherwise.
" + } + }, + "usageIndicatorCode": { + "target": "com.amazonaws.b2bi#X12UsageIndicatorCode", + "traits": { + "smithy.api#documentation": "Located at position ISA-15 in the header. Specifies how this interchange is being used:
\n\n T
indicates this interchange is for testing.
\n P
indicates this interchange is for production.
\n I
indicates this interchange is informational.
In X12, the Interchange Control Header is the first segment of an EDI document and is\n part of the Interchange Envelope. It contains information about the sender and receiver,\n the date and time of transmission, and the X12 version being used. It also includes\n delivery information, such as the sender and receiver IDs.
" + } + }, + "com.amazonaws.b2bi#X12OutboundEdiHeaders": { + "type": "structure", + "members": { + "interchangeControlHeaders": { + "target": "com.amazonaws.b2bi#X12InterchangeControlHeaders", + "traits": { + "smithy.api#documentation": "In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
" + } + }, + "functionalGroupHeaders": { + "target": "com.amazonaws.b2bi#X12FunctionalGroupHeaders", + "traits": { + "smithy.api#documentation": "The functional group headers for the X12 object.
" + } + }, + "delimiters": { + "target": "com.amazonaws.b2bi#X12Delimiters", + "traits": { + "smithy.api#documentation": "The delimiters, for example semicolon (;
), that separates sections of the headers for the X12 object.
Specifies whether or not to validate the EDI for this X12 object: TRUE
or FALSE
.
A structure containing the details for an outbound EDI object.
" + } + }, + "com.amazonaws.b2bi#X12ReceiverId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 15 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12RepetitionSeparator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.b2bi#X12ResponsibleAgencyCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12SegmentTerminator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]$" + } + }, + "com.amazonaws.b2bi#X12SenderId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 15 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, "com.amazonaws.b2bi#X12TransactionSet": { "type": "enum", "members": { @@ -5713,6 +6863,19 @@ } } }, + "com.amazonaws.b2bi#X12UsageIndicatorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12ValidateEdi": { + "type": "boolean" + }, "com.amazonaws.b2bi#X12Version": { "type": "enum", "members": {