aws-sdk-b2bi 1.0.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.
@@ -0,0 +1,2051 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::B2bi
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
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.
30
+ #
31
+ # @note CapabilityConfiguration is a union - when making an API calls you must set exactly one of the members.
32
+ #
33
+ # @note CapabilityConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CapabilityConfiguration corresponding to the set member.
34
+ #
35
+ # @!attribute [rw] edi
36
+ # An EDI (electronic data interchange) configuration object.
37
+ # @return [Types::EdiConfiguration]
38
+ #
39
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CapabilityConfiguration AWS API Documentation
40
+ #
41
+ class CapabilityConfiguration < Struct.new(
42
+ :edi,
43
+ :unknown)
44
+ SENSITIVE = []
45
+ include Aws::Structure
46
+ include Aws::Structure::Union
47
+
48
+ class Edi < CapabilityConfiguration; end
49
+ class Unknown < CapabilityConfiguration; end
50
+ end
51
+
52
+ # Returns the capability summary details. Capabilities contain the
53
+ # information necessary to process incoming EDI (electronic data
54
+ # interchange) documents.
55
+ #
56
+ # @!attribute [rw] capability_id
57
+ # Returns a system-assigned unique identifier for the capability.
58
+ # @return [String]
59
+ #
60
+ # @!attribute [rw] name
61
+ # The display name of the capability.
62
+ # @return [String]
63
+ #
64
+ # @!attribute [rw] type
65
+ # Returns the type of the capability. Currently, only `edi` is
66
+ # supported.
67
+ # @return [String]
68
+ #
69
+ # @!attribute [rw] created_at
70
+ # Returns a timestamp for creation date and time of the capability.
71
+ # @return [Time]
72
+ #
73
+ # @!attribute [rw] modified_at
74
+ # Returns a timestamp that identifies the most recent date and time
75
+ # that the capability was modified.
76
+ # @return [Time]
77
+ #
78
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CapabilitySummary AWS API Documentation
79
+ #
80
+ class CapabilitySummary < Struct.new(
81
+ :capability_id,
82
+ :name,
83
+ :type,
84
+ :created_at,
85
+ :modified_at)
86
+ SENSITIVE = []
87
+ include Aws::Structure
88
+ end
89
+
90
+ # A conflict exception is thrown when you attempt to delete a resource
91
+ # (such as a profile or a capability) that is being used by other
92
+ # resources.
93
+ #
94
+ # @!attribute [rw] message
95
+ # @return [String]
96
+ #
97
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ConflictException AWS API Documentation
98
+ #
99
+ class ConflictException < Struct.new(
100
+ :message)
101
+ SENSITIVE = []
102
+ include Aws::Structure
103
+ end
104
+
105
+ # @!attribute [rw] name
106
+ # Specifies the name of the capability, used to identify it.
107
+ # @return [String]
108
+ #
109
+ # @!attribute [rw] type
110
+ # Specifies the type of the capability. Currently, only `edi` is
111
+ # supported.
112
+ # @return [String]
113
+ #
114
+ # @!attribute [rw] configuration
115
+ # Specifies a structure that contains the details for a capability.
116
+ # @return [Types::CapabilityConfiguration]
117
+ #
118
+ # @!attribute [rw] instructions_documents
119
+ # Specifies one or more locations in Amazon S3, each specifying an EDI
120
+ # document that can be used with this capability. Each item contains
121
+ # the name of the bucket and the key, to identify the document's
122
+ # location.
123
+ # @return [Array<Types::S3Location>]
124
+ #
125
+ # @!attribute [rw] client_token
126
+ # Reserved for future use.
127
+ #
128
+ # **A suitable default value is auto-generated.** You should normally
129
+ # not need to pass this option.
130
+ # @return [String]
131
+ #
132
+ # @!attribute [rw] tags
133
+ # Specifies the key-value pairs assigned to ARNs that you can use to
134
+ # group and search for resources by type. You can attach this metadata
135
+ # to resources (capabilities, partnerships, and so on) for any
136
+ # purpose.
137
+ # @return [Array<Types::Tag>]
138
+ #
139
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateCapabilityRequest AWS API Documentation
140
+ #
141
+ class CreateCapabilityRequest < Struct.new(
142
+ :name,
143
+ :type,
144
+ :configuration,
145
+ :instructions_documents,
146
+ :client_token,
147
+ :tags)
148
+ SENSITIVE = []
149
+ include Aws::Structure
150
+ end
151
+
152
+ # @!attribute [rw] capability_id
153
+ # Returns a system-assigned unique identifier for the capability.
154
+ # @return [String]
155
+ #
156
+ # @!attribute [rw] capability_arn
157
+ # Returns an Amazon Resource Name (ARN) for a specific Amazon Web
158
+ # Services resource, such as a capability, partnership, profile, or
159
+ # transformer.
160
+ # @return [String]
161
+ #
162
+ # @!attribute [rw] name
163
+ # Returns the name of the capability used to identify it.
164
+ # @return [String]
165
+ #
166
+ # @!attribute [rw] type
167
+ # Returns the type of the capability. Currently, only `edi` is
168
+ # supported.
169
+ # @return [String]
170
+ #
171
+ # @!attribute [rw] configuration
172
+ # Returns a structure that contains the details for a capability.
173
+ # @return [Types::CapabilityConfiguration]
174
+ #
175
+ # @!attribute [rw] instructions_documents
176
+ # Returns one or more locations in Amazon S3, each specifying an EDI
177
+ # document that can be used with this capability. Each item contains
178
+ # the name of the bucket and the key, to identify the document's
179
+ # location.
180
+ # @return [Array<Types::S3Location>]
181
+ #
182
+ # @!attribute [rw] created_at
183
+ # Returns a timestamp for creation date and time of the capability.
184
+ # @return [Time]
185
+ #
186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateCapabilityResponse AWS API Documentation
187
+ #
188
+ class CreateCapabilityResponse < Struct.new(
189
+ :capability_id,
190
+ :capability_arn,
191
+ :name,
192
+ :type,
193
+ :configuration,
194
+ :instructions_documents,
195
+ :created_at)
196
+ SENSITIVE = []
197
+ include Aws::Structure
198
+ end
199
+
200
+ # @!attribute [rw] profile_id
201
+ # Specifies the unique, system-generated identifier for the profile
202
+ # connected to this partnership.
203
+ # @return [String]
204
+ #
205
+ # @!attribute [rw] name
206
+ # Specifies a descriptive name for the partnership.
207
+ # @return [String]
208
+ #
209
+ # @!attribute [rw] email
210
+ # Specifies the email address associated with this trading partner.
211
+ # @return [String]
212
+ #
213
+ # @!attribute [rw] phone
214
+ # Specifies the phone number associated with the partnership.
215
+ # @return [String]
216
+ #
217
+ # @!attribute [rw] capabilities
218
+ # Specifies a list of the capabilities associated with this
219
+ # partnership.
220
+ # @return [Array<String>]
221
+ #
222
+ # @!attribute [rw] client_token
223
+ # Reserved for future use.
224
+ #
225
+ # **A suitable default value is auto-generated.** You should normally
226
+ # not need to pass this option.
227
+ # @return [String]
228
+ #
229
+ # @!attribute [rw] tags
230
+ # Specifies the key-value pairs assigned to ARNs that you can use to
231
+ # group and search for resources by type. You can attach this metadata
232
+ # to resources (capabilities, partnerships, and so on) for any
233
+ # purpose.
234
+ # @return [Array<Types::Tag>]
235
+ #
236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreatePartnershipRequest AWS API Documentation
237
+ #
238
+ class CreatePartnershipRequest < Struct.new(
239
+ :profile_id,
240
+ :name,
241
+ :email,
242
+ :phone,
243
+ :capabilities,
244
+ :client_token,
245
+ :tags)
246
+ SENSITIVE = [:email, :phone]
247
+ include Aws::Structure
248
+ end
249
+
250
+ # @!attribute [rw] profile_id
251
+ # Returns the unique, system-generated identifier for the profile
252
+ # connected to this partnership.
253
+ # @return [String]
254
+ #
255
+ # @!attribute [rw] partnership_id
256
+ # Returns the unique, system-generated identifier for a partnership.
257
+ # @return [String]
258
+ #
259
+ # @!attribute [rw] partnership_arn
260
+ # Returns an Amazon Resource Name (ARN) for a specific Amazon Web
261
+ # Services resource, such as a capability, partnership, profile, or
262
+ # transformer.
263
+ # @return [String]
264
+ #
265
+ # @!attribute [rw] name
266
+ # Returns a descriptive name for the partnership.
267
+ # @return [String]
268
+ #
269
+ # @!attribute [rw] email
270
+ # Returns the email address associated with this trading partner.
271
+ # @return [String]
272
+ #
273
+ # @!attribute [rw] phone
274
+ # Returns the phone number associated with the partnership.
275
+ # @return [String]
276
+ #
277
+ # @!attribute [rw] capabilities
278
+ # Returns one or more capabilities associated with this partnership.
279
+ # @return [Array<String>]
280
+ #
281
+ # @!attribute [rw] trading_partner_id
282
+ # Returns the unique, system-generated identifier for a trading
283
+ # partner.
284
+ # @return [String]
285
+ #
286
+ # @!attribute [rw] created_at
287
+ # Returns a timestamp for creation date and time of the partnership.
288
+ # @return [Time]
289
+ #
290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreatePartnershipResponse AWS API Documentation
291
+ #
292
+ class CreatePartnershipResponse < Struct.new(
293
+ :profile_id,
294
+ :partnership_id,
295
+ :partnership_arn,
296
+ :name,
297
+ :email,
298
+ :phone,
299
+ :capabilities,
300
+ :trading_partner_id,
301
+ :created_at)
302
+ SENSITIVE = [:email, :phone]
303
+ include Aws::Structure
304
+ end
305
+
306
+ # @!attribute [rw] name
307
+ # Specifies the name of the profile.
308
+ # @return [String]
309
+ #
310
+ # @!attribute [rw] email
311
+ # Specifies the email address associated with this customer profile.
312
+ # @return [String]
313
+ #
314
+ # @!attribute [rw] phone
315
+ # Specifies the phone number associated with the profile.
316
+ # @return [String]
317
+ #
318
+ # @!attribute [rw] business_name
319
+ # Specifies the name for the business associated with this profile.
320
+ # @return [String]
321
+ #
322
+ # @!attribute [rw] logging
323
+ # Specifies whether or not logging is enabled for this profile.
324
+ # @return [String]
325
+ #
326
+ # @!attribute [rw] client_token
327
+ # Reserved for future use.
328
+ #
329
+ # **A suitable default value is auto-generated.** You should normally
330
+ # not need to pass this option.
331
+ # @return [String]
332
+ #
333
+ # @!attribute [rw] tags
334
+ # Specifies the key-value pairs assigned to ARNs that you can use to
335
+ # group and search for resources by type. You can attach this metadata
336
+ # to resources (capabilities, partnerships, and so on) for any
337
+ # purpose.
338
+ # @return [Array<Types::Tag>]
339
+ #
340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateProfileRequest AWS API Documentation
341
+ #
342
+ class CreateProfileRequest < Struct.new(
343
+ :name,
344
+ :email,
345
+ :phone,
346
+ :business_name,
347
+ :logging,
348
+ :client_token,
349
+ :tags)
350
+ SENSITIVE = [:email, :phone]
351
+ include Aws::Structure
352
+ end
353
+
354
+ # @!attribute [rw] profile_id
355
+ # Returns the unique, system-generated identifier for the profile.
356
+ # @return [String]
357
+ #
358
+ # @!attribute [rw] profile_arn
359
+ # Returns an Amazon Resource Name (ARN) for the profile.
360
+ # @return [String]
361
+ #
362
+ # @!attribute [rw] name
363
+ # Returns the name of the profile, used to identify it.
364
+ # @return [String]
365
+ #
366
+ # @!attribute [rw] business_name
367
+ # Returns the name for the business associated with this profile.
368
+ # @return [String]
369
+ #
370
+ # @!attribute [rw] phone
371
+ # Returns the phone number associated with the profile.
372
+ # @return [String]
373
+ #
374
+ # @!attribute [rw] email
375
+ # Returns the email address associated with this customer profile.
376
+ # @return [String]
377
+ #
378
+ # @!attribute [rw] logging
379
+ # Returns whether or not logging is turned on for this profile.
380
+ # @return [String]
381
+ #
382
+ # @!attribute [rw] log_group_name
383
+ # Returns the name of the logging group.
384
+ # @return [String]
385
+ #
386
+ # @!attribute [rw] created_at
387
+ # Returns a timestamp representing the time the profile was created.
388
+ # @return [Time]
389
+ #
390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateProfileResponse AWS API Documentation
391
+ #
392
+ class CreateProfileResponse < Struct.new(
393
+ :profile_id,
394
+ :profile_arn,
395
+ :name,
396
+ :business_name,
397
+ :phone,
398
+ :email,
399
+ :logging,
400
+ :log_group_name,
401
+ :created_at)
402
+ SENSITIVE = [:phone, :email]
403
+ include Aws::Structure
404
+ end
405
+
406
+ # @!attribute [rw] name
407
+ # Specifies the name of the transformer, used to identify it.
408
+ # @return [String]
409
+ #
410
+ # @!attribute [rw] file_format
411
+ # Specifies that the currently supported file formats for EDI
412
+ # transformations are `JSON` and `XML`.
413
+ # @return [String]
414
+ #
415
+ # @!attribute [rw] mapping_template
416
+ # Specifies the name of the mapping template for the transformer. This
417
+ # template is used to convert the input document into the correct set
418
+ # of objects.
419
+ # @return [String]
420
+ #
421
+ # @!attribute [rw] edi_type
422
+ # Specifies the details for the EDI standard that is being used for
423
+ # the transformer. Currently, only X12 is supported. X12 is a set of
424
+ # standards and corresponding messages that define specific business
425
+ # documents.
426
+ # @return [Types::EdiType]
427
+ #
428
+ # @!attribute [rw] sample_document
429
+ # Specifies a sample EDI document that is used by a transformer as a
430
+ # guide for processing the EDI data.
431
+ # @return [String]
432
+ #
433
+ # @!attribute [rw] client_token
434
+ # Reserved for future use.
435
+ #
436
+ # **A suitable default value is auto-generated.** You should normally
437
+ # not need to pass this option.
438
+ # @return [String]
439
+ #
440
+ # @!attribute [rw] tags
441
+ # Specifies the key-value pairs assigned to ARNs that you can use to
442
+ # group and search for resources by type. You can attach this metadata
443
+ # to resources (capabilities, partnerships, and so on) for any
444
+ # purpose.
445
+ # @return [Array<Types::Tag>]
446
+ #
447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateTransformerRequest AWS API Documentation
448
+ #
449
+ class CreateTransformerRequest < Struct.new(
450
+ :name,
451
+ :file_format,
452
+ :mapping_template,
453
+ :edi_type,
454
+ :sample_document,
455
+ :client_token,
456
+ :tags)
457
+ SENSITIVE = []
458
+ include Aws::Structure
459
+ end
460
+
461
+ # @!attribute [rw] transformer_id
462
+ # Returns the system-assigned unique identifier for the transformer.
463
+ # @return [String]
464
+ #
465
+ # @!attribute [rw] transformer_arn
466
+ # Returns an Amazon Resource Name (ARN) for a specific Amazon Web
467
+ # Services resource, such as a capability, partnership, profile, or
468
+ # transformer.
469
+ # @return [String]
470
+ #
471
+ # @!attribute [rw] name
472
+ # Returns the name of the transformer, used to identify it.
473
+ # @return [String]
474
+ #
475
+ # @!attribute [rw] file_format
476
+ # Returns that the currently supported file formats for EDI
477
+ # transformations are `JSON` and `XML`.
478
+ # @return [String]
479
+ #
480
+ # @!attribute [rw] mapping_template
481
+ # Returns the name of the mapping template for the transformer. This
482
+ # template is used to convert the input document into the correct set
483
+ # of objects.
484
+ # @return [String]
485
+ #
486
+ # @!attribute [rw] status
487
+ # Returns the state of the newly created transformer. The transformer
488
+ # can be either `active` or `inactive`. For the transformer to be used
489
+ # in a capability, its status must `active`.
490
+ # @return [String]
491
+ #
492
+ # @!attribute [rw] edi_type
493
+ # Returns the details for the EDI standard that is being used for the
494
+ # transformer. Currently, only X12 is supported. X12 is a set of
495
+ # standards and corresponding messages that define specific business
496
+ # documents.
497
+ # @return [Types::EdiType]
498
+ #
499
+ # @!attribute [rw] sample_document
500
+ # Returns a sample EDI document that is used by a transformer as a
501
+ # guide for processing the EDI data.
502
+ # @return [String]
503
+ #
504
+ # @!attribute [rw] created_at
505
+ # Returns a timestamp for creation date and time of the transformer.
506
+ # @return [Time]
507
+ #
508
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/CreateTransformerResponse AWS API Documentation
509
+ #
510
+ class CreateTransformerResponse < Struct.new(
511
+ :transformer_id,
512
+ :transformer_arn,
513
+ :name,
514
+ :file_format,
515
+ :mapping_template,
516
+ :status,
517
+ :edi_type,
518
+ :sample_document,
519
+ :created_at)
520
+ SENSITIVE = []
521
+ include Aws::Structure
522
+ end
523
+
524
+ # @!attribute [rw] capability_id
525
+ # Specifies a system-assigned unique identifier for the capability.
526
+ # @return [String]
527
+ #
528
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/DeleteCapabilityRequest AWS API Documentation
529
+ #
530
+ class DeleteCapabilityRequest < Struct.new(
531
+ :capability_id)
532
+ SENSITIVE = []
533
+ include Aws::Structure
534
+ end
535
+
536
+ # @!attribute [rw] partnership_id
537
+ # Specifies the unique, system-generated identifier for a partnership.
538
+ # @return [String]
539
+ #
540
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/DeletePartnershipRequest AWS API Documentation
541
+ #
542
+ class DeletePartnershipRequest < Struct.new(
543
+ :partnership_id)
544
+ SENSITIVE = []
545
+ include Aws::Structure
546
+ end
547
+
548
+ # @!attribute [rw] profile_id
549
+ # Specifies the unique, system-generated identifier for the profile.
550
+ # @return [String]
551
+ #
552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/DeleteProfileRequest AWS API Documentation
553
+ #
554
+ class DeleteProfileRequest < Struct.new(
555
+ :profile_id)
556
+ SENSITIVE = []
557
+ include Aws::Structure
558
+ end
559
+
560
+ # @!attribute [rw] transformer_id
561
+ # Specifies the system-assigned unique identifier for the transformer.
562
+ # @return [String]
563
+ #
564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/DeleteTransformerRequest AWS API Documentation
565
+ #
566
+ class DeleteTransformerRequest < Struct.new(
567
+ :transformer_id)
568
+ SENSITIVE = []
569
+ include Aws::Structure
570
+ end
571
+
572
+ # Specifies the details for the EDI (electronic data interchange)
573
+ # transformation.
574
+ #
575
+ # @!attribute [rw] type
576
+ # Returns the type of the capability. Currently, only `edi` is
577
+ # supported.
578
+ # @return [Types::EdiType]
579
+ #
580
+ # @!attribute [rw] input_location
581
+ # Contains the Amazon S3 bucket and prefix for the location of the
582
+ # input file, which is contained in an `S3Location` object.
583
+ # @return [Types::S3Location]
584
+ #
585
+ # @!attribute [rw] output_location
586
+ # Contains the Amazon S3 bucket and prefix for the location of the
587
+ # output file, which is contained in an `S3Location` object.
588
+ # @return [Types::S3Location]
589
+ #
590
+ # @!attribute [rw] transformer_id
591
+ # Returns the system-assigned unique identifier for the transformer.
592
+ # @return [String]
593
+ #
594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/EdiConfiguration AWS API Documentation
595
+ #
596
+ class EdiConfiguration < Struct.new(
597
+ :type,
598
+ :input_location,
599
+ :output_location,
600
+ :transformer_id)
601
+ SENSITIVE = []
602
+ include Aws::Structure
603
+ end
604
+
605
+ # Specifies the details for the EDI standard that is being used for the
606
+ # transformer. Currently, only X12 is supported. X12 is a set of
607
+ # standards and corresponding messages that define specific business
608
+ # documents.
609
+ #
610
+ # @note EdiType is a union - when making an API calls you must set exactly one of the members.
611
+ #
612
+ # @note EdiType is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EdiType corresponding to the set member.
613
+ #
614
+ # @!attribute [rw] x12_details
615
+ # Returns the details for the EDI standard that is being used for the
616
+ # transformer. Currently, only X12 is supported. X12 is a set of
617
+ # standards and corresponding messages that define specific business
618
+ # documents.
619
+ # @return [Types::X12Details]
620
+ #
621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/EdiType AWS API Documentation
622
+ #
623
+ class EdiType < Struct.new(
624
+ :x12_details,
625
+ :unknown)
626
+ SENSITIVE = []
627
+ include Aws::Structure
628
+ include Aws::Structure::Union
629
+
630
+ class X12Details < EdiType; end
631
+ class Unknown < EdiType; end
632
+ end
633
+
634
+ # @!attribute [rw] capability_id
635
+ # Specifies a system-assigned unique identifier for the capability.
636
+ # @return [String]
637
+ #
638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetCapabilityRequest AWS API Documentation
639
+ #
640
+ class GetCapabilityRequest < Struct.new(
641
+ :capability_id)
642
+ SENSITIVE = []
643
+ include Aws::Structure
644
+ end
645
+
646
+ # @!attribute [rw] capability_id
647
+ # Returns a system-assigned unique identifier for the capability.
648
+ # @return [String]
649
+ #
650
+ # @!attribute [rw] capability_arn
651
+ # Returns an Amazon Resource Name (ARN) for a specific Amazon Web
652
+ # Services resource, such as a capability, partnership, profile, or
653
+ # transformer.
654
+ # @return [String]
655
+ #
656
+ # @!attribute [rw] name
657
+ # Returns the name of the capability, used to identify it.
658
+ # @return [String]
659
+ #
660
+ # @!attribute [rw] type
661
+ # Returns the type of the capability. Currently, only `edi` is
662
+ # supported.
663
+ # @return [String]
664
+ #
665
+ # @!attribute [rw] configuration
666
+ # Returns a structure that contains the details for a capability.
667
+ # @return [Types::CapabilityConfiguration]
668
+ #
669
+ # @!attribute [rw] instructions_documents
670
+ # Returns one or more locations in Amazon S3, each specifying an EDI
671
+ # document that can be used with this capability. Each item contains
672
+ # the name of the bucket and the key, to identify the document's
673
+ # location.
674
+ # @return [Array<Types::S3Location>]
675
+ #
676
+ # @!attribute [rw] created_at
677
+ # Returns a timestamp for creation date and time of the capability.
678
+ # @return [Time]
679
+ #
680
+ # @!attribute [rw] modified_at
681
+ # Returns a timestamp for last time the capability was modified.
682
+ # @return [Time]
683
+ #
684
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetCapabilityResponse AWS API Documentation
685
+ #
686
+ class GetCapabilityResponse < Struct.new(
687
+ :capability_id,
688
+ :capability_arn,
689
+ :name,
690
+ :type,
691
+ :configuration,
692
+ :instructions_documents,
693
+ :created_at,
694
+ :modified_at)
695
+ SENSITIVE = []
696
+ include Aws::Structure
697
+ end
698
+
699
+ # @!attribute [rw] partnership_id
700
+ # Specifies the unique, system-generated identifier for a partnership.
701
+ # @return [String]
702
+ #
703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetPartnershipRequest AWS API Documentation
704
+ #
705
+ class GetPartnershipRequest < Struct.new(
706
+ :partnership_id)
707
+ SENSITIVE = []
708
+ include Aws::Structure
709
+ end
710
+
711
+ # @!attribute [rw] profile_id
712
+ # Returns the unique, system-generated identifier for the profile
713
+ # connected to this partnership.
714
+ # @return [String]
715
+ #
716
+ # @!attribute [rw] partnership_id
717
+ # Returns the unique, system-generated identifier for a partnership.
718
+ # @return [String]
719
+ #
720
+ # @!attribute [rw] partnership_arn
721
+ # Returns an Amazon Resource Name (ARN) for a specific Amazon Web
722
+ # Services resource, such as a capability, partnership, profile, or
723
+ # transformer.
724
+ # @return [String]
725
+ #
726
+ # @!attribute [rw] name
727
+ # Returns the display name of the partnership
728
+ # @return [String]
729
+ #
730
+ # @!attribute [rw] email
731
+ # Returns the email address associated with this trading partner.
732
+ # @return [String]
733
+ #
734
+ # @!attribute [rw] phone
735
+ # Returns the phone number associated with the partnership.
736
+ # @return [String]
737
+ #
738
+ # @!attribute [rw] capabilities
739
+ # Returns one or more capabilities associated with this partnership.
740
+ # @return [Array<String>]
741
+ #
742
+ # @!attribute [rw] trading_partner_id
743
+ # Returns the unique identifier for the partner for this partnership.
744
+ # @return [String]
745
+ #
746
+ # @!attribute [rw] created_at
747
+ # Returns a timestamp for creation date and time of the partnership.
748
+ # @return [Time]
749
+ #
750
+ # @!attribute [rw] modified_at
751
+ # Returns a timestamp that identifies the most recent date and time
752
+ # that the partnership was modified.
753
+ # @return [Time]
754
+ #
755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetPartnershipResponse AWS API Documentation
756
+ #
757
+ class GetPartnershipResponse < Struct.new(
758
+ :profile_id,
759
+ :partnership_id,
760
+ :partnership_arn,
761
+ :name,
762
+ :email,
763
+ :phone,
764
+ :capabilities,
765
+ :trading_partner_id,
766
+ :created_at,
767
+ :modified_at)
768
+ SENSITIVE = [:email, :phone]
769
+ include Aws::Structure
770
+ end
771
+
772
+ # @!attribute [rw] profile_id
773
+ # Specifies the unique, system-generated identifier for the profile.
774
+ # @return [String]
775
+ #
776
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetProfileRequest AWS API Documentation
777
+ #
778
+ class GetProfileRequest < Struct.new(
779
+ :profile_id)
780
+ SENSITIVE = []
781
+ include Aws::Structure
782
+ end
783
+
784
+ # @!attribute [rw] profile_id
785
+ # Returns the unique, system-generated identifier for the profile.
786
+ # @return [String]
787
+ #
788
+ # @!attribute [rw] profile_arn
789
+ # Returns an Amazon Resource Name (ARN) for a specific Amazon Web
790
+ # Services resource, such as a capability, partnership, profile, or
791
+ # transformer.
792
+ # @return [String]
793
+ #
794
+ # @!attribute [rw] name
795
+ # Returns the name of the profile, used to identify it.
796
+ # @return [String]
797
+ #
798
+ # @!attribute [rw] email
799
+ # Returns the email address associated with this customer profile.
800
+ # @return [String]
801
+ #
802
+ # @!attribute [rw] phone
803
+ # Returns the phone number associated with the profile.
804
+ # @return [String]
805
+ #
806
+ # @!attribute [rw] business_name
807
+ # Returns the name for the business associated with this profile.
808
+ # @return [String]
809
+ #
810
+ # @!attribute [rw] logging
811
+ # Returns whether or not logging is enabled for this profile.
812
+ # @return [String]
813
+ #
814
+ # @!attribute [rw] log_group_name
815
+ # Returns the name of the logging group.
816
+ # @return [String]
817
+ #
818
+ # @!attribute [rw] created_at
819
+ # Returns a timestamp for creation date and time of the transformer.
820
+ # @return [Time]
821
+ #
822
+ # @!attribute [rw] modified_at
823
+ # Returns a timestamp for last time the profile was modified.
824
+ # @return [Time]
825
+ #
826
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetProfileResponse AWS API Documentation
827
+ #
828
+ class GetProfileResponse < Struct.new(
829
+ :profile_id,
830
+ :profile_arn,
831
+ :name,
832
+ :email,
833
+ :phone,
834
+ :business_name,
835
+ :logging,
836
+ :log_group_name,
837
+ :created_at,
838
+ :modified_at)
839
+ SENSITIVE = [:email, :phone]
840
+ include Aws::Structure
841
+ end
842
+
843
+ # @!attribute [rw] transformer_job_id
844
+ # Specifies the unique, system-generated identifier for a transformer
845
+ # run.
846
+ # @return [String]
847
+ #
848
+ # @!attribute [rw] transformer_id
849
+ # Specifies the system-assigned unique identifier for the transformer.
850
+ # @return [String]
851
+ #
852
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetTransformerJobRequest AWS API Documentation
853
+ #
854
+ class GetTransformerJobRequest < Struct.new(
855
+ :transformer_job_id,
856
+ :transformer_id)
857
+ SENSITIVE = []
858
+ include Aws::Structure
859
+ end
860
+
861
+ # @!attribute [rw] status
862
+ # Returns the current state of the transformer job, either `running`,
863
+ # `succeeded`, or `failed`.
864
+ # @return [String]
865
+ #
866
+ # @!attribute [rw] output_files
867
+ # Returns the location for the output files. If the caller specified a
868
+ # directory for the output, then this contains the full path to the
869
+ # output file, including the file name generated by the service.
870
+ # @return [Array<Types::S3Location>]
871
+ #
872
+ # @!attribute [rw] message
873
+ # Returns an optional error message, which gets populated when the job
874
+ # is not run successfully.
875
+ # @return [String]
876
+ #
877
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetTransformerJobResponse AWS API Documentation
878
+ #
879
+ class GetTransformerJobResponse < Struct.new(
880
+ :status,
881
+ :output_files,
882
+ :message)
883
+ SENSITIVE = []
884
+ include Aws::Structure
885
+ end
886
+
887
+ # @!attribute [rw] transformer_id
888
+ # Specifies the system-assigned unique identifier for the transformer.
889
+ # @return [String]
890
+ #
891
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetTransformerRequest AWS API Documentation
892
+ #
893
+ class GetTransformerRequest < Struct.new(
894
+ :transformer_id)
895
+ SENSITIVE = []
896
+ include Aws::Structure
897
+ end
898
+
899
+ # @!attribute [rw] transformer_id
900
+ # Returns the system-assigned unique identifier for the transformer.
901
+ # @return [String]
902
+ #
903
+ # @!attribute [rw] transformer_arn
904
+ # Returns an Amazon Resource Name (ARN) for a specific Amazon Web
905
+ # Services resource, such as a capability, partnership, profile, or
906
+ # transformer.
907
+ # @return [String]
908
+ #
909
+ # @!attribute [rw] name
910
+ # Returns the name of the transformer, used to identify it.
911
+ # @return [String]
912
+ #
913
+ # @!attribute [rw] file_format
914
+ # Returns that the currently supported file formats for EDI
915
+ # transformations are `JSON` and `XML`.
916
+ # @return [String]
917
+ #
918
+ # @!attribute [rw] mapping_template
919
+ # Returns the name of the mapping template for the transformer. This
920
+ # template is used to convert the input document into the correct set
921
+ # of objects.
922
+ # @return [String]
923
+ #
924
+ # @!attribute [rw] status
925
+ # Returns the state of the newly created transformer. The transformer
926
+ # can be either `active` or `inactive`. For the transformer to be used
927
+ # in a capability, its status must `active`.
928
+ # @return [String]
929
+ #
930
+ # @!attribute [rw] edi_type
931
+ # Returns the details for the EDI standard that is being used for the
932
+ # transformer. Currently, only X12 is supported. X12 is a set of
933
+ # standards and corresponding messages that define specific business
934
+ # documents.
935
+ # @return [Types::EdiType]
936
+ #
937
+ # @!attribute [rw] sample_document
938
+ # Returns a sample EDI document that is used by a transformer as a
939
+ # guide for processing the EDI data.
940
+ # @return [String]
941
+ #
942
+ # @!attribute [rw] created_at
943
+ # Returns a timestamp for creation date and time of the transformer.
944
+ # @return [Time]
945
+ #
946
+ # @!attribute [rw] modified_at
947
+ # Returns a timestamp for last time the transformer was modified.
948
+ # @return [Time]
949
+ #
950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/GetTransformerResponse AWS API Documentation
951
+ #
952
+ class GetTransformerResponse < Struct.new(
953
+ :transformer_id,
954
+ :transformer_arn,
955
+ :name,
956
+ :file_format,
957
+ :mapping_template,
958
+ :status,
959
+ :edi_type,
960
+ :sample_document,
961
+ :created_at,
962
+ :modified_at)
963
+ SENSITIVE = []
964
+ include Aws::Structure
965
+ end
966
+
967
+ # This exception is thrown when an error occurs in the Amazon Web
968
+ # Services B2B Data Interchange service.
969
+ #
970
+ # @!attribute [rw] message
971
+ # @return [String]
972
+ #
973
+ # @!attribute [rw] retry_after_seconds
974
+ # The server attempts to retry a failed command.
975
+ # @return [Integer]
976
+ #
977
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/InternalServerException AWS API Documentation
978
+ #
979
+ class InternalServerException < Struct.new(
980
+ :message,
981
+ :retry_after_seconds)
982
+ SENSITIVE = []
983
+ include Aws::Structure
984
+ end
985
+
986
+ # @!attribute [rw] next_token
987
+ # When additional results are obtained from the command, a `NextToken`
988
+ # parameter is returned in the output. You can then pass the
989
+ # `NextToken` parameter in a subsequent command to continue listing
990
+ # additional resources.
991
+ # @return [String]
992
+ #
993
+ # @!attribute [rw] max_results
994
+ # Specifies the maximum number of capabilities to return.
995
+ # @return [Integer]
996
+ #
997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListCapabilitiesRequest AWS API Documentation
998
+ #
999
+ class ListCapabilitiesRequest < Struct.new(
1000
+ :next_token,
1001
+ :max_results)
1002
+ SENSITIVE = []
1003
+ include Aws::Structure
1004
+ end
1005
+
1006
+ # @!attribute [rw] capabilities
1007
+ # Returns one or more capabilities associated with this partnership.
1008
+ # @return [Array<Types::CapabilitySummary>]
1009
+ #
1010
+ # @!attribute [rw] next_token
1011
+ # When additional results are obtained from the command, a `NextToken`
1012
+ # parameter is returned in the output. You can then pass the
1013
+ # `NextToken` parameter in a subsequent command to continue listing
1014
+ # additional resources.
1015
+ # @return [String]
1016
+ #
1017
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListCapabilitiesResponse AWS API Documentation
1018
+ #
1019
+ class ListCapabilitiesResponse < Struct.new(
1020
+ :capabilities,
1021
+ :next_token)
1022
+ SENSITIVE = []
1023
+ include Aws::Structure
1024
+ end
1025
+
1026
+ # @!attribute [rw] profile_id
1027
+ # Specifies the unique, system-generated identifier for the profile
1028
+ # connected to this partnership.
1029
+ # @return [String]
1030
+ #
1031
+ # @!attribute [rw] next_token
1032
+ # When additional results are obtained from the command, a `NextToken`
1033
+ # parameter is returned in the output. You can then pass the
1034
+ # `NextToken` parameter in a subsequent command to continue listing
1035
+ # additional resources.
1036
+ # @return [String]
1037
+ #
1038
+ # @!attribute [rw] max_results
1039
+ # Specifies the maximum number of capabilities to return.
1040
+ # @return [Integer]
1041
+ #
1042
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListPartnershipsRequest AWS API Documentation
1043
+ #
1044
+ class ListPartnershipsRequest < Struct.new(
1045
+ :profile_id,
1046
+ :next_token,
1047
+ :max_results)
1048
+ SENSITIVE = []
1049
+ include Aws::Structure
1050
+ end
1051
+
1052
+ # @!attribute [rw] partnerships
1053
+ # Specifies a list of your partnerships.
1054
+ # @return [Array<Types::PartnershipSummary>]
1055
+ #
1056
+ # @!attribute [rw] next_token
1057
+ # When additional results are obtained from the command, a `NextToken`
1058
+ # parameter is returned in the output. You can then pass the
1059
+ # `NextToken` parameter in a subsequent command to continue listing
1060
+ # additional resources.
1061
+ # @return [String]
1062
+ #
1063
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListPartnershipsResponse AWS API Documentation
1064
+ #
1065
+ class ListPartnershipsResponse < Struct.new(
1066
+ :partnerships,
1067
+ :next_token)
1068
+ SENSITIVE = []
1069
+ include Aws::Structure
1070
+ end
1071
+
1072
+ # @!attribute [rw] next_token
1073
+ # When additional results are obtained from the command, a `NextToken`
1074
+ # parameter is returned in the output. You can then pass the
1075
+ # `NextToken` parameter in a subsequent command to continue listing
1076
+ # additional resources.
1077
+ # @return [String]
1078
+ #
1079
+ # @!attribute [rw] max_results
1080
+ # Specifies the maximum number of profiles to return.
1081
+ # @return [Integer]
1082
+ #
1083
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListProfilesRequest AWS API Documentation
1084
+ #
1085
+ class ListProfilesRequest < Struct.new(
1086
+ :next_token,
1087
+ :max_results)
1088
+ SENSITIVE = []
1089
+ include Aws::Structure
1090
+ end
1091
+
1092
+ # @!attribute [rw] profiles
1093
+ # Returns an array of `ProfileSummary` objects.
1094
+ # @return [Array<Types::ProfileSummary>]
1095
+ #
1096
+ # @!attribute [rw] next_token
1097
+ # When additional results are obtained from the command, a `NextToken`
1098
+ # parameter is returned in the output. You can then pass the
1099
+ # `NextToken` parameter in a subsequent command to continue listing
1100
+ # additional resources.
1101
+ # @return [String]
1102
+ #
1103
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListProfilesResponse AWS API Documentation
1104
+ #
1105
+ class ListProfilesResponse < Struct.new(
1106
+ :profiles,
1107
+ :next_token)
1108
+ SENSITIVE = []
1109
+ include Aws::Structure
1110
+ end
1111
+
1112
+ # @!attribute [rw] resource_arn
1113
+ # Requests the tags associated with a particular Amazon Resource Name
1114
+ # (ARN). An ARN is an identifier for a specific Amazon Web Services
1115
+ # resource, such as a capability, partnership, profile, or
1116
+ # transformer.
1117
+ # @return [String]
1118
+ #
1119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListTagsForResourceRequest AWS API Documentation
1120
+ #
1121
+ class ListTagsForResourceRequest < Struct.new(
1122
+ :resource_arn)
1123
+ SENSITIVE = []
1124
+ include Aws::Structure
1125
+ end
1126
+
1127
+ # @!attribute [rw] tags
1128
+ # Returns the key-value pairs assigned to ARNs that you can use to
1129
+ # group and search for resources by type. You can attach this metadata
1130
+ # to resources (capabilities, partnerships, and so on) for any
1131
+ # purpose.
1132
+ # @return [Array<Types::Tag>]
1133
+ #
1134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListTagsForResourceResponse AWS API Documentation
1135
+ #
1136
+ class ListTagsForResourceResponse < Struct.new(
1137
+ :tags)
1138
+ SENSITIVE = []
1139
+ include Aws::Structure
1140
+ end
1141
+
1142
+ # @!attribute [rw] next_token
1143
+ # When additional results are obtained from the command, a `NextToken`
1144
+ # parameter is returned in the output. You can then pass the
1145
+ # `NextToken` parameter in a subsequent command to continue listing
1146
+ # additional resources.
1147
+ # @return [String]
1148
+ #
1149
+ # @!attribute [rw] max_results
1150
+ # Specifies the number of items to return for the API response.
1151
+ # @return [Integer]
1152
+ #
1153
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListTransformersRequest AWS API Documentation
1154
+ #
1155
+ class ListTransformersRequest < Struct.new(
1156
+ :next_token,
1157
+ :max_results)
1158
+ SENSITIVE = []
1159
+ include Aws::Structure
1160
+ end
1161
+
1162
+ # @!attribute [rw] transformers
1163
+ # Returns an array of one or more transformer objects.
1164
+ #
1165
+ # For each transformer, a `TransformerSummary` object is returned. The
1166
+ # `TransformerSummary` contains all the details for a specific
1167
+ # transformer.
1168
+ # @return [Array<Types::TransformerSummary>]
1169
+ #
1170
+ # @!attribute [rw] next_token
1171
+ # When additional results are obtained from the command, a `NextToken`
1172
+ # parameter is returned in the output. You can then pass the
1173
+ # `NextToken` parameter in a subsequent command to continue listing
1174
+ # additional resources.
1175
+ # @return [String]
1176
+ #
1177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListTransformersResponse AWS API Documentation
1178
+ #
1179
+ class ListTransformersResponse < Struct.new(
1180
+ :transformers,
1181
+ :next_token)
1182
+ SENSITIVE = []
1183
+ include Aws::Structure
1184
+ end
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.
1190
+ #
1191
+ # @!attribute [rw] profile_id
1192
+ # Returns the unique, system-generated identifier for the profile
1193
+ # connected to this partnership.
1194
+ # @return [String]
1195
+ #
1196
+ # @!attribute [rw] partnership_id
1197
+ # Returns the unique, system-generated identifier for a partnership.
1198
+ # @return [String]
1199
+ #
1200
+ # @!attribute [rw] name
1201
+ # Returns the name of the partnership.
1202
+ # @return [String]
1203
+ #
1204
+ # @!attribute [rw] capabilities
1205
+ # Returns one or more capabilities associated with this partnership.
1206
+ # @return [Array<String>]
1207
+ #
1208
+ # @!attribute [rw] trading_partner_id
1209
+ # Returns the unique, system-generated identifier for a trading
1210
+ # partner.
1211
+ # @return [String]
1212
+ #
1213
+ # @!attribute [rw] created_at
1214
+ # Returns a timestamp for creation date and time of the partnership.
1215
+ # @return [Time]
1216
+ #
1217
+ # @!attribute [rw] modified_at
1218
+ # Returns a timestamp that identifies the most recent date and time
1219
+ # that the partnership was modified.
1220
+ # @return [Time]
1221
+ #
1222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/PartnershipSummary AWS API Documentation
1223
+ #
1224
+ class PartnershipSummary < Struct.new(
1225
+ :profile_id,
1226
+ :partnership_id,
1227
+ :name,
1228
+ :capabilities,
1229
+ :trading_partner_id,
1230
+ :created_at,
1231
+ :modified_at)
1232
+ SENSITIVE = []
1233
+ include Aws::Structure
1234
+ end
1235
+
1236
+ # Contains the details for a profile. Profiles contain basic information
1237
+ # about you and your business.
1238
+ #
1239
+ # @!attribute [rw] profile_id
1240
+ # Returns the unique, system-generated identifier for the profile.
1241
+ # @return [String]
1242
+ #
1243
+ # @!attribute [rw] name
1244
+ # Returns the display name for profile.
1245
+ # @return [String]
1246
+ #
1247
+ # @!attribute [rw] business_name
1248
+ # Returns the name for the business associated with this profile.
1249
+ # @return [String]
1250
+ #
1251
+ # @!attribute [rw] logging
1252
+ # Specifies whether or not logging is enabled for this profile.
1253
+ # @return [String]
1254
+ #
1255
+ # @!attribute [rw] log_group_name
1256
+ # Returns the name of the logging group.
1257
+ # @return [String]
1258
+ #
1259
+ # @!attribute [rw] created_at
1260
+ # Returns the timestamp for creation date and time of the profile.
1261
+ # @return [Time]
1262
+ #
1263
+ # @!attribute [rw] modified_at
1264
+ # Returns the timestamp that identifies the most recent date and time
1265
+ # that the profile was modified.
1266
+ # @return [Time]
1267
+ #
1268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ProfileSummary AWS API Documentation
1269
+ #
1270
+ class ProfileSummary < Struct.new(
1271
+ :profile_id,
1272
+ :name,
1273
+ :business_name,
1274
+ :logging,
1275
+ :log_group_name,
1276
+ :created_at,
1277
+ :modified_at)
1278
+ SENSITIVE = []
1279
+ include Aws::Structure
1280
+ end
1281
+
1282
+ # Occurs when the requested resource does not exist, or cannot be found.
1283
+ # In some cases, the resource exists in a region other than the region
1284
+ # specified in the API call.
1285
+ #
1286
+ # @!attribute [rw] message
1287
+ # @return [String]
1288
+ #
1289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ResourceNotFoundException AWS API Documentation
1290
+ #
1291
+ class ResourceNotFoundException < Struct.new(
1292
+ :message)
1293
+ SENSITIVE = []
1294
+ include Aws::Structure
1295
+ end
1296
+
1297
+ # Specifies the details for the Amazon S3 file location that is being
1298
+ # used with Amazon Web Services B2BI Data Interchange. File locations in
1299
+ # Amazon S3 are identified using a combination of the bucket and key.
1300
+ #
1301
+ # @!attribute [rw] bucket_name
1302
+ # Specifies the name of the Amazon S3 bucket.
1303
+ # @return [String]
1304
+ #
1305
+ # @!attribute [rw] key
1306
+ # Specifies the Amazon S3 key for the file location.
1307
+ # @return [String]
1308
+ #
1309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/S3Location AWS API Documentation
1310
+ #
1311
+ class S3Location < Struct.new(
1312
+ :bucket_name,
1313
+ :key)
1314
+ SENSITIVE = []
1315
+ include Aws::Structure
1316
+ end
1317
+
1318
+ # Occurs when the calling command attempts to exceed one of the service
1319
+ # quotas, for example trying to create a capability when you already
1320
+ # have the maximum number of capabilities allowed.
1321
+ #
1322
+ # @!attribute [rw] message
1323
+ # @return [String]
1324
+ #
1325
+ # @!attribute [rw] resource_id
1326
+ # The ID for the resource that exceeded the quota, which caused the
1327
+ # exception.
1328
+ # @return [String]
1329
+ #
1330
+ # @!attribute [rw] resource_type
1331
+ # The resource type (profile, partnership, transformer, or capability)
1332
+ # that exceeded the quota, which caused the exception.
1333
+ # @return [String]
1334
+ #
1335
+ # @!attribute [rw] service_code
1336
+ # The code responsible for exceeding the quota, which caused the
1337
+ # exception.
1338
+ # @return [String]
1339
+ #
1340
+ # @!attribute [rw] quota_code
1341
+ # The quota that was exceeded, which caused the exception.
1342
+ # @return [String]
1343
+ #
1344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ServiceQuotaExceededException AWS API Documentation
1345
+ #
1346
+ class ServiceQuotaExceededException < Struct.new(
1347
+ :message,
1348
+ :resource_id,
1349
+ :resource_type,
1350
+ :service_code,
1351
+ :quota_code)
1352
+ SENSITIVE = []
1353
+ include Aws::Structure
1354
+ end
1355
+
1356
+ # @!attribute [rw] input_file
1357
+ # Specifies the location of the input file for the transformation. The
1358
+ # location consists of an Amazon S3 bucket and prefix.
1359
+ # @return [Types::S3Location]
1360
+ #
1361
+ # @!attribute [rw] output_location
1362
+ # Specifies the location of the output file for the transformation.
1363
+ # The location consists of an Amazon S3 bucket and prefix.
1364
+ # @return [Types::S3Location]
1365
+ #
1366
+ # @!attribute [rw] transformer_id
1367
+ # Specifies the system-assigned unique identifier for the transformer.
1368
+ # @return [String]
1369
+ #
1370
+ # @!attribute [rw] client_token
1371
+ # Reserved for future use.
1372
+ #
1373
+ # **A suitable default value is auto-generated.** You should normally
1374
+ # not need to pass this option.
1375
+ # @return [String]
1376
+ #
1377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/StartTransformerJobRequest AWS API Documentation
1378
+ #
1379
+ class StartTransformerJobRequest < Struct.new(
1380
+ :input_file,
1381
+ :output_location,
1382
+ :transformer_id,
1383
+ :client_token)
1384
+ SENSITIVE = []
1385
+ include Aws::Structure
1386
+ end
1387
+
1388
+ # @!attribute [rw] transformer_job_id
1389
+ # Returns the unique, system-generated identifier for a transformer
1390
+ # run.
1391
+ # @return [String]
1392
+ #
1393
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/StartTransformerJobResponse AWS API Documentation
1394
+ #
1395
+ class StartTransformerJobResponse < Struct.new(
1396
+ :transformer_job_id)
1397
+ SENSITIVE = []
1398
+ include Aws::Structure
1399
+ end
1400
+
1401
+ # Creates a key-value pair for a specific resource. Tags are metadata
1402
+ # that you can use to search for and group a resource for various
1403
+ # purposes. You can apply tags to capabilities, partnerships, profiles
1404
+ # and transformers. A tag key can take more than one value. For example,
1405
+ # to group capabilities for accounting purposes, you might create a tag
1406
+ # called `Group` and assign the values `Research` and `Accounting` to
1407
+ # that group.
1408
+ #
1409
+ # @!attribute [rw] key
1410
+ # Specifies the name assigned to the tag that you create.
1411
+ # @return [String]
1412
+ #
1413
+ # @!attribute [rw] value
1414
+ # Contains one or more values that you assigned to the key name that
1415
+ # you create.
1416
+ # @return [String]
1417
+ #
1418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/Tag AWS API Documentation
1419
+ #
1420
+ class Tag < Struct.new(
1421
+ :key,
1422
+ :value)
1423
+ SENSITIVE = []
1424
+ include Aws::Structure
1425
+ end
1426
+
1427
+ # @!attribute [rw] resource_arn
1428
+ # Specifies an Amazon Resource Name (ARN) for a specific Amazon Web
1429
+ # Services resource, such as a capability, partnership, profile, or
1430
+ # transformer.
1431
+ # @return [String]
1432
+ #
1433
+ # @!attribute [rw] tags
1434
+ # Specifies the key-value pairs assigned to ARNs that you can use to
1435
+ # group and search for resources by type. You can attach this metadata
1436
+ # to resources (capabilities, partnerships, and so on) for any
1437
+ # purpose.
1438
+ # @return [Array<Types::Tag>]
1439
+ #
1440
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TagResourceRequest AWS API Documentation
1441
+ #
1442
+ class TagResourceRequest < Struct.new(
1443
+ :resource_arn,
1444
+ :tags)
1445
+ SENSITIVE = []
1446
+ include Aws::Structure
1447
+ end
1448
+
1449
+ # @!attribute [rw] input_file_content
1450
+ # Specify the EDI (electronic data interchange) file that is used as
1451
+ # input for the transform.
1452
+ # @return [String]
1453
+ #
1454
+ # @!attribute [rw] mapping_template
1455
+ # Specifies the name of the mapping template for the transformer. This
1456
+ # template is used to convert the input document into the correct set
1457
+ # of objects.
1458
+ # @return [String]
1459
+ #
1460
+ # @!attribute [rw] file_format
1461
+ # Specifies that the currently supported file formats for EDI
1462
+ # transformations are `JSON` and `XML`.
1463
+ # @return [String]
1464
+ #
1465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TestMappingRequest AWS API Documentation
1466
+ #
1467
+ class TestMappingRequest < Struct.new(
1468
+ :input_file_content,
1469
+ :mapping_template,
1470
+ :file_format)
1471
+ SENSITIVE = []
1472
+ include Aws::Structure
1473
+ end
1474
+
1475
+ # @!attribute [rw] mapped_file_content
1476
+ # Returns a string for the mapping that can be used to identify the
1477
+ # mapping. Similar to a fingerprint
1478
+ # @return [String]
1479
+ #
1480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TestMappingResponse AWS API Documentation
1481
+ #
1482
+ class TestMappingResponse < Struct.new(
1483
+ :mapped_file_content)
1484
+ SENSITIVE = []
1485
+ include Aws::Structure
1486
+ end
1487
+
1488
+ # @!attribute [rw] input_file
1489
+ # Specifies an `S3Location` object, which contains the Amazon S3
1490
+ # bucket and prefix for the location of the input file.
1491
+ # @return [Types::S3Location]
1492
+ #
1493
+ # @!attribute [rw] file_format
1494
+ # Specifies that the currently supported file formats for EDI
1495
+ # transformations are `JSON` and `XML`.
1496
+ # @return [String]
1497
+ #
1498
+ # @!attribute [rw] edi_type
1499
+ # Specifies the details for the EDI standard that is being used for
1500
+ # the transformer. Currently, only X12 is supported. X12 is a set of
1501
+ # standards and corresponding messages that define specific business
1502
+ # documents.
1503
+ # @return [Types::EdiType]
1504
+ #
1505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TestParsingRequest AWS API Documentation
1506
+ #
1507
+ class TestParsingRequest < Struct.new(
1508
+ :input_file,
1509
+ :file_format,
1510
+ :edi_type)
1511
+ SENSITIVE = []
1512
+ include Aws::Structure
1513
+ end
1514
+
1515
+ # @!attribute [rw] parsed_file_content
1516
+ # Returns the contents of the input file being tested, parsed
1517
+ # according to the specified EDI (electronic data interchange) type.
1518
+ # @return [String]
1519
+ #
1520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TestParsingResponse AWS API Documentation
1521
+ #
1522
+ class TestParsingResponse < Struct.new(
1523
+ :parsed_file_content)
1524
+ SENSITIVE = []
1525
+ include Aws::Structure
1526
+ end
1527
+
1528
+ # The request was denied due to throttling: the data speed and rendering
1529
+ # may be limited depending on various parameters and conditions.
1530
+ #
1531
+ # @!attribute [rw] message
1532
+ # @return [String]
1533
+ #
1534
+ # @!attribute [rw] retry_after_seconds
1535
+ # The server attempts to retry a command that was throttled.
1536
+ # @return [Integer]
1537
+ #
1538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ThrottlingException AWS API Documentation
1539
+ #
1540
+ class ThrottlingException < Struct.new(
1541
+ :message,
1542
+ :retry_after_seconds)
1543
+ SENSITIVE = []
1544
+ include Aws::Structure
1545
+ end
1546
+
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.
1550
+ #
1551
+ # @!attribute [rw] transformer_id
1552
+ # Returns the system-assigned unique identifier for the transformer.
1553
+ # @return [String]
1554
+ #
1555
+ # @!attribute [rw] name
1556
+ # Returns the descriptive name for the transformer.
1557
+ # @return [String]
1558
+ #
1559
+ # @!attribute [rw] file_format
1560
+ # Returns that the currently supported file formats for EDI
1561
+ # transformations are `JSON` and `XML`.
1562
+ # @return [String]
1563
+ #
1564
+ # @!attribute [rw] mapping_template
1565
+ # Returns the name of the mapping template for the transformer. This
1566
+ # template is used to convert the input document into the correct set
1567
+ # of objects.
1568
+ # @return [String]
1569
+ #
1570
+ # @!attribute [rw] status
1571
+ # Returns the state of the newly created transformer. The transformer
1572
+ # can be either `active` or `inactive`. For the transformer to be used
1573
+ # in a capability, its status must `active`.
1574
+ # @return [String]
1575
+ #
1576
+ # @!attribute [rw] edi_type
1577
+ # Returns the details for the EDI standard that is being used for the
1578
+ # transformer. Currently, only X12 is supported. X12 is a set of
1579
+ # standards and corresponding messages that define specific business
1580
+ # documents.
1581
+ # @return [Types::EdiType]
1582
+ #
1583
+ # @!attribute [rw] sample_document
1584
+ # Returns a sample EDI document that is used by a transformer as a
1585
+ # guide for processing the EDI data.
1586
+ # @return [String]
1587
+ #
1588
+ # @!attribute [rw] created_at
1589
+ # Returns a timestamp indicating when the transformer was created. For
1590
+ # example, `2023-07-20T19:58:44.624Z`.
1591
+ # @return [Time]
1592
+ #
1593
+ # @!attribute [rw] modified_at
1594
+ # Returns a timestamp representing the date and time for the most
1595
+ # recent change for the transformer object.
1596
+ # @return [Time]
1597
+ #
1598
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/TransformerSummary AWS API Documentation
1599
+ #
1600
+ class TransformerSummary < Struct.new(
1601
+ :transformer_id,
1602
+ :name,
1603
+ :file_format,
1604
+ :mapping_template,
1605
+ :status,
1606
+ :edi_type,
1607
+ :sample_document,
1608
+ :created_at,
1609
+ :modified_at)
1610
+ SENSITIVE = []
1611
+ include Aws::Structure
1612
+ end
1613
+
1614
+ # @!attribute [rw] resource_arn
1615
+ # Specifies an Amazon Resource Name (ARN) for a specific Amazon Web
1616
+ # Services resource, such as a capability, partnership, profile, or
1617
+ # transformer.
1618
+ # @return [String]
1619
+ #
1620
+ # @!attribute [rw] tag_keys
1621
+ # Specifies the key-value pairs assigned to ARNs that you can use to
1622
+ # group and search for resources by type. You can attach this metadata
1623
+ # to resources (capabilities, partnerships, and so on) for any
1624
+ # purpose.
1625
+ # @return [Array<String>]
1626
+ #
1627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UntagResourceRequest AWS API Documentation
1628
+ #
1629
+ class UntagResourceRequest < Struct.new(
1630
+ :resource_arn,
1631
+ :tag_keys)
1632
+ SENSITIVE = []
1633
+ include Aws::Structure
1634
+ end
1635
+
1636
+ # @!attribute [rw] capability_id
1637
+ # Specifies a system-assigned unique identifier for the capability.
1638
+ # @return [String]
1639
+ #
1640
+ # @!attribute [rw] name
1641
+ # Specifies a new name for the capability, to replace the existing
1642
+ # name.
1643
+ # @return [String]
1644
+ #
1645
+ # @!attribute [rw] configuration
1646
+ # Specifies a structure that contains the details for a capability.
1647
+ # @return [Types::CapabilityConfiguration]
1648
+ #
1649
+ # @!attribute [rw] instructions_documents
1650
+ # Specifies one or more locations in Amazon S3, each specifying an EDI
1651
+ # document that can be used with this capability. Each item contains
1652
+ # the name of the bucket and the key, to identify the document's
1653
+ # location.
1654
+ # @return [Array<Types::S3Location>]
1655
+ #
1656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdateCapabilityRequest AWS API Documentation
1657
+ #
1658
+ class UpdateCapabilityRequest < Struct.new(
1659
+ :capability_id,
1660
+ :name,
1661
+ :configuration,
1662
+ :instructions_documents)
1663
+ SENSITIVE = []
1664
+ include Aws::Structure
1665
+ end
1666
+
1667
+ # @!attribute [rw] capability_id
1668
+ # Returns a system-assigned unique identifier for the capability.
1669
+ # @return [String]
1670
+ #
1671
+ # @!attribute [rw] capability_arn
1672
+ # Returns an Amazon Resource Name (ARN) for a specific Amazon Web
1673
+ # Services resource, such as a capability, partnership, profile, or
1674
+ # transformer.
1675
+ # @return [String]
1676
+ #
1677
+ # @!attribute [rw] name
1678
+ # Returns the name of the capability, used to identify it.
1679
+ # @return [String]
1680
+ #
1681
+ # @!attribute [rw] type
1682
+ # Returns the type of the capability. Currently, only `edi` is
1683
+ # supported.
1684
+ # @return [String]
1685
+ #
1686
+ # @!attribute [rw] configuration
1687
+ # Returns a structure that contains the details for a capability.
1688
+ # @return [Types::CapabilityConfiguration]
1689
+ #
1690
+ # @!attribute [rw] instructions_documents
1691
+ # Returns one or more locations in Amazon S3, each specifying an EDI
1692
+ # document that can be used with this capability. Each item contains
1693
+ # the name of the bucket and the key, to identify the document's
1694
+ # location.
1695
+ # @return [Array<Types::S3Location>]
1696
+ #
1697
+ # @!attribute [rw] created_at
1698
+ # Returns a timestamp for creation date and time of the capability.
1699
+ # @return [Time]
1700
+ #
1701
+ # @!attribute [rw] modified_at
1702
+ # Returns a timestamp for last time the capability was modified.
1703
+ # @return [Time]
1704
+ #
1705
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdateCapabilityResponse AWS API Documentation
1706
+ #
1707
+ class UpdateCapabilityResponse < Struct.new(
1708
+ :capability_id,
1709
+ :capability_arn,
1710
+ :name,
1711
+ :type,
1712
+ :configuration,
1713
+ :instructions_documents,
1714
+ :created_at,
1715
+ :modified_at)
1716
+ SENSITIVE = []
1717
+ include Aws::Structure
1718
+ end
1719
+
1720
+ # @!attribute [rw] partnership_id
1721
+ # Specifies the unique, system-generated identifier for a partnership.
1722
+ # @return [String]
1723
+ #
1724
+ # @!attribute [rw] name
1725
+ # The name of the partnership, used to identify it.
1726
+ # @return [String]
1727
+ #
1728
+ # @!attribute [rw] capabilities
1729
+ # List of the capabilities associated with this partnership.
1730
+ # @return [Array<String>]
1731
+ #
1732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdatePartnershipRequest AWS API Documentation
1733
+ #
1734
+ class UpdatePartnershipRequest < Struct.new(
1735
+ :partnership_id,
1736
+ :name,
1737
+ :capabilities)
1738
+ SENSITIVE = []
1739
+ include Aws::Structure
1740
+ end
1741
+
1742
+ # @!attribute [rw] profile_id
1743
+ # Returns the unique, system-generated identifier for the profile
1744
+ # connected to this partnership.
1745
+ # @return [String]
1746
+ #
1747
+ # @!attribute [rw] partnership_id
1748
+ # Returns the unique, system-generated identifier for a partnership.
1749
+ # @return [String]
1750
+ #
1751
+ # @!attribute [rw] partnership_arn
1752
+ # Returns an Amazon Resource Name (ARN) for a specific Amazon Web
1753
+ # Services resource, such as a capability, partnership, profile, or
1754
+ # transformer.
1755
+ # @return [String]
1756
+ #
1757
+ # @!attribute [rw] name
1758
+ # The name of the partnership, used to identify it.
1759
+ # @return [String]
1760
+ #
1761
+ # @!attribute [rw] email
1762
+ # Returns the email address associated with this trading partner.
1763
+ # @return [String]
1764
+ #
1765
+ # @!attribute [rw] phone
1766
+ # Returns the phone number associated with the partnership.
1767
+ # @return [String]
1768
+ #
1769
+ # @!attribute [rw] capabilities
1770
+ # Returns one or more capabilities associated with this partnership.
1771
+ # @return [Array<String>]
1772
+ #
1773
+ # @!attribute [rw] trading_partner_id
1774
+ # Returns the unique, system-generated identifier for a trading
1775
+ # partner.
1776
+ # @return [String]
1777
+ #
1778
+ # @!attribute [rw] created_at
1779
+ # Returns a timestamp that identifies the most recent date and time
1780
+ # that the partnership was modified.
1781
+ # @return [Time]
1782
+ #
1783
+ # @!attribute [rw] modified_at
1784
+ # Returns a timestamp that identifies the most recent date and time
1785
+ # that the partnership was modified.
1786
+ # @return [Time]
1787
+ #
1788
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdatePartnershipResponse AWS API Documentation
1789
+ #
1790
+ class UpdatePartnershipResponse < Struct.new(
1791
+ :profile_id,
1792
+ :partnership_id,
1793
+ :partnership_arn,
1794
+ :name,
1795
+ :email,
1796
+ :phone,
1797
+ :capabilities,
1798
+ :trading_partner_id,
1799
+ :created_at,
1800
+ :modified_at)
1801
+ SENSITIVE = [:email, :phone]
1802
+ include Aws::Structure
1803
+ end
1804
+
1805
+ # @!attribute [rw] profile_id
1806
+ # Specifies the unique, system-generated identifier for the profile.
1807
+ # @return [String]
1808
+ #
1809
+ # @!attribute [rw] name
1810
+ # The name of the profile, used to identify it.
1811
+ # @return [String]
1812
+ #
1813
+ # @!attribute [rw] email
1814
+ # Specifies the email address associated with this customer profile.
1815
+ # @return [String]
1816
+ #
1817
+ # @!attribute [rw] phone
1818
+ # Specifies the phone number associated with the profile.
1819
+ # @return [String]
1820
+ #
1821
+ # @!attribute [rw] business_name
1822
+ # Specifies the name for the business associated with this profile.
1823
+ # @return [String]
1824
+ #
1825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdateProfileRequest AWS API Documentation
1826
+ #
1827
+ class UpdateProfileRequest < Struct.new(
1828
+ :profile_id,
1829
+ :name,
1830
+ :email,
1831
+ :phone,
1832
+ :business_name)
1833
+ SENSITIVE = [:email, :phone]
1834
+ include Aws::Structure
1835
+ end
1836
+
1837
+ # @!attribute [rw] profile_id
1838
+ # Returns the unique, system-generated identifier for the profile.
1839
+ # @return [String]
1840
+ #
1841
+ # @!attribute [rw] profile_arn
1842
+ # Returns an Amazon Resource Name (ARN) for the profile.
1843
+ # @return [String]
1844
+ #
1845
+ # @!attribute [rw] name
1846
+ # Returns the name of the profile.
1847
+ # @return [String]
1848
+ #
1849
+ # @!attribute [rw] email
1850
+ # Returns the email address associated with this customer profile.
1851
+ # @return [String]
1852
+ #
1853
+ # @!attribute [rw] phone
1854
+ # Returns the phone number associated with the profile.
1855
+ # @return [String]
1856
+ #
1857
+ # @!attribute [rw] business_name
1858
+ # Returns the name for the business associated with this profile.
1859
+ # @return [String]
1860
+ #
1861
+ # @!attribute [rw] logging
1862
+ # Specifies whether or not logging is enabled for this profile.
1863
+ # @return [String]
1864
+ #
1865
+ # @!attribute [rw] log_group_name
1866
+ # Returns the name of the logging group.
1867
+ # @return [String]
1868
+ #
1869
+ # @!attribute [rw] created_at
1870
+ # Returns a timestamp for creation date and time of the profile.
1871
+ # @return [Time]
1872
+ #
1873
+ # @!attribute [rw] modified_at
1874
+ # Returns a timestamp for last time the profile was modified.
1875
+ # @return [Time]
1876
+ #
1877
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdateProfileResponse AWS API Documentation
1878
+ #
1879
+ class UpdateProfileResponse < Struct.new(
1880
+ :profile_id,
1881
+ :profile_arn,
1882
+ :name,
1883
+ :email,
1884
+ :phone,
1885
+ :business_name,
1886
+ :logging,
1887
+ :log_group_name,
1888
+ :created_at,
1889
+ :modified_at)
1890
+ SENSITIVE = [:email, :phone]
1891
+ include Aws::Structure
1892
+ end
1893
+
1894
+ # @!attribute [rw] transformer_id
1895
+ # Specifies the system-assigned unique identifier for the transformer.
1896
+ # @return [String]
1897
+ #
1898
+ # @!attribute [rw] name
1899
+ # Specify a new name for the transformer, if you want to update it.
1900
+ # @return [String]
1901
+ #
1902
+ # @!attribute [rw] file_format
1903
+ # Specifies that the currently supported file formats for EDI
1904
+ # transformations are `JSON` and `XML`.
1905
+ # @return [String]
1906
+ #
1907
+ # @!attribute [rw] mapping_template
1908
+ # Specifies the name of the mapping template for the transformer. This
1909
+ # template is used to convert the input document into the correct set
1910
+ # of objects.
1911
+ # @return [String]
1912
+ #
1913
+ # @!attribute [rw] status
1914
+ # Specifies the transformer's status. You can update the state of the
1915
+ # transformer, from `active` to `inactive`, or `inactive` to `active`.
1916
+ # @return [String]
1917
+ #
1918
+ # @!attribute [rw] edi_type
1919
+ # Specifies the details for the EDI standard that is being used for
1920
+ # the transformer. Currently, only X12 is supported. X12 is a set of
1921
+ # standards and corresponding messages that define specific business
1922
+ # documents.
1923
+ # @return [Types::EdiType]
1924
+ #
1925
+ # @!attribute [rw] sample_document
1926
+ # Specifies a sample EDI document that is used by a transformer as a
1927
+ # guide for processing the EDI data.
1928
+ # @return [String]
1929
+ #
1930
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdateTransformerRequest AWS API Documentation
1931
+ #
1932
+ class UpdateTransformerRequest < Struct.new(
1933
+ :transformer_id,
1934
+ :name,
1935
+ :file_format,
1936
+ :mapping_template,
1937
+ :status,
1938
+ :edi_type,
1939
+ :sample_document)
1940
+ SENSITIVE = []
1941
+ include Aws::Structure
1942
+ end
1943
+
1944
+ # @!attribute [rw] transformer_id
1945
+ # Returns the system-assigned unique identifier for the transformer.
1946
+ # @return [String]
1947
+ #
1948
+ # @!attribute [rw] transformer_arn
1949
+ # Returns an Amazon Resource Name (ARN) for a specific Amazon Web
1950
+ # Services resource, such as a capability, partnership, profile, or
1951
+ # transformer.
1952
+ # @return [String]
1953
+ #
1954
+ # @!attribute [rw] name
1955
+ # Returns the name of the transformer.
1956
+ # @return [String]
1957
+ #
1958
+ # @!attribute [rw] file_format
1959
+ # Returns that the currently supported file formats for EDI
1960
+ # transformations are `JSON` and `XML`.
1961
+ # @return [String]
1962
+ #
1963
+ # @!attribute [rw] mapping_template
1964
+ # Returns the name of the mapping template for the transformer. This
1965
+ # template is used to convert the input document into the correct set
1966
+ # of objects.
1967
+ # @return [String]
1968
+ #
1969
+ # @!attribute [rw] status
1970
+ # Returns the state of the newly created transformer. The transformer
1971
+ # can be either `active` or `inactive`. For the transformer to be used
1972
+ # in a capability, its status must `active`.
1973
+ # @return [String]
1974
+ #
1975
+ # @!attribute [rw] edi_type
1976
+ # Returns the details for the EDI standard that is being used for the
1977
+ # transformer. Currently, only X12 is supported. X12 is a set of
1978
+ # standards and corresponding messages that define specific business
1979
+ # documents.
1980
+ # @return [Types::EdiType]
1981
+ #
1982
+ # @!attribute [rw] sample_document
1983
+ # Returns a sample EDI document that is used by a transformer as a
1984
+ # guide for processing the EDI data.
1985
+ # @return [String]
1986
+ #
1987
+ # @!attribute [rw] created_at
1988
+ # Returns a timestamp for creation date and time of the transformer.
1989
+ # @return [Time]
1990
+ #
1991
+ # @!attribute [rw] modified_at
1992
+ # Returns a timestamp for last time the transformer was modified.
1993
+ # @return [Time]
1994
+ #
1995
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/UpdateTransformerResponse AWS API Documentation
1996
+ #
1997
+ class UpdateTransformerResponse < Struct.new(
1998
+ :transformer_id,
1999
+ :transformer_arn,
2000
+ :name,
2001
+ :file_format,
2002
+ :mapping_template,
2003
+ :status,
2004
+ :edi_type,
2005
+ :sample_document,
2006
+ :created_at,
2007
+ :modified_at)
2008
+ SENSITIVE = []
2009
+ include Aws::Structure
2010
+ end
2011
+
2012
+ # Occurs when a B2BI object cannot be validated against a request from
2013
+ # another object.
2014
+ #
2015
+ # @!attribute [rw] message
2016
+ # @return [String]
2017
+ #
2018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ValidationException AWS API Documentation
2019
+ #
2020
+ class ValidationException < Struct.new(
2021
+ :message)
2022
+ SENSITIVE = []
2023
+ include Aws::Structure
2024
+ end
2025
+
2026
+ # A structure that contains the X12 transaction set and version. The X12
2027
+ # structure is used when the system transforms an EDI (electronic data
2028
+ # interchange) file.
2029
+ #
2030
+ # @!attribute [rw] transaction_set
2031
+ # Returns an enumerated type where each value identifies an X12
2032
+ # transaction set. Transaction sets are maintained by the X12
2033
+ # Accredited Standards Committee.
2034
+ # @return [String]
2035
+ #
2036
+ # @!attribute [rw] version
2037
+ # Returns the version to use for the specified X12 transaction set.
2038
+ # Supported versions are `4010`, `4030`, and `5010`.
2039
+ # @return [String]
2040
+ #
2041
+ # @see http://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/X12Details AWS API Documentation
2042
+ #
2043
+ class X12Details < Struct.new(
2044
+ :transaction_set,
2045
+ :version)
2046
+ SENSITIVE = []
2047
+ include Aws::Structure
2048
+ end
2049
+
2050
+ end
2051
+ end