aws-sdk-b2bi 1.0.0 → 1.2.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0b5f87e70e189cdfdd262ae824638223966dee53f49206c4c786f988996cb7ce
4
- data.tar.gz: 5ba44b02415f14fc1306fe343b8734b08034788ad148fd8d10117da6f9ac277f
3
+ metadata.gz: 5a83c50c08435033fa539268b9978cf604567bc915ed9776065caf028e5d5b67
4
+ data.tar.gz: 436a23c7679dcde90db5a3e13d227916e054179c743e3eb0506042c13a9ec5d4
5
5
  SHA512:
6
- metadata.gz: d8f315913339a9df0c1d1497b2a14afe5eb7f56bb628eb1b436db7f55ca5c1ff751026a025dd2fd5bde8f76024061eaca7be41150ba86f812823b47db241dd32
7
- data.tar.gz: b2eab28d44bb9e2cf08b8b25f983dd0e8d5e299558312d7ba2d2ecc3303d34af74a99b18184f18e8a0a79f02159d60dd99dc3b1985c35df7f1264e558efd934a
6
+ metadata.gz: b707bdd1804f1fb19a36fde509e23425ba3cbb69d022c3bfce0eedb685b0e7469c2c9a44039693695071c63c1d7ccb2d46164dce93c7f8c2b66299ab7ffae6f5
7
+ data.tar.gz: 94f7f30f8013e1e9f12ef177d2b166bac72e4aeb4af43997a04105751d5e0a1d4fb1c688f071a86038d37011d9b95d910f0e4e6684ead129607efe5cca4b9ea8
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.2.0 (2023-12-14)
5
+ ------------------
6
+
7
+ * Feature - Documentation updates for AWS B2B Data Interchange
8
+
9
+ 1.1.0 (2023-11-28)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
4
14
  1.0.0 (2023-11-27)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.0
1
+ 1.2.0
@@ -398,9 +398,9 @@ module Aws::B2bi
398
398
 
399
399
  # @!group API Operations
400
400
 
401
- # Instantiates a capability based on the specified parameters.
402
- # Capabilities contain the information necessary to process incoming EDI
403
- # (electronic data interchange) documents.
401
+ # Instantiates a capability based on the specified parameters. A trading
402
+ # capability contains the information required to transform incoming EDI
403
+ # documents into JSON or XML outputs.
404
404
  #
405
405
  # @option params [required, String] :name
406
406
  # Specifies the name of the capability, used to identify it.
@@ -438,80 +438,6 @@ module Aws::B2bi
438
438
  # * {Types::CreateCapabilityResponse#instructions_documents #instructions_documents} => Array<Types::S3Location>
439
439
  # * {Types::CreateCapabilityResponse#created_at #created_at} => Time
440
440
  #
441
- #
442
- # @example Example: Sample CreateCapability call
443
- #
444
- # resp = client.create_capability({
445
- # name: "b2biexample",
446
- # type: "edi",
447
- # client_token: "foo",
448
- # configuration: {
449
- # edi: {
450
- # type: {
451
- # x12_details: {
452
- # version: "VERSION_4010",
453
- # transaction_set: "X12_110",
454
- # },
455
- # },
456
- # input_location: {
457
- # key: "input/",
458
- # bucket_name: "test-bucket",
459
- # },
460
- # output_location: {
461
- # key: "output/",
462
- # bucket_name: "test-bucket",
463
- # },
464
- # transformer_id: "tr-9a893cf536df4658b",
465
- # },
466
- # },
467
- # instructions_documents: [
468
- # {
469
- # key: "instructiondoc.txt",
470
- # bucket_name: "test-bucket",
471
- # },
472
- # ],
473
- # tags: [
474
- # {
475
- # key: "capabilityKey1",
476
- # value: "capabilityValue1",
477
- # },
478
- # ],
479
- # })
480
- #
481
- # resp.to_h outputs the following:
482
- # {
483
- # name: "b2biexample",
484
- # type: "edi",
485
- # capability_arn: "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348",
486
- # capability_id: "ca-963a8121e4fc4e348",
487
- # configuration: {
488
- # edi: {
489
- # type: {
490
- # x12_details: {
491
- # version: "VERSION_4010",
492
- # transaction_set: "X12_110",
493
- # },
494
- # },
495
- # input_location: {
496
- # key: "input/",
497
- # bucket_name: "test-bucket",
498
- # },
499
- # output_location: {
500
- # key: "output/",
501
- # bucket_name: "test-bucket",
502
- # },
503
- # transformer_id: "tr-9a893cf536df4658b",
504
- # },
505
- # },
506
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
507
- # instructions_documents: [
508
- # {
509
- # key: "instructiondoc.txt",
510
- # bucket_name: "test-bucket",
511
- # },
512
- # ],
513
- # }
514
- #
515
441
  # @example Request syntax with placeholder values
516
442
  #
517
443
  # resp = client.create_capability({
@@ -579,10 +505,9 @@ module Aws::B2bi
579
505
  end
580
506
 
581
507
  # Creates a partnership between a customer and a trading partner, based
582
- # on the supplied parameters. Partnerships link trading partners with
583
- # your profile and a specific transformer, so that the EDI (electronic
584
- # data interchange) documents that they upload to Amazon S3 can be
585
- # processed according to their specifications.
508
+ # on the supplied parameters. A partnership represents the connection
509
+ # between you and your trading partner. It ties together a profile and
510
+ # one or more trading capabilities.
586
511
  #
587
512
  # @option params [required, String] :profile_id
588
513
  # Specifies the unique, system-generated identifier for the profile
@@ -623,41 +548,6 @@ module Aws::B2bi
623
548
  # * {Types::CreatePartnershipResponse#trading_partner_id #trading_partner_id} => String
624
549
  # * {Types::CreatePartnershipResponse#created_at #created_at} => Time
625
550
  #
626
- #
627
- # @example Example: Sample CreatePartnership call
628
- #
629
- # resp = client.create_partnership({
630
- # name: "b2bipartner",
631
- # capabilities: [
632
- # "ca-963a8121e4fc4e348",
633
- # ],
634
- # client_token: "foo",
635
- # email: "john@example.com",
636
- # phone: "5555555555",
637
- # profile_id: "p-60fbc37c87f04fce9",
638
- # tags: [
639
- # {
640
- # key: "sampleKey1",
641
- # value: "sampleValue1",
642
- # },
643
- # ],
644
- # })
645
- #
646
- # resp.to_h outputs the following:
647
- # {
648
- # name: "b2bipartner",
649
- # capabilities: [
650
- # "ca-963a8121e4fc4e348",
651
- # ],
652
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
653
- # email: "john@example.com",
654
- # partnership_arn: "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9",
655
- # partnership_id: "ps-219fa02f5b4242af8",
656
- # phone: "5555555555",
657
- # profile_id: "p-60fbc37c87f04fce9",
658
- # trading_partner_id: "tp-2a17ca447f6f4a8a8",
659
- # }
660
- #
661
551
  # @example Request syntax with placeholder values
662
552
  #
663
553
  # resp = client.create_partnership({
@@ -698,8 +588,8 @@ module Aws::B2bi
698
588
  end
699
589
 
700
590
  # Creates a customer profile. You can have up to five customer profiles,
701
- # each representing a distinct private network. Profiles contain basic
702
- # information about you and your business.
591
+ # each representing a distinct private network. A profile is the
592
+ # mechanism used to create the concept of a private network.
703
593
  #
704
594
  # @option params [required, String] :name
705
595
  # Specifies the name of the profile.
@@ -739,37 +629,6 @@ module Aws::B2bi
739
629
  # * {Types::CreateProfileResponse#log_group_name #log_group_name} => String
740
630
  # * {Types::CreateProfileResponse#created_at #created_at} => Time
741
631
  #
742
- #
743
- # @example Example: Sample CreateProfile call
744
- #
745
- # resp = client.create_profile({
746
- # name: "Shipping Profile",
747
- # business_name: "John's Shipping",
748
- # client_token: "foo",
749
- # email: "john@example.com",
750
- # logging: "ENABLED",
751
- # phone: "5555555555",
752
- # tags: [
753
- # {
754
- # key: "sampleKey",
755
- # value: "sampleValue",
756
- # },
757
- # ],
758
- # })
759
- #
760
- # resp.to_h outputs the following:
761
- # {
762
- # name: "Shipping Profile",
763
- # business_name: "John's Trucking",
764
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
765
- # email: "john@example.com",
766
- # log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs",
767
- # logging: "ENABLED",
768
- # phone: "5555555555",
769
- # profile_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
770
- # profile_id: "p-60fbc37c87f04fce9",
771
- # }
772
- #
773
632
  # @example Request syntax with placeholder values
774
633
  #
775
634
  # resp = client.create_profile({
@@ -808,9 +667,9 @@ module Aws::B2bi
808
667
  req.send_request(options)
809
668
  end
810
669
 
811
- # Creates a transformer. Transformers describe how to process the
812
- # incoming EDI (electronic data interchange) documents, and extract the
813
- # necessary information.
670
+ # Creates a transformer. A transformer describes how to process the
671
+ # incoming EDI documents and extract the necessary information to the
672
+ # output file.
814
673
  #
815
674
  # @option params [required, String] :name
816
675
  # Specifies the name of the transformer, used to identify it.
@@ -857,47 +716,6 @@ module Aws::B2bi
857
716
  # * {Types::CreateTransformerResponse#sample_document #sample_document} => String
858
717
  # * {Types::CreateTransformerResponse#created_at #created_at} => Time
859
718
  #
860
- #
861
- # @example Example: Sample CreateTransformer call
862
- #
863
- # resp = client.create_transformer({
864
- # name: "transformJSON",
865
- # client_token: "foo",
866
- # edi_type: {
867
- # x12_details: {
868
- # version: "VERSION_4010",
869
- # transaction_set: "X12_110",
870
- # },
871
- # },
872
- # file_format: "JSON",
873
- # mapping_template: "{}",
874
- # sample_document: "s3://test-bucket/sampleDoc.txt",
875
- # tags: [
876
- # {
877
- # key: "sampleKey",
878
- # value: "sampleValue",
879
- # },
880
- # ],
881
- # })
882
- #
883
- # resp.to_h outputs the following:
884
- # {
885
- # name: "transformJSON",
886
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
887
- # edi_type: {
888
- # x12_details: {
889
- # version: "VERSION_4010",
890
- # transaction_set: "X12_110",
891
- # },
892
- # },
893
- # file_format: "JSON",
894
- # mapping_template: "$",
895
- # sample_document: "s3://test-bucket/sampleDoc.txt",
896
- # status: "inactive",
897
- # transformer_arn: "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9",
898
- # transformer_id: "tr-974c129999f84d8c9",
899
- # }
900
- #
901
719
  # @example Request syntax with placeholder values
902
720
  #
903
721
  # resp = client.create_transformer({
@@ -942,22 +760,15 @@ module Aws::B2bi
942
760
  req.send_request(options)
943
761
  end
944
762
 
945
- # Deletes the specified capability. Capabilities contain the information
946
- # necessary to process incoming EDI (electronic data interchange)
947
- # documents.
763
+ # Deletes the specified capability. A trading capability contains the
764
+ # information required to transform incoming EDI documents into JSON or
765
+ # XML outputs.
948
766
  #
949
767
  # @option params [required, String] :capability_id
950
768
  # Specifies a system-assigned unique identifier for the capability.
951
769
  #
952
770
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
953
771
  #
954
- #
955
- # @example Example: Sample DeleteCapabilty call
956
- #
957
- # resp = client.delete_capability({
958
- # capability_id: "ca-963a8121e4fc4e348",
959
- # })
960
- #
961
772
  # @example Request syntax with placeholder values
962
773
  #
963
774
  # resp = client.delete_capability({
@@ -973,23 +784,15 @@ module Aws::B2bi
973
784
  req.send_request(options)
974
785
  end
975
786
 
976
- # Deletes the specified partnership. Partnerships link trading partners
977
- # with your profile and a specific transformer, so that the EDI
978
- # (electronic data interchange) documents that they upload to Amazon S3
979
- # can be processed according to their specifications.
787
+ # Deletes the specified partnership. A partnership represents the
788
+ # connection between you and your trading partner. It ties together a
789
+ # profile and one or more trading capabilities.
980
790
  #
981
791
  # @option params [required, String] :partnership_id
982
792
  # Specifies the unique, system-generated identifier for a partnership.
983
793
  #
984
794
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
985
795
  #
986
- #
987
- # @example Example: Sample DeletePartnership call
988
- #
989
- # resp = client.delete_partnership({
990
- # partnership_id: "ps-219fa02f5b4242af8",
991
- # })
992
- #
993
796
  # @example Request syntax with placeholder values
994
797
  #
995
798
  # resp = client.delete_partnership({
@@ -1005,21 +808,14 @@ module Aws::B2bi
1005
808
  req.send_request(options)
1006
809
  end
1007
810
 
1008
- # Deletes the specified profile. Profiles contain basic information
1009
- # about you and your business.
811
+ # Deletes the specified profile. A profile is the mechanism used to
812
+ # create the concept of a private network.
1010
813
  #
1011
814
  # @option params [required, String] :profile_id
1012
815
  # Specifies the unique, system-generated identifier for the profile.
1013
816
  #
1014
817
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1015
818
  #
1016
- #
1017
- # @example Example: Sample DeleteProfile call
1018
- #
1019
- # resp = client.delete_profile({
1020
- # profile_id: "p-60fbc37c87f04fce9",
1021
- # })
1022
- #
1023
819
  # @example Request syntax with placeholder values
1024
820
  #
1025
821
  # resp = client.delete_profile({
@@ -1035,22 +831,15 @@ module Aws::B2bi
1035
831
  req.send_request(options)
1036
832
  end
1037
833
 
1038
- # Deletes the specified transformer. Transformers describe how to
1039
- # process the incoming EDI (electronic data interchange) documents, and
1040
- # extract the necessary information.
834
+ # Deletes the specified transformer. A transformer describes how to
835
+ # process the incoming EDI documents and extract the necessary
836
+ # information to the output file.
1041
837
  #
1042
838
  # @option params [required, String] :transformer_id
1043
839
  # Specifies the system-assigned unique identifier for the transformer.
1044
840
  #
1045
841
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1046
842
  #
1047
- #
1048
- # @example Example: Sample DeleteTransformer call
1049
- #
1050
- # resp = client.delete_transformer({
1051
- # transformer_id: "tr-974c129999f84d8c9",
1052
- # })
1053
- #
1054
843
  # @example Request syntax with placeholder values
1055
844
  #
1056
845
  # resp = client.delete_transformer({
@@ -1066,9 +855,9 @@ module Aws::B2bi
1066
855
  req.send_request(options)
1067
856
  end
1068
857
 
1069
- # Retrieves the details for the specified capability. Capabilities
1070
- # contain the information necessary to process incoming EDI (electronic
1071
- # data interchange) documents.
858
+ # Retrieves the details for the specified capability. A trading
859
+ # capability contains the information required to transform incoming EDI
860
+ # documents into JSON or XML outputs.
1072
861
  #
1073
862
  # @option params [required, String] :capability_id
1074
863
  # Specifies a system-assigned unique identifier for the capability.
@@ -1084,48 +873,6 @@ module Aws::B2bi
1084
873
  # * {Types::GetCapabilityResponse#created_at #created_at} => Time
1085
874
  # * {Types::GetCapabilityResponse#modified_at #modified_at} => Time
1086
875
  #
1087
- #
1088
- # @example Example: Sample GetCapabilty call
1089
- #
1090
- # resp = client.get_capability({
1091
- # capability_id: "ca-963a8121e4fc4e348",
1092
- # })
1093
- #
1094
- # resp.to_h outputs the following:
1095
- # {
1096
- # name: "b2biexample",
1097
- # type: "edi",
1098
- # capability_arn: "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348",
1099
- # capability_id: "ca-963a8121e4fc4e348",
1100
- # configuration: {
1101
- # edi: {
1102
- # type: {
1103
- # x12_details: {
1104
- # version: "VERSION_4010",
1105
- # transaction_set: "X12_110",
1106
- # },
1107
- # },
1108
- # input_location: {
1109
- # key: "input/",
1110
- # bucket_name: "test-bucket",
1111
- # },
1112
- # output_location: {
1113
- # key: "output/",
1114
- # bucket_name: "test-bucket",
1115
- # },
1116
- # transformer_id: "tr-9a893cf536df4658b",
1117
- # },
1118
- # },
1119
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
1120
- # instructions_documents: [
1121
- # {
1122
- # key: "instructiondoc.txt",
1123
- # bucket_name: "test-bucket",
1124
- # },
1125
- # ],
1126
- # modified_at: Time.parse("2023-11-02T21:51:05.504Z"),
1127
- # }
1128
- #
1129
876
  # @example Request syntax with placeholder values
1130
877
  #
1131
878
  # resp = client.get_capability({
@@ -1161,10 +908,9 @@ module Aws::B2bi
1161
908
  end
1162
909
 
1163
910
  # Retrieves the details for a partnership, based on the partner and
1164
- # profile IDs specified. Partnerships link trading partners with your
1165
- # profile and a specific transformer, so that the EDI (electronic data
1166
- # interchange) documents that they upload to Amazon S3 can be processed
1167
- # according to their specifications.
911
+ # profile IDs specified. A partnership represents the connection between
912
+ # you and your trading partner. It ties together a profile and one or
913
+ # more trading capabilities.
1168
914
  #
1169
915
  # @option params [required, String] :partnership_id
1170
916
  # Specifies the unique, system-generated identifier for a partnership.
@@ -1182,29 +928,6 @@ module Aws::B2bi
1182
928
  # * {Types::GetPartnershipResponse#created_at #created_at} => Time
1183
929
  # * {Types::GetPartnershipResponse#modified_at #modified_at} => Time
1184
930
  #
1185
- #
1186
- # @example Example: Sample GetPartnership call
1187
- #
1188
- # resp = client.get_partnership({
1189
- # partnership_id: "ps-219fa02f5b4242af8",
1190
- # })
1191
- #
1192
- # resp.to_h outputs the following:
1193
- # {
1194
- # name: "b2bipartner",
1195
- # capabilities: [
1196
- # "ca-963a8121e4fc4e348",
1197
- # ],
1198
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
1199
- # email: "john@example.com",
1200
- # modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
1201
- # partnership_arn: "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-219fa02f5b4242af8",
1202
- # partnership_id: "ps-219fa02f5b4242af8",
1203
- # phone: "5555555555",
1204
- # profile_id: "p-60fbc37c87f04fce9",
1205
- # trading_partner_id: "tp-2a17ca447f6f4a8a8",
1206
- # }
1207
- #
1208
931
  # @example Request syntax with placeholder values
1209
932
  #
1210
933
  # resp = client.get_partnership({
@@ -1234,8 +957,9 @@ module Aws::B2bi
1234
957
  req.send_request(options)
1235
958
  end
1236
959
 
1237
- # Retrieves the details for the profile specified by the profile ID.
1238
- # Profiles contain basic information about you and your business.
960
+ # Retrieves the details for the profile specified by the profile ID. A
961
+ # profile is the mechanism used to create the concept of a private
962
+ # network.
1239
963
  #
1240
964
  # @option params [required, String] :profile_id
1241
965
  # Specifies the unique, system-generated identifier for the profile.
@@ -1253,26 +977,6 @@ module Aws::B2bi
1253
977
  # * {Types::GetProfileResponse#created_at #created_at} => Time
1254
978
  # * {Types::GetProfileResponse#modified_at #modified_at} => Time
1255
979
  #
1256
- #
1257
- # @example Example: Sample GetProfile call
1258
- #
1259
- # resp = client.get_profile({
1260
- # profile_id: "p-60fbc37c87f04fce9",
1261
- # })
1262
- #
1263
- # resp.to_h outputs the following:
1264
- # {
1265
- # name: "Shipping Profile",
1266
- # business_name: "John's Trucking",
1267
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
1268
- # email: "john@example.com",
1269
- # log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs",
1270
- # logging: "ENABLED",
1271
- # phone: "5555555555",
1272
- # profile_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
1273
- # profile_id: "p-60fbc37c87f04fce9",
1274
- # }
1275
- #
1276
980
  # @example Request syntax with placeholder values
1277
981
  #
1278
982
  # resp = client.get_profile({
@@ -1302,8 +1006,8 @@ module Aws::B2bi
1302
1006
  end
1303
1007
 
1304
1008
  # Retrieves the details for the transformer specified by the transformer
1305
- # ID. Transformers describe how to process the incoming EDI (electronic
1306
- # data interchange) documents, and extract the necessary information.
1009
+ # ID. A transformer describes how to process the incoming EDI documents
1010
+ # and extract the necessary information to the output file.
1307
1011
  #
1308
1012
  # @option params [required, String] :transformer_id
1309
1013
  # Specifies the system-assigned unique identifier for the transformer.
@@ -1321,32 +1025,6 @@ module Aws::B2bi
1321
1025
  # * {Types::GetTransformerResponse#created_at #created_at} => Time
1322
1026
  # * {Types::GetTransformerResponse#modified_at #modified_at} => Time
1323
1027
  #
1324
- #
1325
- # @example Example: Sample GetTransformer call
1326
- #
1327
- # resp = client.get_transformer({
1328
- # transformer_id: "tr-974c129999f84d8c9",
1329
- # })
1330
- #
1331
- # resp.to_h outputs the following:
1332
- # {
1333
- # name: "transformJSON",
1334
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
1335
- # edi_type: {
1336
- # x12_details: {
1337
- # version: "VERSION_4010",
1338
- # transaction_set: "X12_110",
1339
- # },
1340
- # },
1341
- # file_format: "JSON",
1342
- # mapping_template: "$",
1343
- # modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
1344
- # sample_document: "s3://test-bucket/sampleDoc.txt",
1345
- # status: "inactive",
1346
- # transformer_arn: "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9",
1347
- # transformer_id: "tr-974c129999f84d8c9",
1348
- # }
1349
- #
1350
1028
  # @example Request syntax with placeholder values
1351
1029
  #
1352
1030
  # resp = client.get_transformer({
@@ -1392,26 +1070,6 @@ module Aws::B2bi
1392
1070
  # * {Types::GetTransformerJobResponse#output_files #output_files} => Array<Types::S3Location>
1393
1071
  # * {Types::GetTransformerJobResponse#message #message} => String
1394
1072
  #
1395
- #
1396
- # @example Example: Sample GetTransformerJob call
1397
- #
1398
- # resp = client.get_transformer_job({
1399
- # transformer_id: "tr-974c129999f84d8c9",
1400
- # transformer_job_id: "tj-vpYxfV7yQOqjMSYllEslLw",
1401
- # })
1402
- #
1403
- # resp.to_h outputs the following:
1404
- # {
1405
- # message: "Transformed, writing output",
1406
- # output_files: [
1407
- # {
1408
- # key: "output/sample-214.edi.2023-11-01T10:44:03.353Z.json",
1409
- # bucket_name: "gt-edi-test",
1410
- # },
1411
- # ],
1412
- # status: "succeeded",
1413
- # }
1414
- #
1415
1073
  # @example Request syntax with placeholder values
1416
1074
  #
1417
1075
  # resp = client.get_transformer_job({
@@ -1437,9 +1095,9 @@ module Aws::B2bi
1437
1095
  end
1438
1096
 
1439
1097
  # Lists the capabilities associated with your Amazon Web Services
1440
- # account for your current or specified region. Capabilities contain the
1441
- # information necessary to process incoming EDI (electronic data
1442
- # interchange) documents.
1098
+ # account for your current or specified region. A trading capability
1099
+ # contains the information required to transform incoming EDI documents
1100
+ # into JSON or XML outputs.
1443
1101
  #
1444
1102
  # @option params [String] :next_token
1445
1103
  # When additional results are obtained from the command, a `NextToken`
@@ -1457,28 +1115,6 @@ module Aws::B2bi
1457
1115
  #
1458
1116
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1459
1117
  #
1460
- #
1461
- # @example Example: Sample ListCapabilities call
1462
- #
1463
- # resp = client.list_capabilities({
1464
- # max_results: 50,
1465
- # next_token: "foo",
1466
- # })
1467
- #
1468
- # resp.to_h outputs the following:
1469
- # {
1470
- # capabilities: [
1471
- # {
1472
- # name: "b2biexample",
1473
- # type: "edi",
1474
- # capability_id: "ca-963a8121e4fc4e348",
1475
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
1476
- # modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
1477
- # },
1478
- # ],
1479
- # next_token: "foo",
1480
- # }
1481
- #
1482
1118
  # @example Request syntax with placeholder values
1483
1119
  #
1484
1120
  # resp = client.list_capabilities({
@@ -1506,10 +1142,9 @@ module Aws::B2bi
1506
1142
  end
1507
1143
 
1508
1144
  # Lists the partnerships associated with your Amazon Web Services
1509
- # account for your current or specified region. Partnerships link
1510
- # trading partners with your profile and a specific transformer, so that
1511
- # the EDI (electronic data interchange) documents that they upload to
1512
- # Amazon S3 can be processed according to their specifications.
1145
+ # account for your current or specified region. A partnership represents
1146
+ # the connection between you and your trading partner. It ties together
1147
+ # a profile and one or more trading capabilities.
1513
1148
  #
1514
1149
  # @option params [String] :profile_id
1515
1150
  # Specifies the unique, system-generated identifier for the profile
@@ -1531,33 +1166,6 @@ module Aws::B2bi
1531
1166
  #
1532
1167
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1533
1168
  #
1534
- #
1535
- # @example Example: Sample ListPartnerships call
1536
- #
1537
- # resp = client.list_partnerships({
1538
- # max_results: 50,
1539
- # next_token: "foo",
1540
- # profile_id: "p-60fbc37c87f04fce9",
1541
- # })
1542
- #
1543
- # resp.to_h outputs the following:
1544
- # {
1545
- # next_token: "string",
1546
- # partnerships: [
1547
- # {
1548
- # name: "b2bipartner",
1549
- # capabilities: [
1550
- # "ca-963a8121e4fc4e348",
1551
- # ],
1552
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
1553
- # modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
1554
- # partnership_id: "ps-219fa02f5b4242af8",
1555
- # profile_id: "p-60fbc37c87f04fce9",
1556
- # trading_partner_id: "tp-2a17ca447f6f4a8a8",
1557
- # },
1558
- # ],
1559
- # }
1560
- #
1561
1169
  # @example Request syntax with placeholder values
1562
1170
  #
1563
1171
  # resp = client.list_partnerships({
@@ -1589,8 +1197,8 @@ module Aws::B2bi
1589
1197
  end
1590
1198
 
1591
1199
  # Lists the profiles associated with your Amazon Web Services account
1592
- # for your current or specified region. Profiles contain basic
1593
- # information about you and your business.
1200
+ # for your current or specified region. A profile is the mechanism used
1201
+ # to create the concept of a private network.
1594
1202
  #
1595
1203
  # @option params [String] :next_token
1596
1204
  # When additional results are obtained from the command, a `NextToken`
@@ -1608,29 +1216,6 @@ module Aws::B2bi
1608
1216
  #
1609
1217
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1610
1218
  #
1611
- #
1612
- # @example Example: Sample ListProfiles call
1613
- #
1614
- # resp = client.list_profiles({
1615
- # max_results: 50,
1616
- # next_token: "foo",
1617
- # })
1618
- #
1619
- # resp.to_h outputs the following:
1620
- # {
1621
- # next_token: "foo",
1622
- # profiles: [
1623
- # {
1624
- # name: "Shipping Profile",
1625
- # business_name: "John's Trucking",
1626
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
1627
- # log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs",
1628
- # logging: "ENABLED",
1629
- # profile_id: "p-60fbc37c87f04fce9",
1630
- # },
1631
- # ],
1632
- # }
1633
- #
1634
1219
  # @example Request syntax with placeholder values
1635
1220
  #
1636
1221
  # resp = client.list_profiles({
@@ -1672,23 +1257,6 @@ module Aws::B2bi
1672
1257
  #
1673
1258
  # * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
1674
1259
  #
1675
- #
1676
- # @example Example: Sample ListTagsForResources call
1677
- #
1678
- # resp = client.list_tags_for_resource({
1679
- # resource_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
1680
- # })
1681
- #
1682
- # resp.to_h outputs the following:
1683
- # {
1684
- # tags: [
1685
- # {
1686
- # key: "sampleKey",
1687
- # value: "SampleValue",
1688
- # },
1689
- # ],
1690
- # }
1691
- #
1692
1260
  # @example Request syntax with placeholder values
1693
1261
  #
1694
1262
  # resp = client.list_tags_for_resource({
@@ -1710,9 +1278,9 @@ module Aws::B2bi
1710
1278
  req.send_request(options)
1711
1279
  end
1712
1280
 
1713
- # Lists the available transformers. Transformers describe how to process
1714
- # the incoming EDI (electronic data interchange) documents, and extract
1715
- # the necessary information.
1281
+ # Lists the available transformers. A transformer describes how to
1282
+ # process the incoming EDI documents and extract the necessary
1283
+ # information to the output file.
1716
1284
  #
1717
1285
  # @option params [String] :next_token
1718
1286
  # When additional results are obtained from the command, a `NextToken`
@@ -1730,37 +1298,6 @@ module Aws::B2bi
1730
1298
  #
1731
1299
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1732
1300
  #
1733
- #
1734
- # @example Example: Sample ListTransformers call
1735
- #
1736
- # resp = client.list_transformers({
1737
- # max_results: 50,
1738
- # next_token: "foo",
1739
- # })
1740
- #
1741
- # resp.to_h outputs the following:
1742
- # {
1743
- # next_token: "foo",
1744
- # transformers: [
1745
- # {
1746
- # name: "transformJSON",
1747
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
1748
- # edi_type: {
1749
- # x12_details: {
1750
- # version: "VERSION_4010",
1751
- # transaction_set: "X12_110",
1752
- # },
1753
- # },
1754
- # file_format: "JSON",
1755
- # mapping_template: "$",
1756
- # modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
1757
- # sample_document: "s3://test-bucket/sampleDoc.txt",
1758
- # status: "inactive",
1759
- # transformer_id: "tr-974c129999f84d8c9",
1760
- # },
1761
- # ],
1762
- # }
1763
- #
1764
1301
  # @example Request syntax with placeholder values
1765
1302
  #
1766
1303
  # resp = client.list_transformers({
@@ -1796,6 +1333,11 @@ module Aws::B2bi
1796
1333
  # interchange) file into the output structures used by Amazon Web
1797
1334
  # Services B2BI Data Interchange.
1798
1335
  #
1336
+ # If you only want to transform EDI (electronic data interchange)
1337
+ # documents, you don't need to create profiles, partnerships or
1338
+ # capabilities. Just create and configure a transformer, and then run
1339
+ # the `StartTransformerJob` API to process your files.
1340
+ #
1799
1341
  # @option params [required, Types::S3Location] :input_file
1800
1342
  # Specifies the location of the input file for the transformation. The
1801
1343
  # location consists of an Amazon S3 bucket and prefix.
@@ -1817,27 +1359,6 @@ module Aws::B2bi
1817
1359
  #
1818
1360
  # * {Types::StartTransformerJobResponse#transformer_job_id #transformer_job_id} => String
1819
1361
  #
1820
- #
1821
- # @example Example: Sample StartTransformerJob call
1822
- #
1823
- # resp = client.start_transformer_job({
1824
- # client_token: "foo",
1825
- # input_file: {
1826
- # key: "input/inputFile.txt",
1827
- # bucket_name: "test-bucket",
1828
- # },
1829
- # output_location: {
1830
- # key: "output/",
1831
- # bucket_name: "test-bucket",
1832
- # },
1833
- # transformer_id: "tr-974c129999f84d8c9",
1834
- # })
1835
- #
1836
- # resp.to_h outputs the following:
1837
- # {
1838
- # transformer_job_id: "tj-vpYxfV7yQOqjMSYllEslLw",
1839
- # }
1840
- #
1841
1362
  # @example Request syntax with placeholder values
1842
1363
  #
1843
1364
  # resp = client.start_transformer_job({
@@ -1884,19 +1405,6 @@ module Aws::B2bi
1884
1405
  #
1885
1406
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1886
1407
  #
1887
- #
1888
- # @example Example: Sample TagResource call
1889
- #
1890
- # resp = client.tag_resource({
1891
- # resource_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
1892
- # tags: [
1893
- # {
1894
- # key: "sampleKey",
1895
- # value: "SampleValue",
1896
- # },
1897
- # ],
1898
- # })
1899
- #
1900
1408
  # @example Request syntax with placeholder values
1901
1409
  #
1902
1410
  # resp = client.tag_resource({
@@ -1918,11 +1426,14 @@ module Aws::B2bi
1918
1426
  req.send_request(options)
1919
1427
  end
1920
1428
 
1921
- # Maps the input file according to the provided template file.
1429
+ # Maps the input file according to the provided template file. The API
1430
+ # call downloads the file contents from the Amazon S3 location, and
1431
+ # passes the contents in as a string, to the `inputFileContent`
1432
+ # parameter.
1922
1433
  #
1923
1434
  # @option params [required, String] :input_file_content
1924
- # Specify the EDI (electronic data interchange) file that is used as
1925
- # input for the transform.
1435
+ # Specify the contents of the EDI (electronic data interchange) XML or
1436
+ # JSON file that is used as input for the transform.
1926
1437
  #
1927
1438
  # @option params [required, String] :mapping_template
1928
1439
  # Specifies the name of the mapping template for the transformer. This
@@ -1937,20 +1448,6 @@ module Aws::B2bi
1937
1448
  #
1938
1449
  # * {Types::TestMappingResponse#mapped_file_content #mapped_file_content} => String
1939
1450
  #
1940
- #
1941
- # @example Example: Sample TestMapping call
1942
- #
1943
- # resp = client.test_mapping({
1944
- # file_format: "JSON",
1945
- # input_file_content: "Sample file content",
1946
- # mapping_template: "$",
1947
- # })
1948
- #
1949
- # resp.to_h outputs the following:
1950
- # {
1951
- # mapped_file_content: "Sample file content",
1952
- # }
1953
- #
1954
1451
  # @example Request syntax with placeholder values
1955
1452
  #
1956
1453
  # resp = client.test_mapping({
@@ -1992,28 +1489,6 @@ module Aws::B2bi
1992
1489
  #
1993
1490
  # * {Types::TestParsingResponse#parsed_file_content #parsed_file_content} => String
1994
1491
  #
1995
- #
1996
- # @example Example: Sample TestParsing call
1997
- #
1998
- # resp = client.test_parsing({
1999
- # edi_type: {
2000
- # x12_details: {
2001
- # version: "VERSION_4010",
2002
- # transaction_set: "X12_110",
2003
- # },
2004
- # },
2005
- # file_format: "JSON",
2006
- # input_file: {
2007
- # key: "sampleFile.txt",
2008
- # bucket_name: "test-bucket",
2009
- # },
2010
- # })
2011
- #
2012
- # resp.to_h outputs the following:
2013
- # {
2014
- # parsed_file_content: "Sample parsed file content",
2015
- # }
2016
- #
2017
1492
  # @example Request syntax with placeholder values
2018
1493
  #
2019
1494
  # resp = client.test_parsing({
@@ -2059,16 +1534,6 @@ module Aws::B2bi
2059
1534
  #
2060
1535
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2061
1536
  #
2062
- #
2063
- # @example Example: Sample UntagResource call
2064
- #
2065
- # resp = client.untag_resource({
2066
- # resource_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
2067
- # tag_keys: [
2068
- # "sampleKey",
2069
- # ],
2070
- # })
2071
- #
2072
1537
  # @example Request syntax with placeholder values
2073
1538
  #
2074
1539
  # resp = client.untag_resource({
@@ -2086,8 +1551,8 @@ module Aws::B2bi
2086
1551
  end
2087
1552
 
2088
1553
  # Updates some of the parameters for a capability, based on the
2089
- # specified parameters. Capabilities contain the information necessary
2090
- # to process incoming EDI (electronic data interchange) documents.
1554
+ # specified parameters. A trading capability contains the information
1555
+ # required to transform incoming EDI documents into JSON or XML outputs.
2091
1556
  #
2092
1557
  # @option params [required, String] :capability_id
2093
1558
  # Specifies a system-assigned unique identifier for the capability.
@@ -2114,74 +1579,6 @@ module Aws::B2bi
2114
1579
  # * {Types::UpdateCapabilityResponse#created_at #created_at} => Time
2115
1580
  # * {Types::UpdateCapabilityResponse#modified_at #modified_at} => Time
2116
1581
  #
2117
- #
2118
- # @example Example: Sample UpdateCapability call
2119
- #
2120
- # resp = client.update_capability({
2121
- # name: "b2biexample",
2122
- # capability_id: "ca-963a8121e4fc4e348",
2123
- # configuration: {
2124
- # edi: {
2125
- # type: {
2126
- # x12_details: {
2127
- # version: "VERSION_4010",
2128
- # transaction_set: "X12_110",
2129
- # },
2130
- # },
2131
- # input_location: {
2132
- # key: "input/",
2133
- # bucket_name: "test-bucket",
2134
- # },
2135
- # output_location: {
2136
- # key: "output/",
2137
- # bucket_name: "test-bucket",
2138
- # },
2139
- # transformer_id: "tr-9a893cf536df4658b",
2140
- # },
2141
- # },
2142
- # instructions_documents: [
2143
- # {
2144
- # key: "instructiondoc.txt",
2145
- # bucket_name: "test-bucket",
2146
- # },
2147
- # ],
2148
- # })
2149
- #
2150
- # resp.to_h outputs the following:
2151
- # {
2152
- # name: "b2biexample",
2153
- # type: "edi",
2154
- # capability_arn: "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348",
2155
- # capability_id: "ca-963a8121e4fc4e348",
2156
- # configuration: {
2157
- # edi: {
2158
- # type: {
2159
- # x12_details: {
2160
- # version: "VERSION_4010",
2161
- # transaction_set: "X12_110",
2162
- # },
2163
- # },
2164
- # input_location: {
2165
- # key: "input/",
2166
- # bucket_name: "test-bucket",
2167
- # },
2168
- # output_location: {
2169
- # key: "output/",
2170
- # bucket_name: "test-bucket",
2171
- # },
2172
- # transformer_id: "tr-9a893cf536df4658b",
2173
- # },
2174
- # },
2175
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
2176
- # instructions_documents: [
2177
- # {
2178
- # key: "instructiondoc.txt",
2179
- # bucket_name: "test-bucket",
2180
- # },
2181
- # ],
2182
- # modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
2183
- # }
2184
- #
2185
1582
  # @example Request syntax with placeholder values
2186
1583
  #
2187
1584
  # resp = client.update_capability({
@@ -2243,10 +1640,9 @@ module Aws::B2bi
2243
1640
  end
2244
1641
 
2245
1642
  # Updates some of the parameters for a partnership between a customer
2246
- # and trading partner. Partnerships link trading partners with your
2247
- # profile and a specific transformer, so that the EDI (electronic data
2248
- # interchange) documents that they upload to Amazon S3 can be processed
2249
- # according to their specifications.
1643
+ # and trading partner. A partnership represents the connection between
1644
+ # you and your trading partner. It ties together a profile and one or
1645
+ # more trading capabilities.
2250
1646
  #
2251
1647
  # @option params [required, String] :partnership_id
2252
1648
  # Specifies the unique, system-generated identifier for a partnership.
@@ -2270,33 +1666,6 @@ module Aws::B2bi
2270
1666
  # * {Types::UpdatePartnershipResponse#created_at #created_at} => Time
2271
1667
  # * {Types::UpdatePartnershipResponse#modified_at #modified_at} => Time
2272
1668
  #
2273
- #
2274
- # @example Example: Sample UpdatePartnership call
2275
- #
2276
- # resp = client.update_partnership({
2277
- # name: "b2bipartner",
2278
- # capabilities: [
2279
- # "ca-963a8121e4fc4e348",
2280
- # ],
2281
- # partnership_id: "ps-219fa02f5b4242af8",
2282
- # })
2283
- #
2284
- # resp.to_h outputs the following:
2285
- # {
2286
- # name: "b2bipartner",
2287
- # capabilities: [
2288
- # "ca-963a8121e4fc4e348",
2289
- # ],
2290
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
2291
- # email: "john@example.com",
2292
- # modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
2293
- # partnership_arn: "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9",
2294
- # partnership_id: "ps-219fa02f5b4242af8",
2295
- # phone: "5555555555",
2296
- # profile_id: "p-60fbc37c87f04fce9",
2297
- # trading_partner_id: "tp-2a17ca447f6f4a8a8",
2298
- # }
2299
- #
2300
1669
  # @example Request syntax with placeholder values
2301
1670
  #
2302
1671
  # resp = client.update_partnership({
@@ -2328,8 +1697,8 @@ module Aws::B2bi
2328
1697
  req.send_request(options)
2329
1698
  end
2330
1699
 
2331
- # Updates the specified parameters for a profile. Profiles contain basic
2332
- # information about you and your business.
1700
+ # Updates the specified parameters for a profile. A profile is the
1701
+ # mechanism used to create the concept of a private network.
2333
1702
  #
2334
1703
  # @option params [required, String] :profile_id
2335
1704
  # Specifies the unique, system-generated identifier for the profile.
@@ -2359,31 +1728,6 @@ module Aws::B2bi
2359
1728
  # * {Types::UpdateProfileResponse#created_at #created_at} => Time
2360
1729
  # * {Types::UpdateProfileResponse#modified_at #modified_at} => Time
2361
1730
  #
2362
- #
2363
- # @example Example: Sample UpdateProfile call
2364
- #
2365
- # resp = client.update_profile({
2366
- # name: "Shipping Profile",
2367
- # business_name: "John's Shipping",
2368
- # email: "john@example.com",
2369
- # phone: "5555555555",
2370
- # profile_id: "p-60fbc37c87f04fce9",
2371
- # })
2372
- #
2373
- # resp.to_h outputs the following:
2374
- # {
2375
- # name: "Shipping Profile",
2376
- # business_name: "John's Trucking",
2377
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
2378
- # email: "john@example.com",
2379
- # log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs",
2380
- # logging: "ENABLED",
2381
- # modified_at: Time.parse("2023-11-02T21:51:05.504Z"),
2382
- # phone: "5555555555",
2383
- # profile_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
2384
- # profile_id: "p-60fbc37c87f04fce9",
2385
- # }
2386
- #
2387
1731
  # @example Request syntax with placeholder values
2388
1732
  #
2389
1733
  # resp = client.update_profile({
@@ -2416,9 +1760,9 @@ module Aws::B2bi
2416
1760
  req.send_request(options)
2417
1761
  end
2418
1762
 
2419
- # Updates the specified parameters for a transformer. Transformers
2420
- # describe how to process the incoming EDI (electronic data interchange)
2421
- # documents, and extract the necessary information.
1763
+ # Updates the specified parameters for a transformer. A transformer
1764
+ # describes how to process the incoming EDI documents and extract the
1765
+ # necessary information to the output file.
2422
1766
  #
2423
1767
  # @option params [required, String] :transformer_id
2424
1768
  # Specifies the system-assigned unique identifier for the transformer.
@@ -2462,43 +1806,6 @@ module Aws::B2bi
2462
1806
  # * {Types::UpdateTransformerResponse#created_at #created_at} => Time
2463
1807
  # * {Types::UpdateTransformerResponse#modified_at #modified_at} => Time
2464
1808
  #
2465
- #
2466
- # @example Example: Sample UpdateTransformer call
2467
- #
2468
- # resp = client.update_transformer({
2469
- # name: "transformJSON",
2470
- # edi_type: {
2471
- # x12_details: {
2472
- # version: "VERSION_4010",
2473
- # transaction_set: "X12_110",
2474
- # },
2475
- # },
2476
- # file_format: "JSON",
2477
- # mapping_template: "{}",
2478
- # sample_document: "s3://test-bucket/sampleDoc.txt",
2479
- # status: "inactive",
2480
- # transformer_id: "tr-974c129999f84d8c9",
2481
- # })
2482
- #
2483
- # resp.to_h outputs the following:
2484
- # {
2485
- # name: "transformJSON",
2486
- # created_at: Time.parse("2023-11-01T21:51:05.504Z"),
2487
- # edi_type: {
2488
- # x12_details: {
2489
- # version: "VERSION_4010",
2490
- # transaction_set: "X12_110",
2491
- # },
2492
- # },
2493
- # file_format: "JSON",
2494
- # mapping_template: "$",
2495
- # modified_at: Time.parse("2023-11-01T21:51:05.504Z"),
2496
- # sample_document: "s3://test-bucket/sampleDoc.txt",
2497
- # status: "inactive",
2498
- # transformer_arn: "arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9",
2499
- # transformer_id: "tr-974c129999f84d8c9",
2500
- # }
2501
- #
2502
1809
  # @example Request syntax with placeholder values
2503
1810
  #
2504
1811
  # resp = client.update_transformer({
@@ -2552,7 +1859,7 @@ module Aws::B2bi
2552
1859
  params: params,
2553
1860
  config: config)
2554
1861
  context[:gem_name] = 'aws-sdk-b2bi'
2555
- context[:gem_version] = '1.0.0'
1862
+ context[:gem_version] = '1.2.0'
2556
1863
  Seahorse::Client::Request.new(handlers, context)
2557
1864
  end
2558
1865
 
@@ -25,16 +25,17 @@ module Aws::B2bi
25
25
  # @api private
26
26
  class Handler < Seahorse::Client::Handler
27
27
  def call(context)
28
- # If endpoint was discovered, do not resolve or apply the endpoint.
29
28
  unless context[:discovered_endpoint]
30
29
  params = parameters_for_operation(context)
31
30
  endpoint = context.config.endpoint_provider.resolve_endpoint(params)
32
31
 
33
32
  context.http_request.endpoint = endpoint.url
34
33
  apply_endpoint_headers(context, endpoint.headers)
34
+
35
+ context[:endpoint_params] = params
36
+ context[:endpoint_properties] = endpoint.properties
35
37
  end
36
38
 
37
- context[:endpoint_params] = params
38
39
  context[:auth_scheme] =
39
40
  Aws::Endpoints.resolve_auth_scheme(context, endpoint)
40
41
 
@@ -24,9 +24,9 @@ module Aws::B2bi
24
24
  end
25
25
 
26
26
  # A capability object. Currently, only EDI (electronic data interchange)
27
- # capabilities are supported. Capabilities contain the information
28
- # necessary to process incoming EDI (electronic data interchange)
29
- # documents.
27
+ # capabilities are supported. A trading capability contains the
28
+ # information required to transform incoming EDI documents into JSON or
29
+ # XML outputs.
30
30
  #
31
31
  # @note CapabilityConfiguration is a union - when making an API calls you must set exactly one of the members.
32
32
  #
@@ -49,9 +49,9 @@ module Aws::B2bi
49
49
  class Unknown < CapabilityConfiguration; end
50
50
  end
51
51
 
52
- # Returns the capability summary details. Capabilities contain the
53
- # information necessary to process incoming EDI (electronic data
54
- # interchange) documents.
52
+ # Returns the capability summary details. A trading capability contains
53
+ # the information required to transform incoming EDI documents into JSON
54
+ # or XML outputs.
55
55
  #
56
56
  # @!attribute [rw] capability_id
57
57
  # Returns a system-assigned unique identifier for the capability.
@@ -1183,10 +1183,9 @@ module Aws::B2bi
1183
1183
  include Aws::Structure
1184
1184
  end
1185
1185
 
1186
- # A structure that contains the details for a partnership. Partnerships
1187
- # link trading partners with your profile and a specific transformer, so
1188
- # that the EDI (electronic data interchange) documents that they upload
1189
- # to Amazon S3 can be processed according to their specifications.
1186
+ # A structure that contains the details for a partnership. A partnership
1187
+ # represents the connection between you and your trading partner. It
1188
+ # ties together a profile and one or more trading capabilities.
1190
1189
  #
1191
1190
  # @!attribute [rw] profile_id
1192
1191
  # Returns the unique, system-generated identifier for the profile
@@ -1233,8 +1232,8 @@ module Aws::B2bi
1233
1232
  include Aws::Structure
1234
1233
  end
1235
1234
 
1236
- # Contains the details for a profile. Profiles contain basic information
1237
- # about you and your business.
1235
+ # Contains the details for a profile. A profile is the mechanism used to
1236
+ # create the concept of a private network.
1238
1237
  #
1239
1238
  # @!attribute [rw] profile_id
1240
1239
  # Returns the unique, system-generated identifier for the profile.
@@ -1447,8 +1446,8 @@ module Aws::B2bi
1447
1446
  end
1448
1447
 
1449
1448
  # @!attribute [rw] input_file_content
1450
- # Specify the EDI (electronic data interchange) file that is used as
1451
- # input for the transform.
1449
+ # Specify the contents of the EDI (electronic data interchange) XML or
1450
+ # JSON file that is used as input for the transform.
1452
1451
  # @return [String]
1453
1452
  #
1454
1453
  # @!attribute [rw] mapping_template
@@ -1544,9 +1543,9 @@ module Aws::B2bi
1544
1543
  include Aws::Structure
1545
1544
  end
1546
1545
 
1547
- # Contains the details for a transformer object. Transformers describe
1548
- # how to process the incoming EDI (electronic data interchange)
1549
- # documents, and extract the necessary information.
1546
+ # Contains the details for a transformer object. A transformer describes
1547
+ # how to process the incoming EDI documents and extract the necessary
1548
+ # information to the output file.
1550
1549
  #
1551
1550
  # @!attribute [rw] transformer_id
1552
1551
  # Returns the system-assigned unique identifier for the transformer.
@@ -2027,6 +2026,12 @@ module Aws::B2bi
2027
2026
  # structure is used when the system transforms an EDI (electronic data
2028
2027
  # interchange) file.
2029
2028
  #
2029
+ # <note markdown="1"> If an EDI input file contains more than one transaction, each
2030
+ # transaction must have the same transaction set and version, for
2031
+ # example 214/4010. If not, the transformer cannot parse the file.
2032
+ #
2033
+ # </note>
2034
+ #
2030
2035
  # @!attribute [rw] transaction_set
2031
2036
  # Returns an enumerated type where each value identifies an X12
2032
2037
  # transaction set. Transaction sets are maintained by the X12
data/lib/aws-sdk-b2bi.rb CHANGED
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-b2bi/customizations'
52
52
  # @!group service
53
53
  module Aws::B2bi
54
54
 
55
- GEM_VERSION = '1.0.0'
55
+ GEM_VERSION = '1.2.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-b2bi
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-11-27 00:00:00.000000000 Z
11
+ date: 2023-12-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core