@aws-sdk/client-b2bi 3.662.0 → 3.663.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/index.js +205 -4
  3. package/dist-es/B2bi.js +4 -0
  4. package/dist-es/commands/CreateStarterMappingTemplateCommand.js +22 -0
  5. package/dist-es/commands/TestConversionCommand.js +22 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/models_0.js +78 -0
  8. package/dist-es/protocols/Aws_json1_0.js +63 -0
  9. package/dist-types/B2bi.d.ts +14 -0
  10. package/dist-types/B2biClient.d.ts +4 -2
  11. package/dist-types/commands/CreateCapabilityCommand.d.ts +2 -0
  12. package/dist-types/commands/CreatePartnershipCommand.d.ts +56 -0
  13. package/dist-types/commands/CreateStarterMappingTemplateCommand.d.ts +99 -0
  14. package/dist-types/commands/CreateTransformerCommand.d.ts +106 -14
  15. package/dist-types/commands/DeleteTransformerCommand.d.ts +2 -3
  16. package/dist-types/commands/GetCapabilityCommand.d.ts +1 -0
  17. package/dist-types/commands/GetPartnershipCommand.d.ts +28 -0
  18. package/dist-types/commands/GetTransformerCommand.d.ts +37 -7
  19. package/dist-types/commands/ListPartnershipsCommand.d.ts +28 -0
  20. package/dist-types/commands/ListTransformersCommand.d.ts +37 -7
  21. package/dist-types/commands/StartTransformerJobCommand.d.ts +1 -1
  22. package/dist-types/commands/TestConversionCommand.d.ts +109 -0
  23. package/dist-types/commands/TestMappingCommand.d.ts +1 -1
  24. package/dist-types/commands/TestParsingCommand.d.ts +1 -1
  25. package/dist-types/commands/UpdateCapabilityCommand.d.ts +2 -0
  26. package/dist-types/commands/UpdatePartnershipCommand.d.ts +56 -0
  27. package/dist-types/commands/UpdateTransformerCommand.d.ts +70 -9
  28. package/dist-types/commands/index.d.ts +2 -0
  29. package/dist-types/models/models_0.d.ts +934 -105
  30. package/dist-types/protocols/Aws_json1_0.d.ts +18 -0
  31. package/dist-types/ts3.4/B2bi.d.ts +34 -0
  32. package/dist-types/ts3.4/B2biClient.d.ts +12 -0
  33. package/dist-types/ts3.4/commands/CreateStarterMappingTemplateCommand.d.ts +51 -0
  34. package/dist-types/ts3.4/commands/TestConversionCommand.d.ts +50 -0
  35. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  36. package/dist-types/ts3.4/models/models_0.d.ts +276 -21
  37. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +24 -0
  38. package/package.json +1 -1
@@ -25,7 +25,19 @@ export declare class ConflictException extends __BaseException {
25
25
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
26
26
  }
27
27
  /**
28
- * <p>Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2BI Data Interchange. File
28
+ * @public
29
+ * @enum
30
+ */
31
+ export declare const CapabilityDirection: {
32
+ readonly INBOUND: "INBOUND";
33
+ readonly OUTBOUND: "OUTBOUND";
34
+ };
35
+ /**
36
+ * @public
37
+ */
38
+ export type CapabilityDirection = (typeof CapabilityDirection)[keyof typeof CapabilityDirection];
39
+ /**
40
+ * <p>Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File
29
41
  * locations in Amazon S3 are identified using a combination of the bucket and key.</p>
30
42
  * @public
31
43
  */
@@ -154,17 +166,15 @@ export interface X12Details {
154
166
  */
155
167
  transactionSet?: X12TransactionSet;
156
168
  /**
157
- * <p>Returns the version to use for the specified X12 transaction set.
158
- *
159
- *
160
- *
161
- * </p>
169
+ * <p>Returns the version to use for the specified X12 transaction set.</p>
162
170
  * @public
163
171
  */
164
172
  version?: X12Version;
165
173
  }
166
174
  /**
167
- * <p>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.</p>
175
+ * <p>Specifies the details for the EDI standard that is being used for the transformer.
176
+ * Currently, only X12 is supported. X12 is a set of standards and corresponding messages
177
+ * that define specific business documents.</p>
168
178
  * @public
169
179
  */
170
180
  export type EdiType = EdiType.X12DetailsMember | EdiType.$UnknownMember;
@@ -198,6 +208,11 @@ export declare namespace EdiType {
198
208
  * @public
199
209
  */
200
210
  export interface EdiConfiguration {
211
+ /**
212
+ * <p>Specifies whether this is capability is for inbound or outbound transformations.</p>
213
+ * @public
214
+ */
215
+ capabilityDirection?: CapabilityDirection;
201
216
  /**
202
217
  * <p>Returns the type of the capability. Currently, only <code>edi</code> is supported.</p>
203
218
  * @public
@@ -644,6 +659,84 @@ export interface UpdateCapabilityResponse {
644
659
  */
645
660
  modifiedAt?: Date;
646
661
  }
662
+ /**
663
+ * @public
664
+ * @enum
665
+ */
666
+ export declare const MappingType: {
667
+ readonly JSONATA: "JSONATA";
668
+ readonly XSLT: "XSLT";
669
+ };
670
+ /**
671
+ * @public
672
+ */
673
+ export type MappingType = (typeof MappingType)[keyof typeof MappingType];
674
+ /**
675
+ * <p>A data structure that contains the information to use when generating a mapping template.</p>
676
+ * @public
677
+ */
678
+ export type TemplateDetails = TemplateDetails.X12Member | TemplateDetails.$UnknownMember;
679
+ /**
680
+ * @public
681
+ */
682
+ export declare namespace TemplateDetails {
683
+ /**
684
+ * <p>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.</p>
685
+ * <note>
686
+ * <p>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.</p>
687
+ * </note>
688
+ * @public
689
+ */
690
+ interface X12Member {
691
+ x12: X12Details;
692
+ $unknown?: never;
693
+ }
694
+ /**
695
+ * @public
696
+ */
697
+ interface $UnknownMember {
698
+ x12?: never;
699
+ $unknown: [string, any];
700
+ }
701
+ interface Visitor<T> {
702
+ x12: (value: X12Details) => T;
703
+ _: (name: string, value: any) => T;
704
+ }
705
+ const visit: <T>(value: TemplateDetails, visitor: Visitor<T>) => T;
706
+ }
707
+ /**
708
+ * @public
709
+ */
710
+ export interface CreateStarterMappingTemplateRequest {
711
+ /**
712
+ * <p>Specify the location of the sample EDI file that is used to generate the mapping template.</p>
713
+ * @public
714
+ */
715
+ outputSampleLocation?: S3Location;
716
+ /**
717
+ * <p>Specify the format for the mapping template: either JSONATA or XSLT.</p>
718
+ * @public
719
+ */
720
+ mappingType: MappingType | undefined;
721
+ /**
722
+ * <p>
723
+ * Describes the details needed for generating the template. Specify the X12 transaction set and version for which the template is used:
724
+ * currently, we only support X12.
725
+ * </p>
726
+ * @public
727
+ */
728
+ templateDetails: TemplateDetails | undefined;
729
+ }
730
+ /**
731
+ * @public
732
+ */
733
+ export interface CreateStarterMappingTemplateResponse {
734
+ /**
735
+ * <p>Returns a string that represents the mapping template.</p>
736
+ * @public
737
+ */
738
+ mappingTemplate: string | undefined;
739
+ }
647
740
  /**
648
741
  * @public
649
742
  */
@@ -716,6 +809,202 @@ export interface ListTagsForResourceResponse {
716
809
  */
717
810
  Tags?: Tag[];
718
811
  }
812
+ /**
813
+ * <p>In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
814
+ * The delimiters are part of the message's syntax and divide up its different elements.</p>
815
+ * @public
816
+ */
817
+ export interface X12Delimiters {
818
+ /**
819
+ * <p>The component, or sub-element, separator. The default value is <code>:</code> (colon).</p>
820
+ * @public
821
+ */
822
+ componentSeparator?: string;
823
+ /**
824
+ * <p>The data element separator. The default value is <code>*</code> (asterisk).</p>
825
+ * @public
826
+ */
827
+ dataElementSeparator?: string;
828
+ /**
829
+ * <p>The segment terminator. The default value is <code>~</code> (tilde).</p>
830
+ * @public
831
+ */
832
+ segmentTerminator?: string;
833
+ }
834
+ /**
835
+ * <p>Part of the X12 message structure. These are the functional group headers for the X12 EDI object.</p>
836
+ * @public
837
+ */
838
+ export interface X12FunctionalGroupHeaders {
839
+ /**
840
+ * <p>A value representing the code used to identify the party transmitting a message, at position GS-02.</p>
841
+ * @public
842
+ */
843
+ applicationSenderCode?: string;
844
+ /**
845
+ * <p>A value representing the code used to identify the party receiving a message, at position GS-03.</p>
846
+ * @public
847
+ */
848
+ applicationReceiverCode?: string;
849
+ /**
850
+ * <p>A code that identifies the issuer of the standard, at position GS-07.</p>
851
+ * @public
852
+ */
853
+ responsibleAgencyCode?: string;
854
+ }
855
+ /**
856
+ * <p>In X12, the Interchange Control Header is the first segment of an EDI document and is
857
+ * part of the Interchange Envelope. It contains information about the sender and receiver,
858
+ * the date and time of transmission, and the X12 version being used. It also includes
859
+ * delivery information, such as the sender and receiver IDs.</p>
860
+ * @public
861
+ */
862
+ export interface X12InterchangeControlHeaders {
863
+ /**
864
+ * <p>Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.</p>
865
+ * @public
866
+ */
867
+ senderIdQualifier?: string;
868
+ /**
869
+ * <p>Located at position ISA-06 in the header. This value (along with the <code>senderIdQualifier</code>) identifies the sender of the interchange. </p>
870
+ * @public
871
+ */
872
+ senderId?: string;
873
+ /**
874
+ * <p>Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.</p>
875
+ * @public
876
+ */
877
+ receiverIdQualifier?: string;
878
+ /**
879
+ * <p>Located at position ISA-08 in the header. This value (along with the <code>receiverIdQualifier</code>) identifies the intended recipient of the interchange. </p>
880
+ * @public
881
+ */
882
+ receiverId?: string;
883
+ /**
884
+ * <p>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.</p>
885
+ * <note>
886
+ * <p>This parameter is only honored for version greater than 401 (<code>VERSION_4010</code> and higher).</p>
887
+ * <p>For versions less than 401, this field is called <a href="https://www.stedi.com/edi/x12-004010/segment/ISA#ISA-11">StandardsId</a>, in which case our service
888
+ * sets the value to <code>U</code>.</p>
889
+ * </note>
890
+ * @public
891
+ */
892
+ repetitionSeparator?: string;
893
+ /**
894
+ * <p>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.</p>
895
+ * @public
896
+ */
897
+ acknowledgmentRequestedCode?: string;
898
+ /**
899
+ * <p>Located at position ISA-15 in the header. Specifies how this interchange is being used:</p>
900
+ * <ul>
901
+ * <li>
902
+ * <p>
903
+ * <code>T</code> indicates this interchange is for testing.</p>
904
+ * </li>
905
+ * <li>
906
+ * <p>
907
+ * <code>P</code> indicates this interchange is for production.</p>
908
+ * </li>
909
+ * <li>
910
+ * <p>
911
+ * <code>I</code> indicates this interchange is informational.</p>
912
+ * </li>
913
+ * </ul>
914
+ * @public
915
+ */
916
+ usageIndicatorCode?: string;
917
+ }
918
+ /**
919
+ * <p>A structure containing the details for an outbound EDI object.</p>
920
+ * @public
921
+ */
922
+ export interface X12OutboundEdiHeaders {
923
+ /**
924
+ * <p>In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.</p>
925
+ * @public
926
+ */
927
+ interchangeControlHeaders?: X12InterchangeControlHeaders;
928
+ /**
929
+ * <p>The functional group headers for the X12 object.</p>
930
+ * @public
931
+ */
932
+ functionalGroupHeaders?: X12FunctionalGroupHeaders;
933
+ /**
934
+ * <p>The delimiters, for example semicolon (<code>;</code>), that separates sections of the headers for the X12 object.</p>
935
+ * @public
936
+ */
937
+ delimiters?: X12Delimiters;
938
+ /**
939
+ * <p>Specifies whether or not to validate the EDI for this X12 object: <code>TRUE</code> or <code>FALSE</code>.</p>
940
+ * @public
941
+ */
942
+ validateEdi?: boolean;
943
+ }
944
+ /**
945
+ * <p>A wrapper structure for an X12 definition object.</p>
946
+ * <p>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:</p>
947
+ * <ul>
948
+ * <li>
949
+ * <p>Interchange Envelope</p>
950
+ * </li>
951
+ * <li>
952
+ * <p>Functional Group</p>
953
+ * </li>
954
+ * <li>
955
+ * <p>Transaction Set</p>
956
+ * </li>
957
+ * </ul>
958
+ * @public
959
+ */
960
+ export interface X12Envelope {
961
+ /**
962
+ * <p>A container for the X12 outbound EDI headers.</p>
963
+ * @public
964
+ */
965
+ common?: X12OutboundEdiHeaders;
966
+ }
967
+ /**
968
+ * <p>A container for outbound EDI options.</p>
969
+ * @public
970
+ */
971
+ export type OutboundEdiOptions = OutboundEdiOptions.X12Member | OutboundEdiOptions.$UnknownMember;
972
+ /**
973
+ * @public
974
+ */
975
+ export declare namespace OutboundEdiOptions {
976
+ /**
977
+ * <p>A structure that contains an X12 envelope structure.</p>
978
+ * @public
979
+ */
980
+ interface X12Member {
981
+ x12: X12Envelope;
982
+ $unknown?: never;
983
+ }
984
+ /**
985
+ * @public
986
+ */
987
+ interface $UnknownMember {
988
+ x12?: never;
989
+ $unknown: [string, any];
990
+ }
991
+ interface Visitor<T> {
992
+ x12: (value: X12Envelope) => T;
993
+ _: (name: string, value: any) => T;
994
+ }
995
+ const visit: <T>(value: OutboundEdiOptions, visitor: Visitor<T>) => T;
996
+ }
997
+ /**
998
+ * <p>Contains the details for an Outbound EDI capability.</p>
999
+ * @public
1000
+ */
1001
+ export interface CapabilityOptions {
1002
+ /**
1003
+ * <p>A structure that contains the outbound EDI options.</p>
1004
+ * @public
1005
+ */
1006
+ outboundEdi?: OutboundEdiOptions;
1007
+ }
719
1008
  /**
720
1009
  * @public
721
1010
  */
@@ -745,6 +1034,11 @@ export interface CreatePartnershipRequest {
745
1034
  * @public
746
1035
  */
747
1036
  capabilities: string[] | undefined;
1037
+ /**
1038
+ * <p>Specify the structure that contains the details for the associated capabilities.</p>
1039
+ * @public
1040
+ */
1041
+ capabilityOptions?: CapabilityOptions;
748
1042
  /**
749
1043
  * <p>Reserved for future use.</p>
750
1044
  * @public
@@ -795,6 +1089,11 @@ export interface CreatePartnershipResponse {
795
1089
  * @public
796
1090
  */
797
1091
  capabilities?: string[];
1092
+ /**
1093
+ * <p>Returns the structure that contains the details for the associated capabilities.</p>
1094
+ * @public
1095
+ */
1096
+ capabilityOptions?: CapabilityOptions;
798
1097
  /**
799
1098
  * <p>Returns the unique, system-generated identifier for a trading partner.</p>
800
1099
  * @public
@@ -865,6 +1164,11 @@ export interface GetPartnershipResponse {
865
1164
  * @public
866
1165
  */
867
1166
  capabilities?: string[];
1167
+ /**
1168
+ * <p>Contains the details for an Outbound EDI capability.</p>
1169
+ * @public
1170
+ */
1171
+ capabilityOptions?: CapabilityOptions;
868
1172
  /**
869
1173
  * <p>Returns the unique identifier for the partner for this partnership.</p>
870
1174
  * @public
@@ -928,6 +1232,11 @@ export interface PartnershipSummary {
928
1232
  * @public
929
1233
  */
930
1234
  capabilities?: string[];
1235
+ /**
1236
+ * <p>Contains the details for an Outbound EDI capability.</p>
1237
+ * @public
1238
+ */
1239
+ capabilityOptions?: CapabilityOptions;
931
1240
  /**
932
1241
  * <p>Returns the unique, system-generated identifier for a trading partner.</p>
933
1242
  * @public
@@ -979,6 +1288,11 @@ export interface UpdatePartnershipRequest {
979
1288
  * @public
980
1289
  */
981
1290
  capabilities?: string[];
1291
+ /**
1292
+ * <p>To update, specify the structure that contains the details for the associated capabilities.</p>
1293
+ * @public
1294
+ */
1295
+ capabilityOptions?: CapabilityOptions;
982
1296
  }
983
1297
  /**
984
1298
  * @public
@@ -1019,6 +1333,11 @@ export interface UpdatePartnershipResponse {
1019
1333
  * @public
1020
1334
  */
1021
1335
  capabilities?: string[];
1336
+ /**
1337
+ * <p>Returns the structure that contains the details for the associated capabilities.</p>
1338
+ * @public
1339
+ */
1340
+ capabilityOptions?: CapabilityOptions;
1022
1341
  /**
1023
1342
  * <p>Returns the unique, system-generated identifier for a trading partner.</p>
1024
1343
  * @public
@@ -1425,103 +1744,420 @@ export interface TagResourceRequest {
1425
1744
  * @public
1426
1745
  * @enum
1427
1746
  */
1428
- export declare const FileFormat: {
1747
+ export declare const ConversionSourceFormat: {
1429
1748
  readonly JSON: "JSON";
1430
1749
  readonly XML: "XML";
1431
1750
  };
1432
1751
  /**
1433
1752
  * @public
1434
1753
  */
1435
- export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat];
1754
+ export type ConversionSourceFormat = (typeof ConversionSourceFormat)[keyof typeof ConversionSourceFormat];
1436
1755
  /**
1756
+ * <p>The input file to use for an outbound transformation.</p>
1437
1757
  * @public
1438
1758
  */
1439
- export interface TestMappingRequest {
1440
- /**
1441
- * <p>Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.</p>
1442
- * @public
1443
- */
1444
- inputFileContent: string | undefined;
1759
+ export type InputFileSource = InputFileSource.FileContentMember | InputFileSource.$UnknownMember;
1760
+ /**
1761
+ * @public
1762
+ */
1763
+ export declare namespace InputFileSource {
1445
1764
  /**
1446
- * <p>Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
1765
+ * <p>Specify the input contents, as a string, for the source of an outbound transformation.</p>
1447
1766
  * @public
1448
1767
  */
1449
- mappingTemplate: string | undefined;
1768
+ interface FileContentMember {
1769
+ fileContent: string;
1770
+ $unknown?: never;
1771
+ }
1450
1772
  /**
1451
- * <p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
1452
1773
  * @public
1453
1774
  */
1454
- fileFormat: FileFormat | undefined;
1775
+ interface $UnknownMember {
1776
+ fileContent?: never;
1777
+ $unknown: [string, any];
1778
+ }
1779
+ interface Visitor<T> {
1780
+ fileContent: (value: string) => T;
1781
+ _: (name: string, value: any) => T;
1782
+ }
1783
+ const visit: <T>(value: InputFileSource, visitor: Visitor<T>) => T;
1455
1784
  }
1456
1785
  /**
1786
+ * <p>Describes the input for an outbound transformation. </p>
1457
1787
  * @public
1458
1788
  */
1459
- export interface TestMappingResponse {
1789
+ export interface ConversionSource {
1460
1790
  /**
1461
- * <p>Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint</p>
1791
+ * <p>The format for the input file: either JSON or XML.</p>
1462
1792
  * @public
1463
1793
  */
1464
- mappedFileContent: string | undefined;
1794
+ fileFormat: ConversionSourceFormat | undefined;
1795
+ /**
1796
+ * File to be converted
1797
+ * @public
1798
+ */
1799
+ inputFile: InputFileSource | undefined;
1465
1800
  }
1466
1801
  /**
1467
1802
  * @public
1803
+ * @enum
1468
1804
  */
1469
- export interface TestParsingRequest {
1470
- /**
1471
- * <p>Specifies an <code>S3Location</code> object, which contains the Amazon S3 bucket and prefix for the location of the input file.</p>
1472
- * @public
1473
- */
1474
- inputFile: S3Location | undefined;
1805
+ export declare const ConversionTargetFormat: {
1806
+ readonly X12: "X12";
1807
+ };
1808
+ /**
1809
+ * @public
1810
+ */
1811
+ export type ConversionTargetFormat = (typeof ConversionTargetFormat)[keyof typeof ConversionTargetFormat];
1812
+ /**
1813
+ * <p>Contains a structure describing the X12 details for the conversion target.</p>
1814
+ * @public
1815
+ */
1816
+ export type ConversionTargetFormatDetails = ConversionTargetFormatDetails.X12Member | ConversionTargetFormatDetails.$UnknownMember;
1817
+ /**
1818
+ * @public
1819
+ */
1820
+ export declare namespace ConversionTargetFormatDetails {
1475
1821
  /**
1476
- * <p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
1822
+ * <p>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.</p>
1823
+ * <note>
1824
+ * <p>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.</p>
1825
+ * </note>
1477
1826
  * @public
1478
1827
  */
1479
- fileFormat: FileFormat | undefined;
1828
+ interface X12Member {
1829
+ x12: X12Details;
1830
+ $unknown?: never;
1831
+ }
1480
1832
  /**
1481
- * <p>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.</p>
1482
1833
  * @public
1483
1834
  */
1484
- ediType: EdiType | undefined;
1835
+ interface $UnknownMember {
1836
+ x12?: never;
1837
+ $unknown: [string, any];
1838
+ }
1839
+ interface Visitor<T> {
1840
+ x12: (value: X12Details) => T;
1841
+ _: (name: string, value: any) => T;
1842
+ }
1843
+ const visit: <T>(value: ConversionTargetFormatDetails, visitor: Visitor<T>) => T;
1485
1844
  }
1486
1845
  /**
1846
+ * <p>Container for the location of a sample file used for outbound transformations.</p>
1487
1847
  * @public
1488
1848
  */
1489
- export interface TestParsingResponse {
1490
- /**
1491
- * <p>Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.</p>
1492
- * @public
1493
- */
1494
- parsedFileContent: string | undefined;
1495
- }
1849
+ export type OutputSampleFileSource = OutputSampleFileSource.FileLocationMember | OutputSampleFileSource.$UnknownMember;
1496
1850
  /**
1497
1851
  * @public
1498
1852
  */
1499
- export interface CreateTransformerRequest {
1853
+ export declare namespace OutputSampleFileSource {
1500
1854
  /**
1501
- * <p>Specifies the name of the transformer, used to identify it.</p>
1855
+ * <p>Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File
1856
+ * locations in Amazon S3 are identified using a combination of the bucket and key.</p>
1502
1857
  * @public
1503
1858
  */
1504
- name: string | undefined;
1859
+ interface FileLocationMember {
1860
+ fileLocation: S3Location;
1861
+ $unknown?: never;
1862
+ }
1505
1863
  /**
1506
- * <p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
1507
1864
  * @public
1508
1865
  */
1509
- fileFormat: FileFormat | undefined;
1866
+ interface $UnknownMember {
1867
+ fileLocation?: never;
1868
+ $unknown: [string, any];
1869
+ }
1870
+ interface Visitor<T> {
1871
+ fileLocation: (value: S3Location) => T;
1872
+ _: (name: string, value: any) => T;
1873
+ }
1874
+ const visit: <T>(value: OutputSampleFileSource, visitor: Visitor<T>) => T;
1875
+ }
1876
+ /**
1877
+ * <p>Provide a sample of what the output of the transformation should look like.</p>
1878
+ * @public
1879
+ */
1880
+ export interface ConversionTarget {
1881
+ /**
1882
+ * <p>Currently, only X12 format is supported.</p>
1883
+ * @public
1884
+ */
1885
+ fileFormat: ConversionTargetFormat | undefined;
1886
+ /**
1887
+ * <p>A structure that contains the formatting details for the conversion target.</p>
1888
+ * @public
1889
+ */
1890
+ formatDetails?: ConversionTargetFormatDetails;
1891
+ /**
1892
+ * Customer uses this to provide a sample on what should file look like after conversion
1893
+ * X12 EDI use case around this would be discovering the file syntax
1894
+ * @public
1895
+ */
1896
+ outputSampleFile?: OutputSampleFileSource;
1897
+ }
1898
+ /**
1899
+ * @public
1900
+ */
1901
+ export interface TestConversionRequest {
1902
+ /**
1903
+ * <p>Specify the source file for an outbound EDI request.</p>
1904
+ * @public
1905
+ */
1906
+ source: ConversionSource | undefined;
1907
+ /**
1908
+ * <p>Specify the format (X12 is the only currently supported format), and other details for the conversion target.</p>
1909
+ * @public
1910
+ */
1911
+ target: ConversionTarget | undefined;
1912
+ }
1913
+ /**
1914
+ * @public
1915
+ */
1916
+ export interface TestConversionResponse {
1917
+ /**
1918
+ * <p>Returns the converted file content.</p>
1919
+ * @public
1920
+ */
1921
+ convertedFileContent: string | undefined;
1922
+ /**
1923
+ * <p>Returns an array of strings, each containing a message that Amazon Web Services B2B Data Interchange generates during the conversion.</p>
1924
+ * @public
1925
+ */
1926
+ validationMessages?: string[];
1927
+ }
1928
+ /**
1929
+ * @public
1930
+ * @enum
1931
+ */
1932
+ export declare const FileFormat: {
1933
+ readonly JSON: "JSON";
1934
+ readonly NOT_USED: "NOT_USED";
1935
+ readonly XML: "XML";
1936
+ };
1937
+ /**
1938
+ * @public
1939
+ */
1940
+ export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat];
1941
+ /**
1942
+ * @public
1943
+ */
1944
+ export interface TestMappingRequest {
1945
+ /**
1946
+ * <p>Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.</p>
1947
+ * @public
1948
+ */
1949
+ inputFileContent: string | undefined;
1510
1950
  /**
1511
1951
  * <p>Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
1952
+ * <note>
1953
+ * <p>This parameter is available for backwards compatibility. Use the <a href="https://docs.aws.amazon.com/b2bi/latest/APIReference/API_Mapping.html">Mapping</a> data type instead.</p>
1954
+ * </note>
1512
1955
  * @public
1513
1956
  */
1514
1957
  mappingTemplate: string | undefined;
1958
+ /**
1959
+ * <p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
1960
+ * @public
1961
+ */
1962
+ fileFormat: FileFormat | undefined;
1963
+ }
1964
+ /**
1965
+ * @public
1966
+ */
1967
+ export interface TestMappingResponse {
1968
+ /**
1969
+ * <p>Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint</p>
1970
+ * @public
1971
+ */
1972
+ mappedFileContent: string | undefined;
1973
+ }
1974
+ /**
1975
+ * @public
1976
+ */
1977
+ export interface TestParsingRequest {
1978
+ /**
1979
+ * <p>Specifies an <code>S3Location</code> object, which contains the Amazon S3 bucket and prefix for the location of the input file.</p>
1980
+ * @public
1981
+ */
1982
+ inputFile: S3Location | undefined;
1983
+ /**
1984
+ * <p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
1985
+ * @public
1986
+ */
1987
+ fileFormat: FileFormat | undefined;
1515
1988
  /**
1516
1989
  * <p>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.</p>
1517
1990
  * @public
1518
1991
  */
1519
1992
  ediType: EdiType | undefined;
1993
+ }
1994
+ /**
1995
+ * @public
1996
+ */
1997
+ export interface TestParsingResponse {
1520
1998
  /**
1521
- * <p>Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
1999
+ * <p>Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.</p>
1522
2000
  * @public
1523
2001
  */
1524
- sampleDocument?: string;
2002
+ parsedFileContent: string | undefined;
2003
+ }
2004
+ /**
2005
+ * <p>A structure that contains the X12 transaction set and version.</p>
2006
+ * @public
2007
+ */
2008
+ export type FormatOptions = FormatOptions.X12Member | FormatOptions.$UnknownMember;
2009
+ /**
2010
+ * @public
2011
+ */
2012
+ export declare namespace FormatOptions {
2013
+ /**
2014
+ * <p>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.</p>
2015
+ * <note>
2016
+ * <p>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.</p>
2017
+ * </note>
2018
+ * @public
2019
+ */
2020
+ interface X12Member {
2021
+ x12: X12Details;
2022
+ $unknown?: never;
2023
+ }
2024
+ /**
2025
+ * @public
2026
+ */
2027
+ interface $UnknownMember {
2028
+ x12?: never;
2029
+ $unknown: [string, any];
2030
+ }
2031
+ interface Visitor<T> {
2032
+ x12: (value: X12Details) => T;
2033
+ _: (name: string, value: any) => T;
2034
+ }
2035
+ const visit: <T>(value: FormatOptions, visitor: Visitor<T>) => T;
2036
+ }
2037
+ /**
2038
+ * @public
2039
+ * @enum
2040
+ */
2041
+ export declare const FromFormat: {
2042
+ readonly X12: "X12";
2043
+ };
2044
+ /**
2045
+ * @public
2046
+ */
2047
+ export type FromFormat = (typeof FromFormat)[keyof typeof FromFormat];
2048
+ /**
2049
+ * <p>Contains the input formatting options for an inbound transformer (takes an X12-formatted
2050
+ * EDI document as input and converts it to JSON or XML.</p>
2051
+ * @public
2052
+ */
2053
+ export interface InputConversion {
2054
+ /**
2055
+ * <p>The format for the transformer input: currently on <code>X12</code> is supported.</p>
2056
+ * @public
2057
+ */
2058
+ fromFormat: FromFormat | undefined;
2059
+ /**
2060
+ * <p>A structure that contains the formatting options for an inbound transformer.</p>
2061
+ * @public
2062
+ */
2063
+ formatOptions?: FormatOptions;
2064
+ }
2065
+ /**
2066
+ * @public
2067
+ * @enum
2068
+ */
2069
+ export declare const MappingTemplateLanguage: {
2070
+ readonly JSONATA: "JSONATA";
2071
+ readonly XSLT: "XSLT";
2072
+ };
2073
+ /**
2074
+ * @public
2075
+ */
2076
+ export type MappingTemplateLanguage = (typeof MappingTemplateLanguage)[keyof typeof MappingTemplateLanguage];
2077
+ /**
2078
+ * <p>Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
2079
+ * @public
2080
+ */
2081
+ export interface Mapping {
2082
+ /**
2083
+ * <p>The transformation language for the template, either XSLT or JSONATA.</p>
2084
+ * @public
2085
+ */
2086
+ templateLanguage: MappingTemplateLanguage | undefined;
2087
+ /**
2088
+ * <p>A string that represents the mapping template, in the transformation language specified in <code>templateLanguage</code>.</p>
2089
+ * @public
2090
+ */
2091
+ template?: string;
2092
+ }
2093
+ /**
2094
+ * @public
2095
+ * @enum
2096
+ */
2097
+ export declare const ToFormat: {
2098
+ readonly X12: "X12";
2099
+ };
2100
+ /**
2101
+ * @public
2102
+ */
2103
+ export type ToFormat = (typeof ToFormat)[keyof typeof ToFormat];
2104
+ /**
2105
+ * <p>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).</p>
2106
+ * @public
2107
+ */
2108
+ export interface OutputConversion {
2109
+ /**
2110
+ * <p>The format for the output from an outbound transformer: only X12 is currently supported.</p>
2111
+ * @public
2112
+ */
2113
+ toFormat: ToFormat | undefined;
2114
+ /**
2115
+ * <p>A structure that contains the X12 transaction set and version for the transformer output.</p>
2116
+ * @public
2117
+ */
2118
+ formatOptions?: FormatOptions;
2119
+ }
2120
+ /**
2121
+ * <p>An array of the Amazon S3 keys used to identify the location for your sample documents.</p>
2122
+ * @public
2123
+ */
2124
+ export interface SampleDocumentKeys {
2125
+ /**
2126
+ * <p>An array of keys for your input sample documents.</p>
2127
+ * @public
2128
+ */
2129
+ input?: string;
2130
+ /**
2131
+ * <p>An array of keys for your output sample documents.</p>
2132
+ * @public
2133
+ */
2134
+ output?: string;
2135
+ }
2136
+ /**
2137
+ * <p>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.</p>
2138
+ * @public
2139
+ */
2140
+ export interface SampleDocuments {
2141
+ /**
2142
+ * <p>Contains the Amazon S3 bucket that is used to hold your sample documents.</p>
2143
+ * @public
2144
+ */
2145
+ bucketName: string | undefined;
2146
+ /**
2147
+ * <p>Contains an array of the Amazon S3 keys used to identify the location for your sample documents.</p>
2148
+ * @public
2149
+ */
2150
+ keys: SampleDocumentKeys[] | undefined;
2151
+ }
2152
+ /**
2153
+ * @public
2154
+ */
2155
+ export interface CreateTransformerRequest {
2156
+ /**
2157
+ * <p>Specifies the name of the transformer, used to identify it.</p>
2158
+ * @public
2159
+ */
2160
+ name: string | undefined;
1525
2161
  /**
1526
2162
  * <p>Reserved for future use.</p>
1527
2163
  * @public
@@ -1532,6 +2168,57 @@ export interface CreateTransformerRequest {
1532
2168
  * @public
1533
2169
  */
1534
2170
  tags?: Tag[];
2171
+ /**
2172
+ * @deprecated
2173
+ *
2174
+ * <p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
2175
+ * @public
2176
+ */
2177
+ fileFormat?: FileFormat;
2178
+ /**
2179
+ * @deprecated
2180
+ *
2181
+ * <p>Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
2182
+ * <note>
2183
+ * <p>This parameter is available for backwards compatibility. Use the <a href="https://docs.aws.amazon.com/b2bi/latest/APIReference/API_Mapping.html">Mapping</a> data type instead.</p>
2184
+ * </note>
2185
+ * @public
2186
+ */
2187
+ mappingTemplate?: string;
2188
+ /**
2189
+ * @deprecated
2190
+ *
2191
+ * <p>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.</p>
2192
+ * @public
2193
+ */
2194
+ ediType?: EdiType;
2195
+ /**
2196
+ * @deprecated
2197
+ *
2198
+ * <p>Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
2199
+ * @public
2200
+ */
2201
+ sampleDocument?: string;
2202
+ /**
2203
+ * <p>Specify the <code>InputConversion</code> object, which contains the format options for the inbound transformation.</p>
2204
+ * @public
2205
+ */
2206
+ inputConversion?: InputConversion;
2207
+ /**
2208
+ * <p>Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).</p>
2209
+ * @public
2210
+ */
2211
+ mapping?: Mapping;
2212
+ /**
2213
+ * <p>A structure that contains the <code>OutputConversion</code> object, which contains the format options for the outbound transformation.</p>
2214
+ * @public
2215
+ */
2216
+ outputConversion?: OutputConversion;
2217
+ /**
2218
+ * <p>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.</p>
2219
+ * @public
2220
+ */
2221
+ sampleDocuments?: SampleDocuments;
1535
2222
  }
1536
2223
  /**
1537
2224
  * @public
@@ -1565,37 +2252,65 @@ export interface CreateTransformerResponse {
1565
2252
  */
1566
2253
  name: string | undefined;
1567
2254
  /**
1568
- * <p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
2255
+ * <p>Returns the state of the newly created transformer. The transformer can be either
2256
+ * <code>active</code> or <code>inactive</code>. For the transformer to be used in a
2257
+ * capability, its status must <code>active</code>.</p>
1569
2258
  * @public
1570
2259
  */
1571
- fileFormat: FileFormat | undefined;
2260
+ status: TransformerStatus | undefined;
1572
2261
  /**
1573
- * <p>Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
2262
+ * <p>Returns a timestamp for creation date and time of the transformer.</p>
1574
2263
  * @public
1575
2264
  */
1576
- mappingTemplate: string | undefined;
2265
+ createdAt: Date | undefined;
1577
2266
  /**
1578
- * <p>Returns the state of the newly created transformer. The transformer can be either
1579
- * <code>active</code> or <code>inactive</code>. For the transformer to be used in a
1580
- * capability, its status must <code>active</code>.</p>
2267
+ * @deprecated
2268
+ *
2269
+ * <p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
1581
2270
  * @public
1582
2271
  */
1583
- status: TransformerStatus | undefined;
2272
+ fileFormat?: FileFormat;
1584
2273
  /**
2274
+ * @deprecated
2275
+ *
2276
+ * <p>Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
2277
+ * @public
2278
+ */
2279
+ mappingTemplate?: string;
2280
+ /**
2281
+ * @deprecated
2282
+ *
1585
2283
  * <p>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.</p>
1586
2284
  * @public
1587
2285
  */
1588
- ediType: EdiType | undefined;
2286
+ ediType?: EdiType;
1589
2287
  /**
2288
+ * @deprecated
2289
+ *
1590
2290
  * <p>Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
1591
2291
  * @public
1592
2292
  */
1593
2293
  sampleDocument?: string;
1594
2294
  /**
1595
- * <p>Returns a timestamp for creation date and time of the transformer.</p>
2295
+ * <p>Returns the <code>InputConversion</code> object, which contains the format options for the inbound transformation.</p>
1596
2296
  * @public
1597
2297
  */
1598
- createdAt: Date | undefined;
2298
+ inputConversion?: InputConversion;
2299
+ /**
2300
+ * <p>Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).</p>
2301
+ * @public
2302
+ */
2303
+ mapping?: Mapping;
2304
+ /**
2305
+ * <p>Returns the <code>OutputConversion</code> object, which contains the format options for the outbound transformation.</p>
2306
+ * @public
2307
+ */
2308
+ outputConversion?: OutputConversion;
2309
+ /**
2310
+ * <p>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.</p>
2311
+ * @public
2312
+ */
2313
+ sampleDocuments?: SampleDocuments;
1599
2314
  }
1600
2315
  /**
1601
2316
  * @public
@@ -1637,42 +2352,70 @@ export interface GetTransformerResponse {
1637
2352
  */
1638
2353
  name: string | undefined;
1639
2354
  /**
1640
- * <p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
2355
+ * <p>Returns the state of the newly created transformer. The transformer can be either
2356
+ * <code>active</code> or <code>inactive</code>. For the transformer to be used in a
2357
+ * capability, its status must <code>active</code>.</p>
1641
2358
  * @public
1642
2359
  */
1643
- fileFormat: FileFormat | undefined;
2360
+ status: TransformerStatus | undefined;
1644
2361
  /**
1645
- * <p>Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
2362
+ * <p>Returns a timestamp for creation date and time of the transformer.</p>
1646
2363
  * @public
1647
2364
  */
1648
- mappingTemplate: string | undefined;
2365
+ createdAt: Date | undefined;
1649
2366
  /**
1650
- * <p>Returns the state of the newly created transformer. The transformer can be either
1651
- * <code>active</code> or <code>inactive</code>. For the transformer to be used in a
1652
- * capability, its status must <code>active</code>.</p>
2367
+ * <p>Returns a timestamp for last time the transformer was modified.</p>
1653
2368
  * @public
1654
2369
  */
1655
- status: TransformerStatus | undefined;
2370
+ modifiedAt?: Date;
2371
+ /**
2372
+ * @deprecated
2373
+ *
2374
+ * <p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
2375
+ * @public
2376
+ */
2377
+ fileFormat?: FileFormat;
2378
+ /**
2379
+ * @deprecated
2380
+ *
2381
+ * <p>Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
2382
+ * @public
2383
+ */
2384
+ mappingTemplate?: string;
1656
2385
  /**
2386
+ * @deprecated
2387
+ *
1657
2388
  * <p>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.</p>
1658
2389
  * @public
1659
2390
  */
1660
- ediType: EdiType | undefined;
2391
+ ediType?: EdiType;
1661
2392
  /**
2393
+ * @deprecated
2394
+ *
1662
2395
  * <p>Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
1663
2396
  * @public
1664
2397
  */
1665
2398
  sampleDocument?: string;
1666
2399
  /**
1667
- * <p>Returns a timestamp for creation date and time of the transformer.</p>
2400
+ * <p>Returns the <code>InputConversion</code> object, which contains the format options for the inbound transformation.</p>
1668
2401
  * @public
1669
2402
  */
1670
- createdAt: Date | undefined;
2403
+ inputConversion?: InputConversion;
1671
2404
  /**
1672
- * <p>Returns a timestamp for last time the transformer was modified.</p>
2405
+ * <p>Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).</p>
1673
2406
  * @public
1674
2407
  */
1675
- modifiedAt?: Date;
2408
+ mapping?: Mapping;
2409
+ /**
2410
+ * <p>Returns the <code>OutputConversion</code> object, which contains the format options for the outbound transformation.</p>
2411
+ * @public
2412
+ */
2413
+ outputConversion?: OutputConversion;
2414
+ /**
2415
+ * <p>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.</p>
2416
+ * @public
2417
+ */
2418
+ sampleDocuments?: SampleDocuments;
1676
2419
  }
1677
2420
  /**
1678
2421
  * @public
@@ -1691,9 +2434,8 @@ export interface ListTransformersRequest {
1691
2434
  maxResults?: number;
1692
2435
  }
1693
2436
  /**
1694
- * <p>Contains the details for a transformer object. A transformer
1695
- * describes how to process the incoming EDI documents and extract the necessary
1696
- * information to the output file.</p>
2437
+ * <p>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,
2438
+ * a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.</p>
1697
2439
  * @public
1698
2440
  */
1699
2441
  export interface TransformerSummary {
@@ -1708,43 +2450,71 @@ export interface TransformerSummary {
1708
2450
  */
1709
2451
  name: string | undefined;
1710
2452
  /**
1711
- * <p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
2453
+ * <p>Returns the state of the newly created transformer. The transformer can be either
2454
+ * <code>active</code> or <code>inactive</code>. For the transformer to be used in a
2455
+ * capability, its status must <code>active</code>.</p>
1712
2456
  * @public
1713
2457
  */
1714
- fileFormat: FileFormat | undefined;
2458
+ status: TransformerStatus | undefined;
1715
2459
  /**
1716
- * <p>Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
2460
+ * <p>Returns a timestamp indicating when the transformer was created. For example,
2461
+ * <code>2023-07-20T19:58:44.624Z</code>.</p>
1717
2462
  * @public
1718
2463
  */
1719
- mappingTemplate: string | undefined;
2464
+ createdAt: Date | undefined;
1720
2465
  /**
1721
- * <p>Returns the state of the newly created transformer. The transformer can be either
1722
- * <code>active</code> or <code>inactive</code>. For the transformer to be used in a
1723
- * capability, its status must <code>active</code>.</p>
2466
+ * <p>Returns a timestamp representing the date and time for the most recent change for the transformer object.</p>
1724
2467
  * @public
1725
2468
  */
1726
- status: TransformerStatus | undefined;
2469
+ modifiedAt?: Date;
1727
2470
  /**
2471
+ * @deprecated
2472
+ *
2473
+ * <p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
2474
+ * @public
2475
+ */
2476
+ fileFormat?: FileFormat;
2477
+ /**
2478
+ * @deprecated
2479
+ *
2480
+ * <p>Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
2481
+ * @public
2482
+ */
2483
+ mappingTemplate?: string;
2484
+ /**
2485
+ * @deprecated
2486
+ *
1728
2487
  * <p>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.</p>
1729
2488
  * @public
1730
2489
  */
1731
- ediType: EdiType | undefined;
2490
+ ediType?: EdiType;
1732
2491
  /**
2492
+ * @deprecated
2493
+ *
1733
2494
  * <p>Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
1734
2495
  * @public
1735
2496
  */
1736
2497
  sampleDocument?: string;
1737
2498
  /**
1738
- * <p>Returns a timestamp indicating when the transformer was created. For example,
1739
- * <code>2023-07-20T19:58:44.624Z</code>.</p>
2499
+ * <p>Returns a structure that contains the format options for the transformation.</p>
1740
2500
  * @public
1741
2501
  */
1742
- createdAt: Date | undefined;
2502
+ inputConversion?: InputConversion;
1743
2503
  /**
1744
- * <p>Returns a timestamp representing the date and time for the most recent change for the transformer object.</p>
2504
+ * <p>Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).</p>
1745
2505
  * @public
1746
2506
  */
1747
- modifiedAt?: Date;
2507
+ mapping?: Mapping;
2508
+ /**
2509
+ * <p>Returns the <code>OutputConversion</code> object, which contains the format options for the outbound transformation.</p>
2510
+ * @public
2511
+ */
2512
+ outputConversion?: OutputConversion;
2513
+ /**
2514
+ * <p>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.</p>
2515
+ * @public
2516
+ */
2517
+ sampleDocuments?: SampleDocuments;
1748
2518
  }
1749
2519
  /**
1750
2520
  * @public
@@ -1779,30 +2549,61 @@ export interface UpdateTransformerRequest {
1779
2549
  */
1780
2550
  name?: string;
1781
2551
  /**
2552
+ * <p>Specifies the transformer's status. You can update the state of the transformer, from <code>active</code> to <code>inactive</code>, or <code>inactive</code> to <code>active</code>.</p>
2553
+ * @public
2554
+ */
2555
+ status?: TransformerStatus;
2556
+ /**
2557
+ * @deprecated
2558
+ *
1782
2559
  * <p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
1783
2560
  * @public
1784
2561
  */
1785
2562
  fileFormat?: FileFormat;
1786
2563
  /**
2564
+ * @deprecated
2565
+ *
1787
2566
  * <p>Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
2567
+ * <note>
2568
+ * <p>This parameter is available for backwards compatibility. Use the <a href="https://docs.aws.amazon.com/b2bi/latest/APIReference/API_Mapping.html">Mapping</a> data type instead.</p>
2569
+ * </note>
1788
2570
  * @public
1789
2571
  */
1790
2572
  mappingTemplate?: string;
1791
2573
  /**
1792
- * <p>Specifies the transformer's status. You can update the state of the transformer, from <code>active</code> to <code>inactive</code>, or <code>inactive</code> to <code>active</code>.</p>
1793
- * @public
1794
- */
1795
- status?: TransformerStatus;
1796
- /**
2574
+ * @deprecated
2575
+ *
1797
2576
  * <p>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.</p>
1798
2577
  * @public
1799
2578
  */
1800
2579
  ediType?: EdiType;
1801
2580
  /**
2581
+ * @deprecated
2582
+ *
1802
2583
  * <p>Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
1803
2584
  * @public
1804
2585
  */
1805
2586
  sampleDocument?: string;
2587
+ /**
2588
+ * <p>To update, specify the <code>InputConversion</code> object, which contains the format options for the inbound transformation.</p>
2589
+ * @public
2590
+ */
2591
+ inputConversion?: InputConversion;
2592
+ /**
2593
+ * <p>Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).</p>
2594
+ * @public
2595
+ */
2596
+ mapping?: Mapping;
2597
+ /**
2598
+ * <p>To update, specify the <code>OutputConversion</code> object, which contains the format options for the outbound transformation.</p>
2599
+ * @public
2600
+ */
2601
+ outputConversion?: OutputConversion;
2602
+ /**
2603
+ * <p>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.</p>
2604
+ * @public
2605
+ */
2606
+ sampleDocuments?: SampleDocuments;
1806
2607
  }
1807
2608
  /**
1808
2609
  * @public
@@ -1824,42 +2625,70 @@ export interface UpdateTransformerResponse {
1824
2625
  */
1825
2626
  name: string | undefined;
1826
2627
  /**
1827
- * <p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
2628
+ * <p>Returns the state of the newly created transformer. The transformer can be either
2629
+ * <code>active</code> or <code>inactive</code>. For the transformer to be used in a
2630
+ * capability, its status must <code>active</code>.</p>
1828
2631
  * @public
1829
2632
  */
1830
- fileFormat: FileFormat | undefined;
2633
+ status: TransformerStatus | undefined;
1831
2634
  /**
1832
- * <p>Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
2635
+ * <p>Returns a timestamp for creation date and time of the transformer.</p>
1833
2636
  * @public
1834
2637
  */
1835
- mappingTemplate: string | undefined;
2638
+ createdAt: Date | undefined;
1836
2639
  /**
1837
- * <p>Returns the state of the newly created transformer. The transformer can be either
1838
- * <code>active</code> or <code>inactive</code>. For the transformer to be used in a
1839
- * capability, its status must <code>active</code>.</p>
2640
+ * <p>Returns a timestamp for last time the transformer was modified.</p>
1840
2641
  * @public
1841
2642
  */
1842
- status: TransformerStatus | undefined;
2643
+ modifiedAt: Date | undefined;
2644
+ /**
2645
+ * @deprecated
2646
+ *
2647
+ * <p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
2648
+ * @public
2649
+ */
2650
+ fileFormat?: FileFormat;
1843
2651
  /**
2652
+ * @deprecated
2653
+ *
2654
+ * <p>Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>
2655
+ * @public
2656
+ */
2657
+ mappingTemplate?: string;
2658
+ /**
2659
+ * @deprecated
2660
+ *
1844
2661
  * <p>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.</p>
1845
2662
  * @public
1846
2663
  */
1847
- ediType: EdiType | undefined;
2664
+ ediType?: EdiType;
1848
2665
  /**
2666
+ * @deprecated
2667
+ *
1849
2668
  * <p>Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>
1850
2669
  * @public
1851
2670
  */
1852
2671
  sampleDocument?: string;
1853
2672
  /**
1854
- * <p>Returns a timestamp for creation date and time of the transformer.</p>
2673
+ * <p>Returns the <code>InputConversion</code> object, which contains the format options for the inbound transformation.</p>
1855
2674
  * @public
1856
2675
  */
1857
- createdAt: Date | undefined;
2676
+ inputConversion?: InputConversion;
1858
2677
  /**
1859
- * <p>Returns a timestamp for last time the transformer was modified.</p>
2678
+ * <p>Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).</p>
1860
2679
  * @public
1861
2680
  */
1862
- modifiedAt: Date | undefined;
2681
+ mapping?: Mapping;
2682
+ /**
2683
+ * <p>Returns the <code>OutputConversion</code> object, which contains the format options for the outbound transformation.</p>
2684
+ * @public
2685
+ */
2686
+ outputConversion?: OutputConversion;
2687
+ /**
2688
+ * <p>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.</p>
2689
+ * @public
2690
+ */
2691
+ sampleDocuments?: SampleDocuments;
1863
2692
  }
1864
2693
  /**
1865
2694
  * @public