aws-sdk-supplychain 1.15.0 → 1.16.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.
@@ -83,7 +83,15 @@ module Aws::SupplyChain
83
83
  # @return [String]
84
84
  #
85
85
  # @!attribute [rw] client_token
86
- # An idempotency token.
86
+ # An idempotency token ensures the API request is only completed no
87
+ # more than once. This way, retrying the request will not trigger the
88
+ # operation multiple times. A client token is a unique, case-sensitive
89
+ # string of 33 to 128 ASCII characters. To make an idempotent API
90
+ # request, specify a client token in the request. You should not reuse
91
+ # the same client token for other requests. If you retry a successful
92
+ # request with the same client token, the request will succeed with no
93
+ # further actions being taken, and you will receive the same API
94
+ # response as the original successful request.
87
95
  #
88
96
  # **A suitable default value is auto-generated.** You should normally
89
97
  # not need to pass this option.
@@ -113,6 +121,591 @@ module Aws::SupplyChain
113
121
  include Aws::Structure
114
122
  end
115
123
 
124
+ # The request parameters for CreateDataIntegrationFlow.
125
+ #
126
+ # @!attribute [rw] instance_id
127
+ # The Amazon Web Services Supply Chain instance identifier.
128
+ # @return [String]
129
+ #
130
+ # @!attribute [rw] name
131
+ # Name of the DataIntegrationFlow.
132
+ # @return [String]
133
+ #
134
+ # @!attribute [rw] sources
135
+ # The source configurations for DataIntegrationFlow.
136
+ # @return [Array<Types::DataIntegrationFlowSource>]
137
+ #
138
+ # @!attribute [rw] transformation
139
+ # The transformation configurations for DataIntegrationFlow.
140
+ # @return [Types::DataIntegrationFlowTransformation]
141
+ #
142
+ # @!attribute [rw] target
143
+ # The target configurations for DataIntegrationFlow.
144
+ # @return [Types::DataIntegrationFlowTarget]
145
+ #
146
+ # @!attribute [rw] tags
147
+ # The tags of the DataIntegrationFlow to be created
148
+ # @return [Hash<String,String>]
149
+ #
150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateDataIntegrationFlowRequest AWS API Documentation
151
+ #
152
+ class CreateDataIntegrationFlowRequest < Struct.new(
153
+ :instance_id,
154
+ :name,
155
+ :sources,
156
+ :transformation,
157
+ :target,
158
+ :tags)
159
+ SENSITIVE = []
160
+ include Aws::Structure
161
+ end
162
+
163
+ # The response parameters for CreateDataIntegrationFlow.
164
+ #
165
+ # @!attribute [rw] instance_id
166
+ # The Amazon Web Services Supply Chain instance identifier.
167
+ # @return [String]
168
+ #
169
+ # @!attribute [rw] name
170
+ # The name of the DataIntegrationFlow created.
171
+ # @return [String]
172
+ #
173
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateDataIntegrationFlowResponse AWS API Documentation
174
+ #
175
+ class CreateDataIntegrationFlowResponse < Struct.new(
176
+ :instance_id,
177
+ :name)
178
+ SENSITIVE = []
179
+ include Aws::Structure
180
+ end
181
+
182
+ # The request parameters for CreateDataLakeDataset.
183
+ #
184
+ # @!attribute [rw] instance_id
185
+ # The Amazon Web Services Supply Chain instance identifier.
186
+ # @return [String]
187
+ #
188
+ # @!attribute [rw] namespace
189
+ # The name space of the dataset.
190
+ #
191
+ # * **asc** - For information on the Amazon Web Services Supply Chain
192
+ # supported datasets see
193
+ # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
194
+ #
195
+ # * **default** - For datasets with custom user-defined schemas.
196
+ #
197
+ #
198
+ #
199
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
200
+ # @return [String]
201
+ #
202
+ # @!attribute [rw] name
203
+ # The name of the dataset. For **asc** name space, the name must be
204
+ # one of the supported data entities under
205
+ # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
206
+ #
207
+ #
208
+ #
209
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
210
+ # @return [String]
211
+ #
212
+ # @!attribute [rw] schema
213
+ # The custom schema of the data lake dataset and is only required when
214
+ # the name space is *default*.
215
+ # @return [Types::DataLakeDatasetSchema]
216
+ #
217
+ # @!attribute [rw] description
218
+ # The description of the dataset.
219
+ # @return [String]
220
+ #
221
+ # @!attribute [rw] tags
222
+ # The tags of the dataset.
223
+ # @return [Hash<String,String>]
224
+ #
225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateDataLakeDatasetRequest AWS API Documentation
226
+ #
227
+ class CreateDataLakeDatasetRequest < Struct.new(
228
+ :instance_id,
229
+ :namespace,
230
+ :name,
231
+ :schema,
232
+ :description,
233
+ :tags)
234
+ SENSITIVE = []
235
+ include Aws::Structure
236
+ end
237
+
238
+ # The response parameters of CreateDataLakeDataset.
239
+ #
240
+ # @!attribute [rw] dataset
241
+ # The detail of created dataset.
242
+ # @return [Types::DataLakeDataset]
243
+ #
244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateDataLakeDatasetResponse AWS API Documentation
245
+ #
246
+ class CreateDataLakeDatasetResponse < Struct.new(
247
+ :dataset)
248
+ SENSITIVE = []
249
+ include Aws::Structure
250
+ end
251
+
252
+ # The DataIntegrationFlow details.
253
+ #
254
+ # @!attribute [rw] instance_id
255
+ # The DataIntegrationFlow instance ID.
256
+ # @return [String]
257
+ #
258
+ # @!attribute [rw] name
259
+ # The DataIntegrationFlow name.
260
+ # @return [String]
261
+ #
262
+ # @!attribute [rw] sources
263
+ # The DataIntegrationFlow source configurations.
264
+ # @return [Array<Types::DataIntegrationFlowSource>]
265
+ #
266
+ # @!attribute [rw] transformation
267
+ # The DataIntegrationFlow transformation configurations.
268
+ # @return [Types::DataIntegrationFlowTransformation]
269
+ #
270
+ # @!attribute [rw] target
271
+ # The DataIntegrationFlow target configuration.
272
+ # @return [Types::DataIntegrationFlowTarget]
273
+ #
274
+ # @!attribute [rw] created_time
275
+ # The DataIntegrationFlow creation timestamp.
276
+ # @return [Time]
277
+ #
278
+ # @!attribute [rw] last_modified_time
279
+ # The DataIntegrationFlow last modified timestamp.
280
+ # @return [Time]
281
+ #
282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlow AWS API Documentation
283
+ #
284
+ class DataIntegrationFlow < Struct.new(
285
+ :instance_id,
286
+ :name,
287
+ :sources,
288
+ :transformation,
289
+ :target,
290
+ :created_time,
291
+ :last_modified_time)
292
+ SENSITIVE = []
293
+ include Aws::Structure
294
+ end
295
+
296
+ # The dataset options used in dataset source and target configurations.
297
+ #
298
+ # @!attribute [rw] load_type
299
+ # The dataset data load type in dataset options.
300
+ # @return [String]
301
+ #
302
+ # @!attribute [rw] dedupe_records
303
+ # The dataset load option to remove duplicates.
304
+ # @return [Boolean]
305
+ #
306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowDatasetOptions AWS API Documentation
307
+ #
308
+ class DataIntegrationFlowDatasetOptions < Struct.new(
309
+ :load_type,
310
+ :dedupe_records)
311
+ SENSITIVE = []
312
+ include Aws::Structure
313
+ end
314
+
315
+ # The dataset DataIntegrationFlow source configuration parameters.
316
+ #
317
+ # @!attribute [rw] dataset_identifier
318
+ # The ARN of the dataset.
319
+ # @return [String]
320
+ #
321
+ # @!attribute [rw] options
322
+ # The dataset DataIntegrationFlow source options.
323
+ # @return [Types::DataIntegrationFlowDatasetOptions]
324
+ #
325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowDatasetSourceConfiguration AWS API Documentation
326
+ #
327
+ class DataIntegrationFlowDatasetSourceConfiguration < Struct.new(
328
+ :dataset_identifier,
329
+ :options)
330
+ SENSITIVE = []
331
+ include Aws::Structure
332
+ end
333
+
334
+ # The dataset DataIntegrationFlow target configuration parameters.
335
+ #
336
+ # @!attribute [rw] dataset_identifier
337
+ # The dataset ARN.
338
+ # @return [String]
339
+ #
340
+ # @!attribute [rw] options
341
+ # The dataset DataIntegrationFlow target options.
342
+ # @return [Types::DataIntegrationFlowDatasetOptions]
343
+ #
344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowDatasetTargetConfiguration AWS API Documentation
345
+ #
346
+ class DataIntegrationFlowDatasetTargetConfiguration < Struct.new(
347
+ :dataset_identifier,
348
+ :options)
349
+ SENSITIVE = []
350
+ include Aws::Structure
351
+ end
352
+
353
+ # The Amazon S3 options used in S3 source and target configurations.
354
+ #
355
+ # @!attribute [rw] file_type
356
+ # The Amazon S3 file type in S3 options.
357
+ # @return [String]
358
+ #
359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowS3Options AWS API Documentation
360
+ #
361
+ class DataIntegrationFlowS3Options < Struct.new(
362
+ :file_type)
363
+ SENSITIVE = []
364
+ include Aws::Structure
365
+ end
366
+
367
+ # The S3 DataIntegrationFlow source configuration parameters.
368
+ #
369
+ # @!attribute [rw] bucket_name
370
+ # The bucketName of the S3 source objects.
371
+ # @return [String]
372
+ #
373
+ # @!attribute [rw] prefix
374
+ # The prefix of the S3 source objects.
375
+ # @return [String]
376
+ #
377
+ # @!attribute [rw] options
378
+ # The other options of the S3 DataIntegrationFlow source.
379
+ # @return [Types::DataIntegrationFlowS3Options]
380
+ #
381
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowS3SourceConfiguration AWS API Documentation
382
+ #
383
+ class DataIntegrationFlowS3SourceConfiguration < Struct.new(
384
+ :bucket_name,
385
+ :prefix,
386
+ :options)
387
+ SENSITIVE = []
388
+ include Aws::Structure
389
+ end
390
+
391
+ # The S3 DataIntegrationFlow target configuration parameters.
392
+ #
393
+ # @!attribute [rw] bucket_name
394
+ # The bucketName of the S3 target objects.
395
+ # @return [String]
396
+ #
397
+ # @!attribute [rw] prefix
398
+ # The prefix of the S3 target objects.
399
+ # @return [String]
400
+ #
401
+ # @!attribute [rw] options
402
+ # The S3 DataIntegrationFlow target options.
403
+ # @return [Types::DataIntegrationFlowS3Options]
404
+ #
405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowS3TargetConfiguration AWS API Documentation
406
+ #
407
+ class DataIntegrationFlowS3TargetConfiguration < Struct.new(
408
+ :bucket_name,
409
+ :prefix,
410
+ :options)
411
+ SENSITIVE = []
412
+ include Aws::Structure
413
+ end
414
+
415
+ # The SQL DataIntegrationFlow transformation configuration parameters.
416
+ #
417
+ # @!attribute [rw] query
418
+ # The transformation SQL query body based on SparkSQL.
419
+ # @return [String]
420
+ #
421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowSQLTransformationConfiguration AWS API Documentation
422
+ #
423
+ class DataIntegrationFlowSQLTransformationConfiguration < Struct.new(
424
+ :query)
425
+ SENSITIVE = []
426
+ include Aws::Structure
427
+ end
428
+
429
+ # The DataIntegrationFlow source parameters.
430
+ #
431
+ # @!attribute [rw] source_type
432
+ # The DataIntegrationFlow source type.
433
+ # @return [String]
434
+ #
435
+ # @!attribute [rw] source_name
436
+ # The DataIntegrationFlow source name that can be used as table alias
437
+ # in SQL transformation query.
438
+ # @return [String]
439
+ #
440
+ # @!attribute [rw] s3_source
441
+ # The S3 DataIntegrationFlow source.
442
+ # @return [Types::DataIntegrationFlowS3SourceConfiguration]
443
+ #
444
+ # @!attribute [rw] dataset_source
445
+ # The dataset DataIntegrationFlow source.
446
+ # @return [Types::DataIntegrationFlowDatasetSourceConfiguration]
447
+ #
448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowSource AWS API Documentation
449
+ #
450
+ class DataIntegrationFlowSource < Struct.new(
451
+ :source_type,
452
+ :source_name,
453
+ :s3_source,
454
+ :dataset_source)
455
+ SENSITIVE = []
456
+ include Aws::Structure
457
+ end
458
+
459
+ # The DataIntegrationFlow target parameters.
460
+ #
461
+ # @!attribute [rw] target_type
462
+ # The DataIntegrationFlow target type.
463
+ # @return [String]
464
+ #
465
+ # @!attribute [rw] s3_target
466
+ # The S3 DataIntegrationFlow target.
467
+ # @return [Types::DataIntegrationFlowS3TargetConfiguration]
468
+ #
469
+ # @!attribute [rw] dataset_target
470
+ # The dataset DataIntegrationFlow target.
471
+ # @return [Types::DataIntegrationFlowDatasetTargetConfiguration]
472
+ #
473
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowTarget AWS API Documentation
474
+ #
475
+ class DataIntegrationFlowTarget < Struct.new(
476
+ :target_type,
477
+ :s3_target,
478
+ :dataset_target)
479
+ SENSITIVE = []
480
+ include Aws::Structure
481
+ end
482
+
483
+ # The DataIntegrationFlow transformation parameters.
484
+ #
485
+ # @!attribute [rw] transformation_type
486
+ # The DataIntegrationFlow transformation type.
487
+ # @return [String]
488
+ #
489
+ # @!attribute [rw] sql_transformation
490
+ # The SQL DataIntegrationFlow transformation configuration.
491
+ # @return [Types::DataIntegrationFlowSQLTransformationConfiguration]
492
+ #
493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowTransformation AWS API Documentation
494
+ #
495
+ class DataIntegrationFlowTransformation < Struct.new(
496
+ :transformation_type,
497
+ :sql_transformation)
498
+ SENSITIVE = []
499
+ include Aws::Structure
500
+ end
501
+
502
+ # The data lake dataset details.
503
+ #
504
+ # @!attribute [rw] instance_id
505
+ # The Amazon Web Services Supply Chain instance identifier.
506
+ # @return [String]
507
+ #
508
+ # @!attribute [rw] namespace
509
+ # The name space of the dataset. The available values are:
510
+ #
511
+ # * **asc** - For information on the Amazon Web Services Supply Chain
512
+ # supported datasets see
513
+ # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
514
+ #
515
+ # * **default** - For datasets with custom user-defined schemas.
516
+ #
517
+ #
518
+ #
519
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
520
+ # @return [String]
521
+ #
522
+ # @!attribute [rw] name
523
+ # The name of the dataset. For **asc** name space, the name must be
524
+ # one of the supported data entities under
525
+ # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
526
+ #
527
+ #
528
+ #
529
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
530
+ # @return [String]
531
+ #
532
+ # @!attribute [rw] arn
533
+ # The arn of the dataset.
534
+ # @return [String]
535
+ #
536
+ # @!attribute [rw] schema
537
+ # The schema of the dataset.
538
+ # @return [Types::DataLakeDatasetSchema]
539
+ #
540
+ # @!attribute [rw] description
541
+ # The description of the dataset.
542
+ # @return [String]
543
+ #
544
+ # @!attribute [rw] created_time
545
+ # The creation time of the dataset.
546
+ # @return [Time]
547
+ #
548
+ # @!attribute [rw] last_modified_time
549
+ # The last modified time of the dataset.
550
+ # @return [Time]
551
+ #
552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataLakeDataset AWS API Documentation
553
+ #
554
+ class DataLakeDataset < Struct.new(
555
+ :instance_id,
556
+ :namespace,
557
+ :name,
558
+ :arn,
559
+ :schema,
560
+ :description,
561
+ :created_time,
562
+ :last_modified_time)
563
+ SENSITIVE = []
564
+ include Aws::Structure
565
+ end
566
+
567
+ # The schema details of the dataset.
568
+ #
569
+ # @!attribute [rw] name
570
+ # The name of the dataset schema.
571
+ # @return [String]
572
+ #
573
+ # @!attribute [rw] fields
574
+ # The list of field details of the dataset schema.
575
+ # @return [Array<Types::DataLakeDatasetSchemaField>]
576
+ #
577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataLakeDatasetSchema AWS API Documentation
578
+ #
579
+ class DataLakeDatasetSchema < Struct.new(
580
+ :name,
581
+ :fields)
582
+ SENSITIVE = []
583
+ include Aws::Structure
584
+ end
585
+
586
+ # The dataset field details.
587
+ #
588
+ # @!attribute [rw] name
589
+ # The dataset field name.
590
+ # @return [String]
591
+ #
592
+ # @!attribute [rw] type
593
+ # The dataset field type.
594
+ # @return [String]
595
+ #
596
+ # @!attribute [rw] is_required
597
+ # Indicate if the field is required or not.
598
+ # @return [Boolean]
599
+ #
600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataLakeDatasetSchemaField AWS API Documentation
601
+ #
602
+ class DataLakeDatasetSchemaField < Struct.new(
603
+ :name,
604
+ :type,
605
+ :is_required)
606
+ SENSITIVE = []
607
+ include Aws::Structure
608
+ end
609
+
610
+ # The request parameters for DeleteDataIntegrationFlow.
611
+ #
612
+ # @!attribute [rw] instance_id
613
+ # The Amazon Web Services Supply Chain instance identifier.
614
+ # @return [String]
615
+ #
616
+ # @!attribute [rw] name
617
+ # The name of the DataIntegrationFlow to be deleted.
618
+ # @return [String]
619
+ #
620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataIntegrationFlowRequest AWS API Documentation
621
+ #
622
+ class DeleteDataIntegrationFlowRequest < Struct.new(
623
+ :instance_id,
624
+ :name)
625
+ SENSITIVE = []
626
+ include Aws::Structure
627
+ end
628
+
629
+ # The response parameters for DeleteDataIntegrationFlow.
630
+ #
631
+ # @!attribute [rw] instance_id
632
+ # The Amazon Web Services Supply Chain instance identifier.
633
+ # @return [String]
634
+ #
635
+ # @!attribute [rw] name
636
+ # The name of the DataIntegrationFlow deleted.
637
+ # @return [String]
638
+ #
639
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataIntegrationFlowResponse AWS API Documentation
640
+ #
641
+ class DeleteDataIntegrationFlowResponse < Struct.new(
642
+ :instance_id,
643
+ :name)
644
+ SENSITIVE = []
645
+ include Aws::Structure
646
+ end
647
+
648
+ # The request parameters of DeleteDataLakeDataset.
649
+ #
650
+ # @!attribute [rw] instance_id
651
+ # The AWS Supply Chain instance identifier.
652
+ # @return [String]
653
+ #
654
+ # @!attribute [rw] namespace
655
+ # The namespace of the dataset. The available values are:
656
+ #
657
+ # * asc: for [ AWS Supply Chain supported datasets ][1].
658
+ #
659
+ # * default: for datasets with custom user-defined schemas.
660
+ #
661
+ #
662
+ #
663
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
664
+ # @return [String]
665
+ #
666
+ # @!attribute [rw] name
667
+ # The name of the dataset. If the namespace is *asc*, the name must be
668
+ # one of the supported [data entities ][1].
669
+ #
670
+ #
671
+ #
672
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
673
+ # @return [String]
674
+ #
675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataLakeDatasetRequest AWS API Documentation
676
+ #
677
+ class DeleteDataLakeDatasetRequest < Struct.new(
678
+ :instance_id,
679
+ :namespace,
680
+ :name)
681
+ SENSITIVE = []
682
+ include Aws::Structure
683
+ end
684
+
685
+ # The response parameters of DeleteDataLakeDataset.
686
+ #
687
+ # @!attribute [rw] instance_id
688
+ # The AWS Supply Chain instance identifier.
689
+ # @return [String]
690
+ #
691
+ # @!attribute [rw] namespace
692
+ # The namespace of deleted dataset.
693
+ # @return [String]
694
+ #
695
+ # @!attribute [rw] name
696
+ # The name of deleted dataset.
697
+ # @return [String]
698
+ #
699
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataLakeDatasetResponse AWS API Documentation
700
+ #
701
+ class DeleteDataLakeDatasetResponse < Struct.new(
702
+ :instance_id,
703
+ :namespace,
704
+ :name)
705
+ SENSITIVE = []
706
+ include Aws::Structure
707
+ end
708
+
116
709
  # The request parameters for GetBillOfMaterialsImportJob.
117
710
  #
118
711
  # @!attribute [rw] instance_id
@@ -146,6 +739,93 @@ module Aws::SupplyChain
146
739
  include Aws::Structure
147
740
  end
148
741
 
742
+ # The request parameters for GetDataIntegrationFlow.
743
+ #
744
+ # @!attribute [rw] instance_id
745
+ # The Amazon Web Services Supply Chain instance identifier.
746
+ # @return [String]
747
+ #
748
+ # @!attribute [rw] name
749
+ # The name of the DataIntegrationFlow created.
750
+ # @return [String]
751
+ #
752
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataIntegrationFlowRequest AWS API Documentation
753
+ #
754
+ class GetDataIntegrationFlowRequest < Struct.new(
755
+ :instance_id,
756
+ :name)
757
+ SENSITIVE = []
758
+ include Aws::Structure
759
+ end
760
+
761
+ # The response parameters for GetDataIntegrationFlow.
762
+ #
763
+ # @!attribute [rw] flow
764
+ # The details of the DataIntegrationFlow returned.
765
+ # @return [Types::DataIntegrationFlow]
766
+ #
767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataIntegrationFlowResponse AWS API Documentation
768
+ #
769
+ class GetDataIntegrationFlowResponse < Struct.new(
770
+ :flow)
771
+ SENSITIVE = []
772
+ include Aws::Structure
773
+ end
774
+
775
+ # The request parameters for GetDataLakeDataset.
776
+ #
777
+ # @!attribute [rw] instance_id
778
+ # The Amazon Web Services Supply Chain instance identifier.
779
+ # @return [String]
780
+ #
781
+ # @!attribute [rw] namespace
782
+ # The name space of the dataset. The available values are:
783
+ #
784
+ # * **asc** - For information on the Amazon Web Services Supply Chain
785
+ # supported datasets see
786
+ # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
787
+ #
788
+ # * **default** - For datasets with custom user-defined schemas.
789
+ #
790
+ #
791
+ #
792
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
793
+ # @return [String]
794
+ #
795
+ # @!attribute [rw] name
796
+ # The name of the dataset. For **asc** name space, the name must be
797
+ # one of the supported data entities under
798
+ # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
799
+ #
800
+ #
801
+ #
802
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
803
+ # @return [String]
804
+ #
805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataLakeDatasetRequest AWS API Documentation
806
+ #
807
+ class GetDataLakeDatasetRequest < Struct.new(
808
+ :instance_id,
809
+ :namespace,
810
+ :name)
811
+ SENSITIVE = []
812
+ include Aws::Structure
813
+ end
814
+
815
+ # The response parameters for UpdateDataLakeDataset.
816
+ #
817
+ # @!attribute [rw] dataset
818
+ # The fetched dataset details.
819
+ # @return [Types::DataLakeDataset]
820
+ #
821
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataLakeDatasetResponse AWS API Documentation
822
+ #
823
+ class GetDataLakeDatasetResponse < Struct.new(
824
+ :dataset)
825
+ SENSITIVE = []
826
+ include Aws::Structure
827
+ end
828
+
149
829
  # Unexpected error during processing of request.
150
830
  #
151
831
  # @!attribute [rw] message
@@ -159,6 +839,137 @@ module Aws::SupplyChain
159
839
  include Aws::Structure
160
840
  end
161
841
 
842
+ # The request parameters for ListDataIntegrationFlows.
843
+ #
844
+ # @!attribute [rw] instance_id
845
+ # The Amazon Web Services Supply Chain instance identifier.
846
+ # @return [String]
847
+ #
848
+ # @!attribute [rw] next_token
849
+ # The pagination token to fetch the next page of the
850
+ # DataIntegrationFlows.
851
+ # @return [String]
852
+ #
853
+ # @!attribute [rw] max_results
854
+ # Specify the maximum number of DataIntegrationFlows to fetch in one
855
+ # paginated request.
856
+ # @return [Integer]
857
+ #
858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataIntegrationFlowsRequest AWS API Documentation
859
+ #
860
+ class ListDataIntegrationFlowsRequest < Struct.new(
861
+ :instance_id,
862
+ :next_token,
863
+ :max_results)
864
+ SENSITIVE = []
865
+ include Aws::Structure
866
+ end
867
+
868
+ # The response parameters for ListDataIntegrationFlows.
869
+ #
870
+ # @!attribute [rw] flows
871
+ # The response parameters for ListDataIntegrationFlows.
872
+ # @return [Array<Types::DataIntegrationFlow>]
873
+ #
874
+ # @!attribute [rw] next_token
875
+ # The pagination token to fetch the next page of the
876
+ # DataIntegrationFlows.
877
+ # @return [String]
878
+ #
879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataIntegrationFlowsResponse AWS API Documentation
880
+ #
881
+ class ListDataIntegrationFlowsResponse < Struct.new(
882
+ :flows,
883
+ :next_token)
884
+ SENSITIVE = []
885
+ include Aws::Structure
886
+ end
887
+
888
+ # The request parameters of ListDataLakeDatasets.
889
+ #
890
+ # @!attribute [rw] instance_id
891
+ # The Amazon Web Services Supply Chain instance identifier.
892
+ # @return [String]
893
+ #
894
+ # @!attribute [rw] namespace
895
+ # The namespace of the dataset. The available values are:
896
+ #
897
+ # * asc: for [ AWS Supply Chain supported datasets ][1].
898
+ #
899
+ # * default: for datasets with custom user-defined schemas.
900
+ #
901
+ #
902
+ #
903
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
904
+ # @return [String]
905
+ #
906
+ # @!attribute [rw] next_token
907
+ # The pagination token to fetch next page of datasets.
908
+ # @return [String]
909
+ #
910
+ # @!attribute [rw] max_results
911
+ # The max number of datasets to fetch in this paginated request.
912
+ # @return [Integer]
913
+ #
914
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataLakeDatasetsRequest AWS API Documentation
915
+ #
916
+ class ListDataLakeDatasetsRequest < Struct.new(
917
+ :instance_id,
918
+ :namespace,
919
+ :next_token,
920
+ :max_results)
921
+ SENSITIVE = []
922
+ include Aws::Structure
923
+ end
924
+
925
+ # The response parameters of ListDataLakeDatasets.
926
+ #
927
+ # @!attribute [rw] datasets
928
+ # The list of fetched dataset details.
929
+ # @return [Array<Types::DataLakeDataset>]
930
+ #
931
+ # @!attribute [rw] next_token
932
+ # The pagination token to fetch next page of datasets.
933
+ # @return [String]
934
+ #
935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataLakeDatasetsResponse AWS API Documentation
936
+ #
937
+ class ListDataLakeDatasetsResponse < Struct.new(
938
+ :datasets,
939
+ :next_token)
940
+ SENSITIVE = []
941
+ include Aws::Structure
942
+ end
943
+
944
+ # The request parameters of ListTagsForResource.
945
+ #
946
+ # @!attribute [rw] resource_arn
947
+ # The Amazon Web Services Supply chain resource ARN that needs tags to
948
+ # be listed.
949
+ # @return [String]
950
+ #
951
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListTagsForResourceRequest AWS API Documentation
952
+ #
953
+ class ListTagsForResourceRequest < Struct.new(
954
+ :resource_arn)
955
+ SENSITIVE = []
956
+ include Aws::Structure
957
+ end
958
+
959
+ # The response parameters of ListTagsForResource.
960
+ #
961
+ # @!attribute [rw] tags
962
+ # The tags added to an Amazon Web Services Supply Chain resource.
963
+ # @return [Hash<String,String>]
964
+ #
965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListTagsForResourceResponse AWS API Documentation
966
+ #
967
+ class ListTagsForResourceResponse < Struct.new(
968
+ :tags)
969
+ SENSITIVE = []
970
+ include Aws::Structure
971
+ end
972
+
162
973
  # Request references a resource which does not exist.
163
974
  #
164
975
  # @!attribute [rw] message
@@ -248,6 +1059,33 @@ module Aws::SupplyChain
248
1059
  include Aws::Structure
249
1060
  end
250
1061
 
1062
+ # The request parameters of TagResource.
1063
+ #
1064
+ # @!attribute [rw] resource_arn
1065
+ # The Amazon Web Services Supply chain resource ARN that needs to be
1066
+ # tagged.
1067
+ # @return [String]
1068
+ #
1069
+ # @!attribute [rw] tags
1070
+ # The tags of the Amazon Web Services Supply chain resource to be
1071
+ # created.
1072
+ # @return [Hash<String,String>]
1073
+ #
1074
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/TagResourceRequest AWS API Documentation
1075
+ #
1076
+ class TagResourceRequest < Struct.new(
1077
+ :resource_arn,
1078
+ :tags)
1079
+ SENSITIVE = []
1080
+ include Aws::Structure
1081
+ end
1082
+
1083
+ # The response parameters for TagResource.
1084
+ #
1085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/TagResourceResponse AWS API Documentation
1086
+ #
1087
+ class TagResourceResponse < Aws::EmptyStructure; end
1088
+
251
1089
  # Request was denied due to request throttling.
252
1090
  #
253
1091
  # @!attribute [rw] message
@@ -261,6 +1099,140 @@ module Aws::SupplyChain
261
1099
  include Aws::Structure
262
1100
  end
263
1101
 
1102
+ # The request parameters of UntagResource.
1103
+ #
1104
+ # @!attribute [rw] resource_arn
1105
+ # The Amazon Web Services Supply chain resource ARN that needs to be
1106
+ # untagged.
1107
+ # @return [String]
1108
+ #
1109
+ # @!attribute [rw] tag_keys
1110
+ # The list of tag keys to be deleted for an Amazon Web Services Supply
1111
+ # Chain resource.
1112
+ # @return [Array<String>]
1113
+ #
1114
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UntagResourceRequest AWS API Documentation
1115
+ #
1116
+ class UntagResourceRequest < Struct.new(
1117
+ :resource_arn,
1118
+ :tag_keys)
1119
+ SENSITIVE = []
1120
+ include Aws::Structure
1121
+ end
1122
+
1123
+ # The response parameters of UntagResource.
1124
+ #
1125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UntagResourceResponse AWS API Documentation
1126
+ #
1127
+ class UntagResourceResponse < Aws::EmptyStructure; end
1128
+
1129
+ # The request parameters for UpdateDataIntegrationFlow.
1130
+ #
1131
+ # @!attribute [rw] instance_id
1132
+ # The Amazon Web Services Supply Chain instance identifier.
1133
+ # @return [String]
1134
+ #
1135
+ # @!attribute [rw] name
1136
+ # The name of the DataIntegrationFlow to be updated.
1137
+ # @return [String]
1138
+ #
1139
+ # @!attribute [rw] sources
1140
+ # The new source configurations for the DataIntegrationFlow.
1141
+ # @return [Array<Types::DataIntegrationFlowSource>]
1142
+ #
1143
+ # @!attribute [rw] transformation
1144
+ # The new transformation configurations for the DataIntegrationFlow.
1145
+ # @return [Types::DataIntegrationFlowTransformation]
1146
+ #
1147
+ # @!attribute [rw] target
1148
+ # The new target configurations for the DataIntegrationFlow.
1149
+ # @return [Types::DataIntegrationFlowTarget]
1150
+ #
1151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UpdateDataIntegrationFlowRequest AWS API Documentation
1152
+ #
1153
+ class UpdateDataIntegrationFlowRequest < Struct.new(
1154
+ :instance_id,
1155
+ :name,
1156
+ :sources,
1157
+ :transformation,
1158
+ :target)
1159
+ SENSITIVE = []
1160
+ include Aws::Structure
1161
+ end
1162
+
1163
+ # The response parameters for UpdateDataIntegrationFlow.
1164
+ #
1165
+ # @!attribute [rw] flow
1166
+ # The details of the updated DataIntegrationFlow.
1167
+ # @return [Types::DataIntegrationFlow]
1168
+ #
1169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UpdateDataIntegrationFlowResponse AWS API Documentation
1170
+ #
1171
+ class UpdateDataIntegrationFlowResponse < Struct.new(
1172
+ :flow)
1173
+ SENSITIVE = []
1174
+ include Aws::Structure
1175
+ end
1176
+
1177
+ # The request parameters of UpdateDataLakeDataset.
1178
+ #
1179
+ # @!attribute [rw] instance_id
1180
+ # The Amazon Web Services Chain instance identifier.
1181
+ # @return [String]
1182
+ #
1183
+ # @!attribute [rw] namespace
1184
+ # The name space of the dataset. The available values are:
1185
+ #
1186
+ # * **asc** - For information on the Amazon Web Services Supply Chain
1187
+ # supported datasets see
1188
+ # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
1189
+ #
1190
+ # * **default** - For datasets with custom user-defined schemas.
1191
+ #
1192
+ #
1193
+ #
1194
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
1195
+ # @return [String]
1196
+ #
1197
+ # @!attribute [rw] name
1198
+ # The name of the dataset. For **asc** name space, the name must be
1199
+ # one of the supported data entities under
1200
+ # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
1201
+ #
1202
+ #
1203
+ #
1204
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
1205
+ # @return [String]
1206
+ #
1207
+ # @!attribute [rw] description
1208
+ # The updated description of the data lake dataset.
1209
+ # @return [String]
1210
+ #
1211
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UpdateDataLakeDatasetRequest AWS API Documentation
1212
+ #
1213
+ class UpdateDataLakeDatasetRequest < Struct.new(
1214
+ :instance_id,
1215
+ :namespace,
1216
+ :name,
1217
+ :description)
1218
+ SENSITIVE = []
1219
+ include Aws::Structure
1220
+ end
1221
+
1222
+ # The response parameters of UpdateDataLakeDataset.
1223
+ #
1224
+ # @!attribute [rw] dataset
1225
+ # The updated dataset details.
1226
+ # @return [Types::DataLakeDataset]
1227
+ #
1228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UpdateDataLakeDatasetResponse AWS API Documentation
1229
+ #
1230
+ class UpdateDataLakeDatasetResponse < Struct.new(
1231
+ :dataset)
1232
+ SENSITIVE = []
1233
+ include Aws::Structure
1234
+ end
1235
+
264
1236
  # The input does not satisfy the constraints specified by an AWS
265
1237
  # service.
266
1238
  #