aws-sdk-b2bi 1.19.0 → 1.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-b2bi/client.rb +682 -111
- data/lib/aws-sdk-b2bi/client_api.rb +242 -24
- data/lib/aws-sdk-b2bi/endpoints.rb +22 -0
- data/lib/aws-sdk-b2bi/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-b2bi/types.rb +896 -83
- data/lib/aws-sdk-b2bi.rb +3 -1
- data/sig/client.rbs +213 -27
- data/sig/types.rbs +229 -22
- metadata +2 -2
data/lib/aws-sdk-b2bi/types.rb
CHANGED
@@ -49,6 +49,20 @@ module Aws::B2bi
|
|
49
49
|
class Unknown < CapabilityConfiguration; end
|
50
50
|
end
|
51
51
|
|
52
|
+
# Contains the details for an Outbound EDI capability.
|
53
|
+
#
|
54
|
+
# @!attribute [rw] outbound_edi
|
55
|
+
# A structure that contains the outbound EDI options.
|
56
|
+
# @return [Types::OutboundEdiOptions]
|
57
|
+
#
|
58
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CapabilityOptions AWS API Documentation
|
59
|
+
#
|
60
|
+
class CapabilityOptions < Struct.new(
|
61
|
+
:outbound_edi)
|
62
|
+
SENSITIVE = []
|
63
|
+
include Aws::Structure
|
64
|
+
end
|
65
|
+
|
52
66
|
# Returns the capability summary details. A trading capability contains
|
53
67
|
# the information required to transform incoming EDI documents into JSON
|
54
68
|
# or XML outputs.
|
@@ -102,6 +116,83 @@ module Aws::B2bi
|
|
102
116
|
include Aws::Structure
|
103
117
|
end
|
104
118
|
|
119
|
+
# Describes the input for an outbound transformation.
|
120
|
+
#
|
121
|
+
# @!attribute [rw] file_format
|
122
|
+
# The format for the input file: either JSON or XML.
|
123
|
+
# @return [String]
|
124
|
+
#
|
125
|
+
# @!attribute [rw] input_file
|
126
|
+
# File to be converted
|
127
|
+
# @return [Types::InputFileSource]
|
128
|
+
#
|
129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ConversionSource AWS API Documentation
|
130
|
+
#
|
131
|
+
class ConversionSource < Struct.new(
|
132
|
+
:file_format,
|
133
|
+
:input_file)
|
134
|
+
SENSITIVE = []
|
135
|
+
include Aws::Structure
|
136
|
+
end
|
137
|
+
|
138
|
+
# Provide a sample of what the output of the transformation should look
|
139
|
+
# like.
|
140
|
+
#
|
141
|
+
# @!attribute [rw] file_format
|
142
|
+
# Currently, only X12 format is supported.
|
143
|
+
# @return [String]
|
144
|
+
#
|
145
|
+
# @!attribute [rw] format_details
|
146
|
+
# A structure that contains the formatting details for the conversion
|
147
|
+
# target.
|
148
|
+
# @return [Types::ConversionTargetFormatDetails]
|
149
|
+
#
|
150
|
+
# @!attribute [rw] output_sample_file
|
151
|
+
# Customer uses this to provide a sample on what should file look like
|
152
|
+
# after conversion X12 EDI use case around this would be discovering
|
153
|
+
# the file syntax
|
154
|
+
# @return [Types::OutputSampleFileSource]
|
155
|
+
#
|
156
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ConversionTarget AWS API Documentation
|
157
|
+
#
|
158
|
+
class ConversionTarget < Struct.new(
|
159
|
+
:file_format,
|
160
|
+
:format_details,
|
161
|
+
:output_sample_file)
|
162
|
+
SENSITIVE = []
|
163
|
+
include Aws::Structure
|
164
|
+
end
|
165
|
+
|
166
|
+
# Contains a structure describing the X12 details for the conversion
|
167
|
+
# target.
|
168
|
+
#
|
169
|
+
# @note ConversionTargetFormatDetails is a union - when making an API calls you must set exactly one of the members.
|
170
|
+
#
|
171
|
+
# @!attribute [rw] x12
|
172
|
+
# A structure that contains the X12 transaction set and version. The
|
173
|
+
# X12 structure is used when the system transforms an EDI (electronic
|
174
|
+
# data interchange) file.
|
175
|
+
#
|
176
|
+
# <note markdown="1"> If an EDI input file contains more than one transaction, each
|
177
|
+
# transaction must have the same transaction set and version, for
|
178
|
+
# example 214/4010. If not, the transformer cannot parse the file.
|
179
|
+
#
|
180
|
+
# </note>
|
181
|
+
# @return [Types::X12Details]
|
182
|
+
#
|
183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ConversionTargetFormatDetails AWS API Documentation
|
184
|
+
#
|
185
|
+
class ConversionTargetFormatDetails < Struct.new(
|
186
|
+
:x12,
|
187
|
+
:unknown)
|
188
|
+
SENSITIVE = []
|
189
|
+
include Aws::Structure
|
190
|
+
include Aws::Structure::Union
|
191
|
+
|
192
|
+
class X12 < ConversionTargetFormatDetails; end
|
193
|
+
class Unknown < ConversionTargetFormatDetails; end
|
194
|
+
end
|
195
|
+
|
105
196
|
# @!attribute [rw] name
|
106
197
|
# Specifies the name of the capability, used to identify it.
|
107
198
|
# @return [String]
|
@@ -219,6 +310,11 @@ module Aws::B2bi
|
|
219
310
|
# partnership.
|
220
311
|
# @return [Array<String>]
|
221
312
|
#
|
313
|
+
# @!attribute [rw] capability_options
|
314
|
+
# Specify the structure that contains the details for the associated
|
315
|
+
# capabilities.
|
316
|
+
# @return [Types::CapabilityOptions]
|
317
|
+
#
|
222
318
|
# @!attribute [rw] client_token
|
223
319
|
# Reserved for future use.
|
224
320
|
#
|
@@ -241,6 +337,7 @@ module Aws::B2bi
|
|
241
337
|
:email,
|
242
338
|
:phone,
|
243
339
|
:capabilities,
|
340
|
+
:capability_options,
|
244
341
|
:client_token,
|
245
342
|
:tags)
|
246
343
|
SENSITIVE = [:email, :phone]
|
@@ -278,6 +375,11 @@ module Aws::B2bi
|
|
278
375
|
# Returns one or more capabilities associated with this partnership.
|
279
376
|
# @return [Array<String>]
|
280
377
|
#
|
378
|
+
# @!attribute [rw] capability_options
|
379
|
+
# Returns the structure that contains the details for the associated
|
380
|
+
# capabilities.
|
381
|
+
# @return [Types::CapabilityOptions]
|
382
|
+
#
|
281
383
|
# @!attribute [rw] trading_partner_id
|
282
384
|
# Returns the unique, system-generated identifier for a trading
|
283
385
|
# partner.
|
@@ -297,6 +399,7 @@ module Aws::B2bi
|
|
297
399
|
:email,
|
298
400
|
:phone,
|
299
401
|
:capabilities,
|
402
|
+
:capability_options,
|
300
403
|
:trading_partner_id,
|
301
404
|
:created_at)
|
302
405
|
SENSITIVE = [:email, :phone]
|
@@ -403,10 +506,61 @@ module Aws::B2bi
|
|
403
506
|
include Aws::Structure
|
404
507
|
end
|
405
508
|
|
509
|
+
# @!attribute [rw] output_sample_location
|
510
|
+
# Specify the location of the sample EDI file that is used to generate
|
511
|
+
# the mapping template.
|
512
|
+
# @return [Types::S3Location]
|
513
|
+
#
|
514
|
+
# @!attribute [rw] mapping_type
|
515
|
+
# Specify the format for the mapping template: either JSONATA or XSLT.
|
516
|
+
# @return [String]
|
517
|
+
#
|
518
|
+
# @!attribute [rw] template_details
|
519
|
+
# Describes the details needed for generating the template. Specify
|
520
|
+
# the X12 transaction set and version for which the template is used:
|
521
|
+
# currently, we only support X12.
|
522
|
+
# @return [Types::TemplateDetails]
|
523
|
+
#
|
524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateStarterMappingTemplateRequest AWS API Documentation
|
525
|
+
#
|
526
|
+
class CreateStarterMappingTemplateRequest < Struct.new(
|
527
|
+
:output_sample_location,
|
528
|
+
:mapping_type,
|
529
|
+
:template_details)
|
530
|
+
SENSITIVE = []
|
531
|
+
include Aws::Structure
|
532
|
+
end
|
533
|
+
|
534
|
+
# @!attribute [rw] mapping_template
|
535
|
+
# Returns a string that represents the mapping template.
|
536
|
+
# @return [String]
|
537
|
+
#
|
538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateStarterMappingTemplateResponse AWS API Documentation
|
539
|
+
#
|
540
|
+
class CreateStarterMappingTemplateResponse < Struct.new(
|
541
|
+
:mapping_template)
|
542
|
+
SENSITIVE = []
|
543
|
+
include Aws::Structure
|
544
|
+
end
|
545
|
+
|
406
546
|
# @!attribute [rw] name
|
407
547
|
# Specifies the name of the transformer, used to identify it.
|
408
548
|
# @return [String]
|
409
549
|
#
|
550
|
+
# @!attribute [rw] client_token
|
551
|
+
# Reserved for future use.
|
552
|
+
#
|
553
|
+
# **A suitable default value is auto-generated.** You should normally
|
554
|
+
# not need to pass this option.
|
555
|
+
# @return [String]
|
556
|
+
#
|
557
|
+
# @!attribute [rw] tags
|
558
|
+
# Specifies the key-value pairs assigned to ARNs that you can use to
|
559
|
+
# group and search for resources by type. You can attach this metadata
|
560
|
+
# to resources (capabilities, partnerships, and so on) for any
|
561
|
+
# purpose.
|
562
|
+
# @return [Array<Types::Tag>]
|
563
|
+
#
|
410
564
|
# @!attribute [rw] file_format
|
411
565
|
# Specifies that the currently supported file formats for EDI
|
412
566
|
# transformations are `JSON` and `XML`.
|
@@ -415,6 +569,15 @@ module Aws::B2bi
|
|
415
569
|
# @!attribute [rw] mapping_template
|
416
570
|
# Specifies the mapping template for the transformer. This template is
|
417
571
|
# used to map the parsed EDI file using JSONata or XSLT.
|
572
|
+
#
|
573
|
+
# <note markdown="1"> This parameter is available for backwards compatibility. Use the
|
574
|
+
# [Mapping][1] data type instead.
|
575
|
+
#
|
576
|
+
# </note>
|
577
|
+
#
|
578
|
+
#
|
579
|
+
#
|
580
|
+
# [1]: https://docs.aws.amazon.com/b2bi/latest/APIReference/API_Mapping.html
|
418
581
|
# @return [String]
|
419
582
|
#
|
420
583
|
# @!attribute [rw] edi_type
|
@@ -429,30 +592,41 @@ module Aws::B2bi
|
|
429
592
|
# guide for processing the EDI data.
|
430
593
|
# @return [String]
|
431
594
|
#
|
432
|
-
# @!attribute [rw]
|
433
|
-
#
|
595
|
+
# @!attribute [rw] input_conversion
|
596
|
+
# Specify the `InputConversion` object, which contains the format
|
597
|
+
# options for the inbound transformation.
|
598
|
+
# @return [Types::InputConversion]
|
434
599
|
#
|
435
|
-
#
|
436
|
-
#
|
437
|
-
#
|
600
|
+
# @!attribute [rw] mapping
|
601
|
+
# Specify the structure that contains the mapping template and its
|
602
|
+
# language (either XSLT or JSONATA).
|
603
|
+
# @return [Types::Mapping]
|
438
604
|
#
|
439
|
-
# @!attribute [rw]
|
440
|
-
#
|
441
|
-
#
|
442
|
-
#
|
443
|
-
#
|
444
|
-
#
|
605
|
+
# @!attribute [rw] output_conversion
|
606
|
+
# A structure that contains the `OutputConversion` object, which
|
607
|
+
# contains the format options for the outbound transformation.
|
608
|
+
# @return [Types::OutputConversion]
|
609
|
+
#
|
610
|
+
# @!attribute [rw] sample_documents
|
611
|
+
# Specify a structure that contains the Amazon S3 bucket and an array
|
612
|
+
# of the corresponding keys used to identify the location for your
|
613
|
+
# sample documents.
|
614
|
+
# @return [Types::SampleDocuments]
|
445
615
|
#
|
446
616
|
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateTransformerRequest AWS API Documentation
|
447
617
|
#
|
448
618
|
class CreateTransformerRequest < Struct.new(
|
449
619
|
:name,
|
620
|
+
:client_token,
|
621
|
+
:tags,
|
450
622
|
:file_format,
|
451
623
|
:mapping_template,
|
452
624
|
:edi_type,
|
453
625
|
:sample_document,
|
454
|
-
:
|
455
|
-
:
|
626
|
+
:input_conversion,
|
627
|
+
:mapping,
|
628
|
+
:output_conversion,
|
629
|
+
:sample_documents)
|
456
630
|
SENSITIVE = []
|
457
631
|
include Aws::Structure
|
458
632
|
end
|
@@ -471,6 +645,16 @@ module Aws::B2bi
|
|
471
645
|
# Returns the name of the transformer, used to identify it.
|
472
646
|
# @return [String]
|
473
647
|
#
|
648
|
+
# @!attribute [rw] status
|
649
|
+
# Returns the state of the newly created transformer. The transformer
|
650
|
+
# can be either `active` or `inactive`. For the transformer to be used
|
651
|
+
# in a capability, its status must `active`.
|
652
|
+
# @return [String]
|
653
|
+
#
|
654
|
+
# @!attribute [rw] created_at
|
655
|
+
# Returns a timestamp for creation date and time of the transformer.
|
656
|
+
# @return [Time]
|
657
|
+
#
|
474
658
|
# @!attribute [rw] file_format
|
475
659
|
# Returns that the currently supported file formats for EDI
|
476
660
|
# transformations are `JSON` and `XML`.
|
@@ -481,12 +665,6 @@ module Aws::B2bi
|
|
481
665
|
# used to map the parsed EDI file using JSONata or XSLT.
|
482
666
|
# @return [String]
|
483
667
|
#
|
484
|
-
# @!attribute [rw] status
|
485
|
-
# Returns the state of the newly created transformer. The transformer
|
486
|
-
# can be either `active` or `inactive`. For the transformer to be used
|
487
|
-
# in a capability, its status must `active`.
|
488
|
-
# @return [String]
|
489
|
-
#
|
490
668
|
# @!attribute [rw] edi_type
|
491
669
|
# Returns the details for the EDI standard that is being used for the
|
492
670
|
# transformer. Currently, only X12 is supported. X12 is a set of
|
@@ -499,9 +677,26 @@ module Aws::B2bi
|
|
499
677
|
# guide for processing the EDI data.
|
500
678
|
# @return [String]
|
501
679
|
#
|
502
|
-
# @!attribute [rw]
|
503
|
-
# Returns
|
504
|
-
#
|
680
|
+
# @!attribute [rw] input_conversion
|
681
|
+
# Returns the `InputConversion` object, which contains the format
|
682
|
+
# options for the inbound transformation.
|
683
|
+
# @return [Types::InputConversion]
|
684
|
+
#
|
685
|
+
# @!attribute [rw] mapping
|
686
|
+
# Returns the structure that contains the mapping template and its
|
687
|
+
# language (either XSLT or JSONATA).
|
688
|
+
# @return [Types::Mapping]
|
689
|
+
#
|
690
|
+
# @!attribute [rw] output_conversion
|
691
|
+
# Returns the `OutputConversion` object, which contains the format
|
692
|
+
# options for the outbound transformation.
|
693
|
+
# @return [Types::OutputConversion]
|
694
|
+
#
|
695
|
+
# @!attribute [rw] sample_documents
|
696
|
+
# Returns a structure that contains the Amazon S3 bucket and an array
|
697
|
+
# of the corresponding keys used to identify the location for your
|
698
|
+
# sample documents.
|
699
|
+
# @return [Types::SampleDocuments]
|
505
700
|
#
|
506
701
|
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateTransformerResponse AWS API Documentation
|
507
702
|
#
|
@@ -509,12 +704,16 @@ module Aws::B2bi
|
|
509
704
|
:transformer_id,
|
510
705
|
:transformer_arn,
|
511
706
|
:name,
|
707
|
+
:status,
|
708
|
+
:created_at,
|
512
709
|
:file_format,
|
513
710
|
:mapping_template,
|
514
|
-
:status,
|
515
711
|
:edi_type,
|
516
712
|
:sample_document,
|
517
|
-
:
|
713
|
+
:input_conversion,
|
714
|
+
:mapping,
|
715
|
+
:output_conversion,
|
716
|
+
:sample_documents)
|
518
717
|
SENSITIVE = []
|
519
718
|
include Aws::Structure
|
520
719
|
end
|
@@ -570,6 +769,11 @@ module Aws::B2bi
|
|
570
769
|
# Specifies the details for the EDI (electronic data interchange)
|
571
770
|
# transformation.
|
572
771
|
#
|
772
|
+
# @!attribute [rw] capability_direction
|
773
|
+
# Specifies whether this is capability is for inbound or outbound
|
774
|
+
# transformations.
|
775
|
+
# @return [String]
|
776
|
+
#
|
573
777
|
# @!attribute [rw] type
|
574
778
|
# Returns the type of the capability. Currently, only `edi` is
|
575
779
|
# supported.
|
@@ -592,6 +796,7 @@ module Aws::B2bi
|
|
592
796
|
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/EdiConfiguration AWS API Documentation
|
593
797
|
#
|
594
798
|
class EdiConfiguration < Struct.new(
|
799
|
+
:capability_direction,
|
595
800
|
:type,
|
596
801
|
:input_location,
|
597
802
|
:output_location,
|
@@ -629,6 +834,37 @@ module Aws::B2bi
|
|
629
834
|
class Unknown < EdiType; end
|
630
835
|
end
|
631
836
|
|
837
|
+
# A structure that contains the X12 transaction set and version.
|
838
|
+
#
|
839
|
+
# @note FormatOptions is a union - when making an API calls you must set exactly one of the members.
|
840
|
+
#
|
841
|
+
# @note FormatOptions is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FormatOptions corresponding to the set member.
|
842
|
+
#
|
843
|
+
# @!attribute [rw] x12
|
844
|
+
# A structure that contains the X12 transaction set and version. The
|
845
|
+
# X12 structure is used when the system transforms an EDI (electronic
|
846
|
+
# data interchange) file.
|
847
|
+
#
|
848
|
+
# <note markdown="1"> If an EDI input file contains more than one transaction, each
|
849
|
+
# transaction must have the same transaction set and version, for
|
850
|
+
# example 214/4010. If not, the transformer cannot parse the file.
|
851
|
+
#
|
852
|
+
# </note>
|
853
|
+
# @return [Types::X12Details]
|
854
|
+
#
|
855
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/FormatOptions AWS API Documentation
|
856
|
+
#
|
857
|
+
class FormatOptions < Struct.new(
|
858
|
+
:x12,
|
859
|
+
:unknown)
|
860
|
+
SENSITIVE = []
|
861
|
+
include Aws::Structure
|
862
|
+
include Aws::Structure::Union
|
863
|
+
|
864
|
+
class X12 < FormatOptions; end
|
865
|
+
class Unknown < FormatOptions; end
|
866
|
+
end
|
867
|
+
|
632
868
|
# @!attribute [rw] capability_id
|
633
869
|
# Specifies a system-assigned unique identifier for the capability.
|
634
870
|
# @return [String]
|
@@ -737,6 +973,10 @@ module Aws::B2bi
|
|
737
973
|
# Returns one or more capabilities associated with this partnership.
|
738
974
|
# @return [Array<String>]
|
739
975
|
#
|
976
|
+
# @!attribute [rw] capability_options
|
977
|
+
# Contains the details for an Outbound EDI capability.
|
978
|
+
# @return [Types::CapabilityOptions]
|
979
|
+
#
|
740
980
|
# @!attribute [rw] trading_partner_id
|
741
981
|
# Returns the unique identifier for the partner for this partnership.
|
742
982
|
# @return [String]
|
@@ -760,6 +1000,7 @@ module Aws::B2bi
|
|
760
1000
|
:email,
|
761
1001
|
:phone,
|
762
1002
|
:capabilities,
|
1003
|
+
:capability_options,
|
763
1004
|
:trading_partner_id,
|
764
1005
|
:created_at,
|
765
1006
|
:modified_at)
|
@@ -908,6 +1149,20 @@ module Aws::B2bi
|
|
908
1149
|
# Returns the name of the transformer, used to identify it.
|
909
1150
|
# @return [String]
|
910
1151
|
#
|
1152
|
+
# @!attribute [rw] status
|
1153
|
+
# Returns the state of the newly created transformer. The transformer
|
1154
|
+
# can be either `active` or `inactive`. For the transformer to be used
|
1155
|
+
# in a capability, its status must `active`.
|
1156
|
+
# @return [String]
|
1157
|
+
#
|
1158
|
+
# @!attribute [rw] created_at
|
1159
|
+
# Returns a timestamp for creation date and time of the transformer.
|
1160
|
+
# @return [Time]
|
1161
|
+
#
|
1162
|
+
# @!attribute [rw] modified_at
|
1163
|
+
# Returns a timestamp for last time the transformer was modified.
|
1164
|
+
# @return [Time]
|
1165
|
+
#
|
911
1166
|
# @!attribute [rw] file_format
|
912
1167
|
# Returns that the currently supported file formats for EDI
|
913
1168
|
# transformations are `JSON` and `XML`.
|
@@ -918,12 +1173,6 @@ module Aws::B2bi
|
|
918
1173
|
# used to map the parsed EDI file using JSONata or XSLT.
|
919
1174
|
# @return [String]
|
920
1175
|
#
|
921
|
-
# @!attribute [rw] status
|
922
|
-
# Returns the state of the newly created transformer. The transformer
|
923
|
-
# can be either `active` or `inactive`. For the transformer to be used
|
924
|
-
# in a capability, its status must `active`.
|
925
|
-
# @return [String]
|
926
|
-
#
|
927
1176
|
# @!attribute [rw] edi_type
|
928
1177
|
# Returns the details for the EDI standard that is being used for the
|
929
1178
|
# transformer. Currently, only X12 is supported. X12 is a set of
|
@@ -936,13 +1185,26 @@ module Aws::B2bi
|
|
936
1185
|
# guide for processing the EDI data.
|
937
1186
|
# @return [String]
|
938
1187
|
#
|
939
|
-
# @!attribute [rw]
|
940
|
-
# Returns
|
941
|
-
#
|
1188
|
+
# @!attribute [rw] input_conversion
|
1189
|
+
# Returns the `InputConversion` object, which contains the format
|
1190
|
+
# options for the inbound transformation.
|
1191
|
+
# @return [Types::InputConversion]
|
942
1192
|
#
|
943
|
-
# @!attribute [rw]
|
944
|
-
# Returns
|
945
|
-
#
|
1193
|
+
# @!attribute [rw] mapping
|
1194
|
+
# Returns the structure that contains the mapping template and its
|
1195
|
+
# language (either XSLT or JSONATA).
|
1196
|
+
# @return [Types::Mapping]
|
1197
|
+
#
|
1198
|
+
# @!attribute [rw] output_conversion
|
1199
|
+
# Returns the `OutputConversion` object, which contains the format
|
1200
|
+
# options for the outbound transformation.
|
1201
|
+
# @return [Types::OutputConversion]
|
1202
|
+
#
|
1203
|
+
# @!attribute [rw] sample_documents
|
1204
|
+
# Returns a structure that contains the Amazon S3 bucket and an array
|
1205
|
+
# of the corresponding keys used to identify the location for your
|
1206
|
+
# sample documents.
|
1207
|
+
# @return [Types::SampleDocuments]
|
946
1208
|
#
|
947
1209
|
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetTransformerResponse AWS API Documentation
|
948
1210
|
#
|
@@ -950,17 +1212,66 @@ module Aws::B2bi
|
|
950
1212
|
:transformer_id,
|
951
1213
|
:transformer_arn,
|
952
1214
|
:name,
|
1215
|
+
:status,
|
1216
|
+
:created_at,
|
1217
|
+
:modified_at,
|
953
1218
|
:file_format,
|
954
1219
|
:mapping_template,
|
955
|
-
:status,
|
956
1220
|
:edi_type,
|
957
1221
|
:sample_document,
|
958
|
-
:
|
959
|
-
:
|
1222
|
+
:input_conversion,
|
1223
|
+
:mapping,
|
1224
|
+
:output_conversion,
|
1225
|
+
:sample_documents)
|
960
1226
|
SENSITIVE = []
|
961
1227
|
include Aws::Structure
|
962
1228
|
end
|
963
1229
|
|
1230
|
+
# Contains the input formatting options for an inbound transformer
|
1231
|
+
# (takes an X12-formatted EDI document as input and converts it to JSON
|
1232
|
+
# or XML.
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] from_format
|
1235
|
+
# The format for the transformer input: currently on `X12` is
|
1236
|
+
# supported.
|
1237
|
+
# @return [String]
|
1238
|
+
#
|
1239
|
+
# @!attribute [rw] format_options
|
1240
|
+
# A structure that contains the formatting options for an inbound
|
1241
|
+
# transformer.
|
1242
|
+
# @return [Types::FormatOptions]
|
1243
|
+
#
|
1244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/InputConversion AWS API Documentation
|
1245
|
+
#
|
1246
|
+
class InputConversion < Struct.new(
|
1247
|
+
:from_format,
|
1248
|
+
:format_options)
|
1249
|
+
SENSITIVE = []
|
1250
|
+
include Aws::Structure
|
1251
|
+
end
|
1252
|
+
|
1253
|
+
# The input file to use for an outbound transformation.
|
1254
|
+
#
|
1255
|
+
# @note InputFileSource is a union - when making an API calls you must set exactly one of the members.
|
1256
|
+
#
|
1257
|
+
# @!attribute [rw] file_content
|
1258
|
+
# Specify the input contents, as a string, for the source of an
|
1259
|
+
# outbound transformation.
|
1260
|
+
# @return [String]
|
1261
|
+
#
|
1262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/InputFileSource AWS API Documentation
|
1263
|
+
#
|
1264
|
+
class InputFileSource < Struct.new(
|
1265
|
+
:file_content,
|
1266
|
+
:unknown)
|
1267
|
+
SENSITIVE = []
|
1268
|
+
include Aws::Structure
|
1269
|
+
include Aws::Structure::Union
|
1270
|
+
|
1271
|
+
class FileContent < InputFileSource; end
|
1272
|
+
class Unknown < InputFileSource; end
|
1273
|
+
end
|
1274
|
+
|
964
1275
|
# This exception is thrown when an error occurs in the Amazon Web
|
965
1276
|
# Services B2B Data Interchange service.
|
966
1277
|
#
|
@@ -1180,6 +1491,99 @@ module Aws::B2bi
|
|
1180
1491
|
include Aws::Structure
|
1181
1492
|
end
|
1182
1493
|
|
1494
|
+
# Specifies the mapping template for the transformer. This template is
|
1495
|
+
# used to map the parsed EDI file using JSONata or XSLT.
|
1496
|
+
#
|
1497
|
+
# @!attribute [rw] template_language
|
1498
|
+
# The transformation language for the template, either XSLT or
|
1499
|
+
# JSONATA.
|
1500
|
+
# @return [String]
|
1501
|
+
#
|
1502
|
+
# @!attribute [rw] template
|
1503
|
+
# A string that represents the mapping template, in the transformation
|
1504
|
+
# language specified in `templateLanguage`.
|
1505
|
+
# @return [String]
|
1506
|
+
#
|
1507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/Mapping AWS API Documentation
|
1508
|
+
#
|
1509
|
+
class Mapping < Struct.new(
|
1510
|
+
:template_language,
|
1511
|
+
:template)
|
1512
|
+
SENSITIVE = []
|
1513
|
+
include Aws::Structure
|
1514
|
+
end
|
1515
|
+
|
1516
|
+
# A container for outbound EDI options.
|
1517
|
+
#
|
1518
|
+
# @note OutboundEdiOptions is a union - when making an API calls you must set exactly one of the members.
|
1519
|
+
#
|
1520
|
+
# @note OutboundEdiOptions is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of OutboundEdiOptions corresponding to the set member.
|
1521
|
+
#
|
1522
|
+
# @!attribute [rw] x12
|
1523
|
+
# A structure that contains an X12 envelope structure.
|
1524
|
+
# @return [Types::X12Envelope]
|
1525
|
+
#
|
1526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/OutboundEdiOptions AWS API Documentation
|
1527
|
+
#
|
1528
|
+
class OutboundEdiOptions < Struct.new(
|
1529
|
+
:x12,
|
1530
|
+
:unknown)
|
1531
|
+
SENSITIVE = []
|
1532
|
+
include Aws::Structure
|
1533
|
+
include Aws::Structure::Union
|
1534
|
+
|
1535
|
+
class X12 < OutboundEdiOptions; end
|
1536
|
+
class Unknown < OutboundEdiOptions; end
|
1537
|
+
end
|
1538
|
+
|
1539
|
+
# Contains the formatting options for an outbound transformer (takes
|
1540
|
+
# JSON or XML as input and converts it to an EDI document (currently
|
1541
|
+
# only X12 format is supported).
|
1542
|
+
#
|
1543
|
+
# @!attribute [rw] to_format
|
1544
|
+
# The format for the output from an outbound transformer: only X12 is
|
1545
|
+
# currently supported.
|
1546
|
+
# @return [String]
|
1547
|
+
#
|
1548
|
+
# @!attribute [rw] format_options
|
1549
|
+
# A structure that contains the X12 transaction set and version for
|
1550
|
+
# the transformer output.
|
1551
|
+
# @return [Types::FormatOptions]
|
1552
|
+
#
|
1553
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/OutputConversion AWS API Documentation
|
1554
|
+
#
|
1555
|
+
class OutputConversion < Struct.new(
|
1556
|
+
:to_format,
|
1557
|
+
:format_options)
|
1558
|
+
SENSITIVE = []
|
1559
|
+
include Aws::Structure
|
1560
|
+
end
|
1561
|
+
|
1562
|
+
# Container for the location of a sample file used for outbound
|
1563
|
+
# transformations.
|
1564
|
+
#
|
1565
|
+
# @note OutputSampleFileSource is a union - when making an API calls you must set exactly one of the members.
|
1566
|
+
#
|
1567
|
+
# @!attribute [rw] file_location
|
1568
|
+
# Specifies the details for the Amazon S3 file location that is being
|
1569
|
+
# used with Amazon Web Services B2B Data Interchange. File locations
|
1570
|
+
# in Amazon S3 are identified using a combination of the bucket and
|
1571
|
+
# key.
|
1572
|
+
# @return [Types::S3Location]
|
1573
|
+
#
|
1574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/OutputSampleFileSource AWS API Documentation
|
1575
|
+
#
|
1576
|
+
class OutputSampleFileSource < Struct.new(
|
1577
|
+
:file_location,
|
1578
|
+
:unknown)
|
1579
|
+
SENSITIVE = []
|
1580
|
+
include Aws::Structure
|
1581
|
+
include Aws::Structure::Union
|
1582
|
+
|
1583
|
+
class FileLocation < OutputSampleFileSource; end
|
1584
|
+
class Unknown < OutputSampleFileSource; end
|
1585
|
+
end
|
1586
|
+
|
1183
1587
|
# A structure that contains the details for a partnership. A partnership
|
1184
1588
|
# represents the connection between you and your trading partner. It
|
1185
1589
|
# ties together a profile and one or more trading capabilities.
|
@@ -1201,6 +1605,10 @@ module Aws::B2bi
|
|
1201
1605
|
# Returns one or more capabilities associated with this partnership.
|
1202
1606
|
# @return [Array<String>]
|
1203
1607
|
#
|
1608
|
+
# @!attribute [rw] capability_options
|
1609
|
+
# Contains the details for an Outbound EDI capability.
|
1610
|
+
# @return [Types::CapabilityOptions]
|
1611
|
+
#
|
1204
1612
|
# @!attribute [rw] trading_partner_id
|
1205
1613
|
# Returns the unique, system-generated identifier for a trading
|
1206
1614
|
# partner.
|
@@ -1222,6 +1630,7 @@ module Aws::B2bi
|
|
1222
1630
|
:partnership_id,
|
1223
1631
|
:name,
|
1224
1632
|
:capabilities,
|
1633
|
+
:capability_options,
|
1225
1634
|
:trading_partner_id,
|
1226
1635
|
:created_at,
|
1227
1636
|
:modified_at)
|
@@ -1291,7 +1700,7 @@ module Aws::B2bi
|
|
1291
1700
|
end
|
1292
1701
|
|
1293
1702
|
# Specifies the details for the Amazon S3 file location that is being
|
1294
|
-
# used with Amazon Web Services
|
1703
|
+
# used with Amazon Web Services B2B Data Interchange. File locations in
|
1295
1704
|
# Amazon S3 are identified using a combination of the bucket and key.
|
1296
1705
|
#
|
1297
1706
|
# @!attribute [rw] bucket_name
|
@@ -1311,6 +1720,49 @@ module Aws::B2bi
|
|
1311
1720
|
include Aws::Structure
|
1312
1721
|
end
|
1313
1722
|
|
1723
|
+
# An array of the Amazon S3 keys used to identify the location for your
|
1724
|
+
# sample documents.
|
1725
|
+
#
|
1726
|
+
# @!attribute [rw] input
|
1727
|
+
# An array of keys for your input sample documents.
|
1728
|
+
# @return [String]
|
1729
|
+
#
|
1730
|
+
# @!attribute [rw] output
|
1731
|
+
# An array of keys for your output sample documents.
|
1732
|
+
# @return [String]
|
1733
|
+
#
|
1734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/SampleDocumentKeys AWS API Documentation
|
1735
|
+
#
|
1736
|
+
class SampleDocumentKeys < Struct.new(
|
1737
|
+
:input,
|
1738
|
+
:output)
|
1739
|
+
SENSITIVE = []
|
1740
|
+
include Aws::Structure
|
1741
|
+
end
|
1742
|
+
|
1743
|
+
# Describes a structure that contains the Amazon S3 bucket and an array
|
1744
|
+
# of the corresponding keys used to identify the location for your
|
1745
|
+
# sample documents.
|
1746
|
+
#
|
1747
|
+
# @!attribute [rw] bucket_name
|
1748
|
+
# Contains the Amazon S3 bucket that is used to hold your sample
|
1749
|
+
# documents.
|
1750
|
+
# @return [String]
|
1751
|
+
#
|
1752
|
+
# @!attribute [rw] keys
|
1753
|
+
# Contains an array of the Amazon S3 keys used to identify the
|
1754
|
+
# location for your sample documents.
|
1755
|
+
# @return [Array<Types::SampleDocumentKeys>]
|
1756
|
+
#
|
1757
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/SampleDocuments AWS API Documentation
|
1758
|
+
#
|
1759
|
+
class SampleDocuments < Struct.new(
|
1760
|
+
:bucket_name,
|
1761
|
+
:keys)
|
1762
|
+
SENSITIVE = []
|
1763
|
+
include Aws::Structure
|
1764
|
+
end
|
1765
|
+
|
1314
1766
|
# Occurs when the calling command attempts to exceed one of the service
|
1315
1767
|
# quotas, for example trying to create a capability when you already
|
1316
1768
|
# have the maximum number of capabilities allowed.
|
@@ -1442,6 +1894,72 @@ module Aws::B2bi
|
|
1442
1894
|
include Aws::Structure
|
1443
1895
|
end
|
1444
1896
|
|
1897
|
+
# A data structure that contains the information to use when generating
|
1898
|
+
# a mapping template.
|
1899
|
+
#
|
1900
|
+
# @note TemplateDetails is a union - when making an API calls you must set exactly one of the members.
|
1901
|
+
#
|
1902
|
+
# @!attribute [rw] x12
|
1903
|
+
# A structure that contains the X12 transaction set and version. The
|
1904
|
+
# X12 structure is used when the system transforms an EDI (electronic
|
1905
|
+
# data interchange) file.
|
1906
|
+
#
|
1907
|
+
# <note markdown="1"> If an EDI input file contains more than one transaction, each
|
1908
|
+
# transaction must have the same transaction set and version, for
|
1909
|
+
# example 214/4010. If not, the transformer cannot parse the file.
|
1910
|
+
#
|
1911
|
+
# </note>
|
1912
|
+
# @return [Types::X12Details]
|
1913
|
+
#
|
1914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TemplateDetails AWS API Documentation
|
1915
|
+
#
|
1916
|
+
class TemplateDetails < Struct.new(
|
1917
|
+
:x12,
|
1918
|
+
:unknown)
|
1919
|
+
SENSITIVE = []
|
1920
|
+
include Aws::Structure
|
1921
|
+
include Aws::Structure::Union
|
1922
|
+
|
1923
|
+
class X12 < TemplateDetails; end
|
1924
|
+
class Unknown < TemplateDetails; end
|
1925
|
+
end
|
1926
|
+
|
1927
|
+
# @!attribute [rw] source
|
1928
|
+
# Specify the source file for an outbound EDI request.
|
1929
|
+
# @return [Types::ConversionSource]
|
1930
|
+
#
|
1931
|
+
# @!attribute [rw] target
|
1932
|
+
# Specify the format (X12 is the only currently supported format), and
|
1933
|
+
# other details for the conversion target.
|
1934
|
+
# @return [Types::ConversionTarget]
|
1935
|
+
#
|
1936
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TestConversionRequest AWS API Documentation
|
1937
|
+
#
|
1938
|
+
class TestConversionRequest < Struct.new(
|
1939
|
+
:source,
|
1940
|
+
:target)
|
1941
|
+
SENSITIVE = []
|
1942
|
+
include Aws::Structure
|
1943
|
+
end
|
1944
|
+
|
1945
|
+
# @!attribute [rw] converted_file_content
|
1946
|
+
# Returns the converted file content.
|
1947
|
+
# @return [String]
|
1948
|
+
#
|
1949
|
+
# @!attribute [rw] validation_messages
|
1950
|
+
# Returns an array of strings, each containing a message that Amazon
|
1951
|
+
# Web Services B2B Data Interchange generates during the conversion.
|
1952
|
+
# @return [Array<String>]
|
1953
|
+
#
|
1954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TestConversionResponse AWS API Documentation
|
1955
|
+
#
|
1956
|
+
class TestConversionResponse < Struct.new(
|
1957
|
+
:converted_file_content,
|
1958
|
+
:validation_messages)
|
1959
|
+
SENSITIVE = []
|
1960
|
+
include Aws::Structure
|
1961
|
+
end
|
1962
|
+
|
1445
1963
|
# @!attribute [rw] input_file_content
|
1446
1964
|
# Specify the contents of the EDI (electronic data interchange) XML or
|
1447
1965
|
# JSON file that is used as input for the transform.
|
@@ -1450,6 +1968,15 @@ module Aws::B2bi
|
|
1450
1968
|
# @!attribute [rw] mapping_template
|
1451
1969
|
# Specifies the mapping template for the transformer. This template is
|
1452
1970
|
# used to map the parsed EDI file using JSONata or XSLT.
|
1971
|
+
#
|
1972
|
+
# <note markdown="1"> This parameter is available for backwards compatibility. Use the
|
1973
|
+
# [Mapping][1] data type instead.
|
1974
|
+
#
|
1975
|
+
# </note>
|
1976
|
+
#
|
1977
|
+
#
|
1978
|
+
#
|
1979
|
+
# [1]: https://docs.aws.amazon.com/b2bi/latest/APIReference/API_Mapping.html
|
1453
1980
|
# @return [String]
|
1454
1981
|
#
|
1455
1982
|
# @!attribute [rw] file_format
|
@@ -1539,9 +2066,10 @@ module Aws::B2bi
|
|
1539
2066
|
include Aws::Structure
|
1540
2067
|
end
|
1541
2068
|
|
1542
|
-
# Contains the details for a transformer object. A transformer
|
1543
|
-
#
|
1544
|
-
#
|
2069
|
+
# Contains the details for a transformer object. A transformer can take
|
2070
|
+
# an EDI file as input and transform it into a JSON-or XML-formatted
|
2071
|
+
# document. Alternatively, a transformer can take a JSON-or
|
2072
|
+
# XML-formatted document as input and transform it into an EDI file.
|
1545
2073
|
#
|
1546
2074
|
# @!attribute [rw] transformer_id
|
1547
2075
|
# Returns the system-assigned unique identifier for the transformer.
|
@@ -1551,6 +2079,22 @@ module Aws::B2bi
|
|
1551
2079
|
# Returns the descriptive name for the transformer.
|
1552
2080
|
# @return [String]
|
1553
2081
|
#
|
2082
|
+
# @!attribute [rw] status
|
2083
|
+
# Returns the state of the newly created transformer. The transformer
|
2084
|
+
# can be either `active` or `inactive`. For the transformer to be used
|
2085
|
+
# in a capability, its status must `active`.
|
2086
|
+
# @return [String]
|
2087
|
+
#
|
2088
|
+
# @!attribute [rw] created_at
|
2089
|
+
# Returns a timestamp indicating when the transformer was created. For
|
2090
|
+
# example, `2023-07-20T19:58:44.624Z`.
|
2091
|
+
# @return [Time]
|
2092
|
+
#
|
2093
|
+
# @!attribute [rw] modified_at
|
2094
|
+
# Returns a timestamp representing the date and time for the most
|
2095
|
+
# recent change for the transformer object.
|
2096
|
+
# @return [Time]
|
2097
|
+
#
|
1554
2098
|
# @!attribute [rw] file_format
|
1555
2099
|
# Returns that the currently supported file formats for EDI
|
1556
2100
|
# transformations are `JSON` and `XML`.
|
@@ -1561,12 +2105,6 @@ module Aws::B2bi
|
|
1561
2105
|
# used to map the parsed EDI file using JSONata or XSLT.
|
1562
2106
|
# @return [String]
|
1563
2107
|
#
|
1564
|
-
# @!attribute [rw] status
|
1565
|
-
# Returns the state of the newly created transformer. The transformer
|
1566
|
-
# can be either `active` or `inactive`. For the transformer to be used
|
1567
|
-
# in a capability, its status must `active`.
|
1568
|
-
# @return [String]
|
1569
|
-
#
|
1570
2108
|
# @!attribute [rw] edi_type
|
1571
2109
|
# Returns the details for the EDI standard that is being used for the
|
1572
2110
|
# transformer. Currently, only X12 is supported. X12 is a set of
|
@@ -1579,28 +2117,43 @@ module Aws::B2bi
|
|
1579
2117
|
# guide for processing the EDI data.
|
1580
2118
|
# @return [String]
|
1581
2119
|
#
|
1582
|
-
# @!attribute [rw]
|
1583
|
-
# Returns a
|
1584
|
-
#
|
1585
|
-
# @return [
|
2120
|
+
# @!attribute [rw] input_conversion
|
2121
|
+
# Returns a structure that contains the format options for the
|
2122
|
+
# transformation.
|
2123
|
+
# @return [Types::InputConversion]
|
1586
2124
|
#
|
1587
|
-
# @!attribute [rw]
|
1588
|
-
# Returns
|
1589
|
-
#
|
1590
|
-
# @return [
|
2125
|
+
# @!attribute [rw] mapping
|
2126
|
+
# Returns the structure that contains the mapping template and its
|
2127
|
+
# language (either XSLT or JSONATA).
|
2128
|
+
# @return [Types::Mapping]
|
2129
|
+
#
|
2130
|
+
# @!attribute [rw] output_conversion
|
2131
|
+
# Returns the `OutputConversion` object, which contains the format
|
2132
|
+
# options for the outbound transformation.
|
2133
|
+
# @return [Types::OutputConversion]
|
2134
|
+
#
|
2135
|
+
# @!attribute [rw] sample_documents
|
2136
|
+
# Returns a structure that contains the Amazon S3 bucket and an array
|
2137
|
+
# of the corresponding keys used to identify the location for your
|
2138
|
+
# sample documents.
|
2139
|
+
# @return [Types::SampleDocuments]
|
1591
2140
|
#
|
1592
2141
|
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TransformerSummary AWS API Documentation
|
1593
2142
|
#
|
1594
2143
|
class TransformerSummary < Struct.new(
|
1595
2144
|
:transformer_id,
|
1596
2145
|
:name,
|
2146
|
+
:status,
|
2147
|
+
:created_at,
|
2148
|
+
:modified_at,
|
1597
2149
|
:file_format,
|
1598
2150
|
:mapping_template,
|
1599
|
-
:status,
|
1600
2151
|
:edi_type,
|
1601
2152
|
:sample_document,
|
1602
|
-
:
|
1603
|
-
:
|
2153
|
+
:input_conversion,
|
2154
|
+
:mapping,
|
2155
|
+
:output_conversion,
|
2156
|
+
:sample_documents)
|
1604
2157
|
SENSITIVE = []
|
1605
2158
|
include Aws::Structure
|
1606
2159
|
end
|
@@ -1723,12 +2276,18 @@ module Aws::B2bi
|
|
1723
2276
|
# List of the capabilities associated with this partnership.
|
1724
2277
|
# @return [Array<String>]
|
1725
2278
|
#
|
2279
|
+
# @!attribute [rw] capability_options
|
2280
|
+
# To update, specify the structure that contains the details for the
|
2281
|
+
# associated capabilities.
|
2282
|
+
# @return [Types::CapabilityOptions]
|
2283
|
+
#
|
1726
2284
|
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdatePartnershipRequest AWS API Documentation
|
1727
2285
|
#
|
1728
2286
|
class UpdatePartnershipRequest < Struct.new(
|
1729
2287
|
:partnership_id,
|
1730
2288
|
:name,
|
1731
|
-
:capabilities
|
2289
|
+
:capabilities,
|
2290
|
+
:capability_options)
|
1732
2291
|
SENSITIVE = []
|
1733
2292
|
include Aws::Structure
|
1734
2293
|
end
|
@@ -1764,6 +2323,11 @@ module Aws::B2bi
|
|
1764
2323
|
# Returns one or more capabilities associated with this partnership.
|
1765
2324
|
# @return [Array<String>]
|
1766
2325
|
#
|
2326
|
+
# @!attribute [rw] capability_options
|
2327
|
+
# Returns the structure that contains the details for the associated
|
2328
|
+
# capabilities.
|
2329
|
+
# @return [Types::CapabilityOptions]
|
2330
|
+
#
|
1767
2331
|
# @!attribute [rw] trading_partner_id
|
1768
2332
|
# Returns the unique, system-generated identifier for a trading
|
1769
2333
|
# partner.
|
@@ -1789,6 +2353,7 @@ module Aws::B2bi
|
|
1789
2353
|
:email,
|
1790
2354
|
:phone,
|
1791
2355
|
:capabilities,
|
2356
|
+
:capability_options,
|
1792
2357
|
:trading_partner_id,
|
1793
2358
|
:created_at,
|
1794
2359
|
:modified_at)
|
@@ -1893,6 +2458,11 @@ module Aws::B2bi
|
|
1893
2458
|
# Specify a new name for the transformer, if you want to update it.
|
1894
2459
|
# @return [String]
|
1895
2460
|
#
|
2461
|
+
# @!attribute [rw] status
|
2462
|
+
# Specifies the transformer's status. You can update the state of the
|
2463
|
+
# transformer, from `active` to `inactive`, or `inactive` to `active`.
|
2464
|
+
# @return [String]
|
2465
|
+
#
|
1896
2466
|
# @!attribute [rw] file_format
|
1897
2467
|
# Specifies that the currently supported file formats for EDI
|
1898
2468
|
# transformations are `JSON` and `XML`.
|
@@ -1901,11 +2471,15 @@ module Aws::B2bi
|
|
1901
2471
|
# @!attribute [rw] mapping_template
|
1902
2472
|
# Specifies the mapping template for the transformer. This template is
|
1903
2473
|
# used to map the parsed EDI file using JSONata or XSLT.
|
1904
|
-
# @return [String]
|
1905
2474
|
#
|
1906
|
-
#
|
1907
|
-
#
|
1908
|
-
#
|
2475
|
+
# <note markdown="1"> This parameter is available for backwards compatibility. Use the
|
2476
|
+
# [Mapping][1] data type instead.
|
2477
|
+
#
|
2478
|
+
# </note>
|
2479
|
+
#
|
2480
|
+
#
|
2481
|
+
#
|
2482
|
+
# [1]: https://docs.aws.amazon.com/b2bi/latest/APIReference/API_Mapping.html
|
1909
2483
|
# @return [String]
|
1910
2484
|
#
|
1911
2485
|
# @!attribute [rw] edi_type
|
@@ -1920,16 +2494,41 @@ module Aws::B2bi
|
|
1920
2494
|
# guide for processing the EDI data.
|
1921
2495
|
# @return [String]
|
1922
2496
|
#
|
2497
|
+
# @!attribute [rw] input_conversion
|
2498
|
+
# To update, specify the `InputConversion` object, which contains the
|
2499
|
+
# format options for the inbound transformation.
|
2500
|
+
# @return [Types::InputConversion]
|
2501
|
+
#
|
2502
|
+
# @!attribute [rw] mapping
|
2503
|
+
# Specify the structure that contains the mapping template and its
|
2504
|
+
# language (either XSLT or JSONATA).
|
2505
|
+
# @return [Types::Mapping]
|
2506
|
+
#
|
2507
|
+
# @!attribute [rw] output_conversion
|
2508
|
+
# To update, specify the `OutputConversion` object, which contains the
|
2509
|
+
# format options for the outbound transformation.
|
2510
|
+
# @return [Types::OutputConversion]
|
2511
|
+
#
|
2512
|
+
# @!attribute [rw] sample_documents
|
2513
|
+
# Specify a structure that contains the Amazon S3 bucket and an array
|
2514
|
+
# of the corresponding keys used to identify the location for your
|
2515
|
+
# sample documents.
|
2516
|
+
# @return [Types::SampleDocuments]
|
2517
|
+
#
|
1923
2518
|
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdateTransformerRequest AWS API Documentation
|
1924
2519
|
#
|
1925
2520
|
class UpdateTransformerRequest < Struct.new(
|
1926
2521
|
:transformer_id,
|
1927
2522
|
:name,
|
2523
|
+
:status,
|
1928
2524
|
:file_format,
|
1929
2525
|
:mapping_template,
|
1930
|
-
:status,
|
1931
2526
|
:edi_type,
|
1932
|
-
:sample_document
|
2527
|
+
:sample_document,
|
2528
|
+
:input_conversion,
|
2529
|
+
:mapping,
|
2530
|
+
:output_conversion,
|
2531
|
+
:sample_documents)
|
1933
2532
|
SENSITIVE = []
|
1934
2533
|
include Aws::Structure
|
1935
2534
|
end
|
@@ -1948,6 +2547,20 @@ module Aws::B2bi
|
|
1948
2547
|
# Returns the name of the transformer.
|
1949
2548
|
# @return [String]
|
1950
2549
|
#
|
2550
|
+
# @!attribute [rw] status
|
2551
|
+
# Returns the state of the newly created transformer. The transformer
|
2552
|
+
# can be either `active` or `inactive`. For the transformer to be used
|
2553
|
+
# in a capability, its status must `active`.
|
2554
|
+
# @return [String]
|
2555
|
+
#
|
2556
|
+
# @!attribute [rw] created_at
|
2557
|
+
# Returns a timestamp for creation date and time of the transformer.
|
2558
|
+
# @return [Time]
|
2559
|
+
#
|
2560
|
+
# @!attribute [rw] modified_at
|
2561
|
+
# Returns a timestamp for last time the transformer was modified.
|
2562
|
+
# @return [Time]
|
2563
|
+
#
|
1951
2564
|
# @!attribute [rw] file_format
|
1952
2565
|
# Returns that the currently supported file formats for EDI
|
1953
2566
|
# transformations are `JSON` and `XML`.
|
@@ -1958,12 +2571,6 @@ module Aws::B2bi
|
|
1958
2571
|
# used to map the parsed EDI file using JSONata or XSLT.
|
1959
2572
|
# @return [String]
|
1960
2573
|
#
|
1961
|
-
# @!attribute [rw] status
|
1962
|
-
# Returns the state of the newly created transformer. The transformer
|
1963
|
-
# can be either `active` or `inactive`. For the transformer to be used
|
1964
|
-
# in a capability, its status must `active`.
|
1965
|
-
# @return [String]
|
1966
|
-
#
|
1967
2574
|
# @!attribute [rw] edi_type
|
1968
2575
|
# Returns the details for the EDI standard that is being used for the
|
1969
2576
|
# transformer. Currently, only X12 is supported. X12 is a set of
|
@@ -1976,13 +2583,26 @@ module Aws::B2bi
|
|
1976
2583
|
# guide for processing the EDI data.
|
1977
2584
|
# @return [String]
|
1978
2585
|
#
|
1979
|
-
# @!attribute [rw]
|
1980
|
-
# Returns
|
1981
|
-
#
|
2586
|
+
# @!attribute [rw] input_conversion
|
2587
|
+
# Returns the `InputConversion` object, which contains the format
|
2588
|
+
# options for the inbound transformation.
|
2589
|
+
# @return [Types::InputConversion]
|
1982
2590
|
#
|
1983
|
-
# @!attribute [rw]
|
1984
|
-
# Returns
|
1985
|
-
#
|
2591
|
+
# @!attribute [rw] mapping
|
2592
|
+
# Returns the structure that contains the mapping template and its
|
2593
|
+
# language (either XSLT or JSONATA).
|
2594
|
+
# @return [Types::Mapping]
|
2595
|
+
#
|
2596
|
+
# @!attribute [rw] output_conversion
|
2597
|
+
# Returns the `OutputConversion` object, which contains the format
|
2598
|
+
# options for the outbound transformation.
|
2599
|
+
# @return [Types::OutputConversion]
|
2600
|
+
#
|
2601
|
+
# @!attribute [rw] sample_documents
|
2602
|
+
# Returns a structure that contains the Amazon S3 bucket and an array
|
2603
|
+
# of the corresponding keys used to identify the location for your
|
2604
|
+
# sample documents.
|
2605
|
+
# @return [Types::SampleDocuments]
|
1986
2606
|
#
|
1987
2607
|
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdateTransformerResponse AWS API Documentation
|
1988
2608
|
#
|
@@ -1990,13 +2610,17 @@ module Aws::B2bi
|
|
1990
2610
|
:transformer_id,
|
1991
2611
|
:transformer_arn,
|
1992
2612
|
:name,
|
2613
|
+
:status,
|
2614
|
+
:created_at,
|
2615
|
+
:modified_at,
|
1993
2616
|
:file_format,
|
1994
2617
|
:mapping_template,
|
1995
|
-
:status,
|
1996
2618
|
:edi_type,
|
1997
2619
|
:sample_document,
|
1998
|
-
:
|
1999
|
-
:
|
2620
|
+
:input_conversion,
|
2621
|
+
:mapping,
|
2622
|
+
:output_conversion,
|
2623
|
+
:sample_documents)
|
2000
2624
|
SENSITIVE = []
|
2001
2625
|
include Aws::Structure
|
2002
2626
|
end
|
@@ -2015,6 +2639,34 @@ module Aws::B2bi
|
|
2015
2639
|
include Aws::Structure
|
2016
2640
|
end
|
2017
2641
|
|
2642
|
+
# In X12 EDI messages, delimiters are used to mark the end of segments
|
2643
|
+
# or elements, and are defined in the interchange control header. The
|
2644
|
+
# delimiters are part of the message's syntax and divide up its
|
2645
|
+
# different elements.
|
2646
|
+
#
|
2647
|
+
# @!attribute [rw] component_separator
|
2648
|
+
# The component, or sub-element, separator. The default value is `:`
|
2649
|
+
# (colon).
|
2650
|
+
# @return [String]
|
2651
|
+
#
|
2652
|
+
# @!attribute [rw] data_element_separator
|
2653
|
+
# The data element separator. The default value is `*` (asterisk).
|
2654
|
+
# @return [String]
|
2655
|
+
#
|
2656
|
+
# @!attribute [rw] segment_terminator
|
2657
|
+
# The segment terminator. The default value is `~` (tilde).
|
2658
|
+
# @return [String]
|
2659
|
+
#
|
2660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/X12Delimiters AWS API Documentation
|
2661
|
+
#
|
2662
|
+
class X12Delimiters < Struct.new(
|
2663
|
+
:component_separator,
|
2664
|
+
:data_element_separator,
|
2665
|
+
:segment_terminator)
|
2666
|
+
SENSITIVE = []
|
2667
|
+
include Aws::Structure
|
2668
|
+
end
|
2669
|
+
|
2018
2670
|
# A structure that contains the X12 transaction set and version. The X12
|
2019
2671
|
# structure is used when the system transforms an EDI (electronic data
|
2020
2672
|
# interchange) file.
|
@@ -2033,7 +2685,6 @@ module Aws::B2bi
|
|
2033
2685
|
#
|
2034
2686
|
# @!attribute [rw] version
|
2035
2687
|
# Returns the version to use for the specified X12 transaction set.
|
2036
|
-
# </p>
|
2037
2688
|
# @return [String]
|
2038
2689
|
#
|
2039
2690
|
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/X12Details AWS API Documentation
|
@@ -2045,6 +2696,168 @@ module Aws::B2bi
|
|
2045
2696
|
include Aws::Structure
|
2046
2697
|
end
|
2047
2698
|
|
2699
|
+
# A wrapper structure for an X12 definition object.
|
2700
|
+
#
|
2701
|
+
# the X12 envelope ensures the integrity of the data and the efficiency
|
2702
|
+
# of the information exchange. The X12 message structure has
|
2703
|
+
# hierarchical levels. From highest to the lowest, they are:
|
2704
|
+
#
|
2705
|
+
# * Interchange Envelope
|
2706
|
+
#
|
2707
|
+
# * Functional Group
|
2708
|
+
#
|
2709
|
+
# * Transaction Set
|
2710
|
+
#
|
2711
|
+
# @!attribute [rw] common
|
2712
|
+
# A container for the X12 outbound EDI headers.
|
2713
|
+
# @return [Types::X12OutboundEdiHeaders]
|
2714
|
+
#
|
2715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/X12Envelope AWS API Documentation
|
2716
|
+
#
|
2717
|
+
class X12Envelope < Struct.new(
|
2718
|
+
:common)
|
2719
|
+
SENSITIVE = []
|
2720
|
+
include Aws::Structure
|
2721
|
+
end
|
2722
|
+
|
2723
|
+
# Part of the X12 message structure. These are the functional group
|
2724
|
+
# headers for the X12 EDI object.
|
2725
|
+
#
|
2726
|
+
# @!attribute [rw] application_sender_code
|
2727
|
+
# A value representing the code used to identify the party
|
2728
|
+
# transmitting a message, at position GS-02.
|
2729
|
+
# @return [String]
|
2730
|
+
#
|
2731
|
+
# @!attribute [rw] application_receiver_code
|
2732
|
+
# A value representing the code used to identify the party receiving a
|
2733
|
+
# message, at position GS-03.
|
2734
|
+
# @return [String]
|
2735
|
+
#
|
2736
|
+
# @!attribute [rw] responsible_agency_code
|
2737
|
+
# A code that identifies the issuer of the standard, at position
|
2738
|
+
# GS-07.
|
2739
|
+
# @return [String]
|
2740
|
+
#
|
2741
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/X12FunctionalGroupHeaders AWS API Documentation
|
2742
|
+
#
|
2743
|
+
class X12FunctionalGroupHeaders < Struct.new(
|
2744
|
+
:application_sender_code,
|
2745
|
+
:application_receiver_code,
|
2746
|
+
:responsible_agency_code)
|
2747
|
+
SENSITIVE = []
|
2748
|
+
include Aws::Structure
|
2749
|
+
end
|
2750
|
+
|
2751
|
+
# In X12, the Interchange Control Header is the first segment of an EDI
|
2752
|
+
# document and is part of the Interchange Envelope. It contains
|
2753
|
+
# information about the sender and receiver, the date and time of
|
2754
|
+
# transmission, and the X12 version being used. It also includes
|
2755
|
+
# delivery information, such as the sender and receiver IDs.
|
2756
|
+
#
|
2757
|
+
# @!attribute [rw] sender_id_qualifier
|
2758
|
+
# Located at position ISA-05 in the header. Qualifier for the sender
|
2759
|
+
# ID. Together, the ID and qualifier uniquely identify the sending
|
2760
|
+
# trading partner.
|
2761
|
+
# @return [String]
|
2762
|
+
#
|
2763
|
+
# @!attribute [rw] sender_id
|
2764
|
+
# Located at position ISA-06 in the header. This value (along with the
|
2765
|
+
# `senderIdQualifier`) identifies the sender of the interchange.
|
2766
|
+
# @return [String]
|
2767
|
+
#
|
2768
|
+
# @!attribute [rw] receiver_id_qualifier
|
2769
|
+
# Located at position ISA-07 in the header. Qualifier for the receiver
|
2770
|
+
# ID. Together, the ID and qualifier uniquely identify the receiving
|
2771
|
+
# trading partner.
|
2772
|
+
# @return [String]
|
2773
|
+
#
|
2774
|
+
# @!attribute [rw] receiver_id
|
2775
|
+
# Located at position ISA-08 in the header. This value (along with the
|
2776
|
+
# `receiverIdQualifier`) identifies the intended recipient of the
|
2777
|
+
# interchange.
|
2778
|
+
# @return [String]
|
2779
|
+
#
|
2780
|
+
# @!attribute [rw] repetition_separator
|
2781
|
+
# Located at position ISA-11 in the header. This string makes it
|
2782
|
+
# easier when you need to group similar adjacent element values
|
2783
|
+
# together without using extra segments.
|
2784
|
+
#
|
2785
|
+
# <note markdown="1"> This parameter is only honored for version greater than 401
|
2786
|
+
# (`VERSION_4010` and higher).
|
2787
|
+
#
|
2788
|
+
# For versions less than 401, this field is called [StandardsId][1],
|
2789
|
+
# in which case our service sets the value to `U`.
|
2790
|
+
#
|
2791
|
+
# </note>
|
2792
|
+
#
|
2793
|
+
#
|
2794
|
+
#
|
2795
|
+
# [1]: https://www.stedi.com/edi/x12-004010/segment/ISA#ISA-11
|
2796
|
+
# @return [String]
|
2797
|
+
#
|
2798
|
+
# @!attribute [rw] acknowledgment_requested_code
|
2799
|
+
# Located at position ISA-14 in the header. The value "1" indicates
|
2800
|
+
# that the sender is requesting an interchange acknowledgment at
|
2801
|
+
# receipt of the interchange. The value "0" is used otherwise.
|
2802
|
+
# @return [String]
|
2803
|
+
#
|
2804
|
+
# @!attribute [rw] usage_indicator_code
|
2805
|
+
# Located at position ISA-15 in the header. Specifies how this
|
2806
|
+
# interchange is being used:
|
2807
|
+
#
|
2808
|
+
# * `T` indicates this interchange is for testing.
|
2809
|
+
#
|
2810
|
+
# * `P` indicates this interchange is for production.
|
2811
|
+
#
|
2812
|
+
# * `I` indicates this interchange is informational.
|
2813
|
+
# @return [String]
|
2814
|
+
#
|
2815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/X12InterchangeControlHeaders AWS API Documentation
|
2816
|
+
#
|
2817
|
+
class X12InterchangeControlHeaders < Struct.new(
|
2818
|
+
:sender_id_qualifier,
|
2819
|
+
:sender_id,
|
2820
|
+
:receiver_id_qualifier,
|
2821
|
+
:receiver_id,
|
2822
|
+
:repetition_separator,
|
2823
|
+
:acknowledgment_requested_code,
|
2824
|
+
:usage_indicator_code)
|
2825
|
+
SENSITIVE = []
|
2826
|
+
include Aws::Structure
|
2827
|
+
end
|
2828
|
+
|
2829
|
+
# A structure containing the details for an outbound EDI object.
|
2830
|
+
#
|
2831
|
+
# @!attribute [rw] interchange_control_headers
|
2832
|
+
# In X12 EDI messages, delimiters are used to mark the end of segments
|
2833
|
+
# or elements, and are defined in the interchange control header.
|
2834
|
+
# @return [Types::X12InterchangeControlHeaders]
|
2835
|
+
#
|
2836
|
+
# @!attribute [rw] functional_group_headers
|
2837
|
+
# The functional group headers for the X12 object.
|
2838
|
+
# @return [Types::X12FunctionalGroupHeaders]
|
2839
|
+
#
|
2840
|
+
# @!attribute [rw] delimiters
|
2841
|
+
# The delimiters, for example semicolon (`;`), that separates sections
|
2842
|
+
# of the headers for the X12 object.
|
2843
|
+
# @return [Types::X12Delimiters]
|
2844
|
+
#
|
2845
|
+
# @!attribute [rw] validate_edi
|
2846
|
+
# Specifies whether or not to validate the EDI for this X12 object:
|
2847
|
+
# `TRUE` or `FALSE`.
|
2848
|
+
# @return [Boolean]
|
2849
|
+
#
|
2850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/X12OutboundEdiHeaders AWS API Documentation
|
2851
|
+
#
|
2852
|
+
class X12OutboundEdiHeaders < Struct.new(
|
2853
|
+
:interchange_control_headers,
|
2854
|
+
:functional_group_headers,
|
2855
|
+
:delimiters,
|
2856
|
+
:validate_edi)
|
2857
|
+
SENSITIVE = []
|
2858
|
+
include Aws::Structure
|
2859
|
+
end
|
2860
|
+
|
2048
2861
|
end
|
2049
2862
|
end
|
2050
2863
|
|