aws-sdk-supplychain 1.23.0 → 1.25.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.
@@ -186,7 +186,8 @@ module Aws::SupplyChain
186
186
  # @return [String]
187
187
  #
188
188
  # @!attribute [rw] namespace
189
- # The name space of the dataset.
189
+ # The namespace of the dataset, besides the custom defined namespace,
190
+ # every instance comes with below pre-defined namespaces:
190
191
  #
191
192
  # * **asc** - For information on the Amazon Web Services Supply Chain
192
193
  # supported datasets see
@@ -210,14 +211,24 @@ module Aws::SupplyChain
210
211
  # @return [String]
211
212
  #
212
213
  # @!attribute [rw] schema
213
- # The custom schema of the data lake dataset and is only required when
214
- # the name space is **default**.
214
+ # The custom schema of the data lake dataset and required for dataset
215
+ # in **default** and custom namespaces.
215
216
  # @return [Types::DataLakeDatasetSchema]
216
217
  #
217
218
  # @!attribute [rw] description
218
219
  # The description of the dataset.
219
220
  # @return [String]
220
221
  #
222
+ # @!attribute [rw] partition_spec
223
+ # The partition specification of the dataset. Partitioning can
224
+ # effectively improve the dataset query performance by reducing the
225
+ # amount of data scanned during query execution. But partitioning or
226
+ # not will affect how data get ingested by data ingestion methods,
227
+ # such as SendDataIntegrationEvent's dataset UPSERT will upsert
228
+ # records within partition (instead of within whole dataset). For more
229
+ # details, refer to those data ingestion documentations.
230
+ # @return [Types::DataLakeDatasetPartitionSpec]
231
+ #
221
232
  # @!attribute [rw] tags
222
233
  # The tags of the dataset.
223
234
  # @return [Hash<String,String>]
@@ -230,6 +241,7 @@ module Aws::SupplyChain
230
241
  :name,
231
242
  :schema,
232
243
  :description,
244
+ :partition_spec,
233
245
  :tags)
234
246
  SENSITIVE = []
235
247
  include Aws::Structure
@@ -249,6 +261,51 @@ module Aws::SupplyChain
249
261
  include Aws::Structure
250
262
  end
251
263
 
264
+ # The request parameters for CreateDataLakeNamespace.
265
+ #
266
+ # @!attribute [rw] instance_id
267
+ # The Amazon Web Services Supply Chain instance identifier.
268
+ # @return [String]
269
+ #
270
+ # @!attribute [rw] name
271
+ # The name of the namespace. Noted you cannot create namespace with
272
+ # name starting with **asc**, **default**, **scn**, **aws**,
273
+ # **amazon**, **amzn**
274
+ # @return [String]
275
+ #
276
+ # @!attribute [rw] description
277
+ # The description of the namespace.
278
+ # @return [String]
279
+ #
280
+ # @!attribute [rw] tags
281
+ # The tags of the namespace.
282
+ # @return [Hash<String,String>]
283
+ #
284
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateDataLakeNamespaceRequest AWS API Documentation
285
+ #
286
+ class CreateDataLakeNamespaceRequest < Struct.new(
287
+ :instance_id,
288
+ :name,
289
+ :description,
290
+ :tags)
291
+ SENSITIVE = []
292
+ include Aws::Structure
293
+ end
294
+
295
+ # The response parameters of CreateDataLakeNamespace.
296
+ #
297
+ # @!attribute [rw] namespace
298
+ # The detail of created namespace.
299
+ # @return [Types::DataLakeNamespace]
300
+ #
301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateDataLakeNamespaceResponse AWS API Documentation
302
+ #
303
+ class CreateDataLakeNamespaceResponse < Struct.new(
304
+ :namespace)
305
+ SENSITIVE = []
306
+ include Aws::Structure
307
+ end
308
+
252
309
  # The request parameters for CreateInstance.
253
310
  #
254
311
  # @!attribute [rw] instance_name
@@ -312,6 +369,131 @@ module Aws::SupplyChain
312
369
  include Aws::Structure
313
370
  end
314
371
 
372
+ # The data integration event details.
373
+ #
374
+ # @!attribute [rw] instance_id
375
+ # The AWS Supply Chain instance identifier.
376
+ # @return [String]
377
+ #
378
+ # @!attribute [rw] event_id
379
+ # The unique event identifier.
380
+ # @return [String]
381
+ #
382
+ # @!attribute [rw] event_type
383
+ # The data event type.
384
+ # @return [String]
385
+ #
386
+ # @!attribute [rw] event_group_id
387
+ # Event identifier (for example, orderId for InboundOrder) used for
388
+ # data sharding or partitioning.
389
+ # @return [String]
390
+ #
391
+ # @!attribute [rw] event_timestamp
392
+ # The event timestamp (in epoch seconds).
393
+ # @return [Time]
394
+ #
395
+ # @!attribute [rw] dataset_target_details
396
+ # The target dataset details for a DATASET event type.
397
+ # @return [Types::DataIntegrationEventDatasetTargetDetails]
398
+ #
399
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationEvent AWS API Documentation
400
+ #
401
+ class DataIntegrationEvent < Struct.new(
402
+ :instance_id,
403
+ :event_id,
404
+ :event_type,
405
+ :event_group_id,
406
+ :event_timestamp,
407
+ :dataset_target_details)
408
+ SENSITIVE = []
409
+ include Aws::Structure
410
+ end
411
+
412
+ # The target dataset load execution details.
413
+ #
414
+ # @!attribute [rw] status
415
+ # The event load execution status to target dataset.
416
+ # @return [String]
417
+ #
418
+ # @!attribute [rw] message
419
+ # The failure message (if any) of failed event load execution to
420
+ # dataset.
421
+ # @return [String]
422
+ #
423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationEventDatasetLoadExecutionDetails AWS API Documentation
424
+ #
425
+ class DataIntegrationEventDatasetLoadExecutionDetails < Struct.new(
426
+ :status,
427
+ :message)
428
+ SENSITIVE = []
429
+ include Aws::Structure
430
+ end
431
+
432
+ # The target dataset configuration for a DATASET event type.
433
+ #
434
+ # @!attribute [rw] dataset_identifier
435
+ # The datalake dataset ARN identifier.
436
+ # @return [String]
437
+ #
438
+ # @!attribute [rw] operation_type
439
+ # The target dataset load operation type.
440
+ # @return [String]
441
+ #
442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationEventDatasetTargetConfiguration AWS API Documentation
443
+ #
444
+ class DataIntegrationEventDatasetTargetConfiguration < Struct.new(
445
+ :dataset_identifier,
446
+ :operation_type)
447
+ SENSITIVE = []
448
+ include Aws::Structure
449
+ end
450
+
451
+ # The target dataset details for a DATASET event type.
452
+ #
453
+ # @!attribute [rw] dataset_identifier
454
+ # The datalake dataset ARN identifier.
455
+ # @return [String]
456
+ #
457
+ # @!attribute [rw] operation_type
458
+ # The target dataset load operation type. The available options are:
459
+ #
460
+ # * **APPEND** - Add new records to the dataset. Noted that this
461
+ # operation type will just try to append records as-is without any
462
+ # primary key or partition constraints.
463
+ #
464
+ # * **UPSERT** - Modify existing records in the dataset with primary
465
+ # key configured, events for datasets without primary keys are not
466
+ # allowed. If event data contains primary keys that match records in
467
+ # the dataset within same partition, then those existing records (in
468
+ # that partition) will be updated. If primary keys do not match, new
469
+ # records will be added. Note that if dataset contain records with
470
+ # duplicate primary key values in the same partition, those
471
+ # duplicate records will be deduped into one updated record.
472
+ #
473
+ # * **DELETE** - Remove existing records in the dataset with primary
474
+ # key configured, events for datasets without primary keys are not
475
+ # allowed. If event data contains primary keys that match records in
476
+ # the dataset within same partition, then those existing records (in
477
+ # that partition) will be deleted. If primary keys do not match, no
478
+ # actions will be done. Note that if dataset contain records with
479
+ # duplicate primary key values in the same partition, all those
480
+ # duplicates will be removed.
481
+ # @return [String]
482
+ #
483
+ # @!attribute [rw] dataset_load_execution
484
+ # The target dataset load execution.
485
+ # @return [Types::DataIntegrationEventDatasetLoadExecutionDetails]
486
+ #
487
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationEventDatasetTargetDetails AWS API Documentation
488
+ #
489
+ class DataIntegrationEventDatasetTargetDetails < Struct.new(
490
+ :dataset_identifier,
491
+ :operation_type,
492
+ :dataset_load_execution)
493
+ SENSITIVE = []
494
+ include Aws::Structure
495
+ end
496
+
315
497
  # The DataIntegrationFlow details.
316
498
  #
317
499
  # @!attribute [rw] instance_id
@@ -359,18 +541,61 @@ module Aws::SupplyChain
359
541
  # The dataset options used in dataset source and target configurations.
360
542
  #
361
543
  # @!attribute [rw] load_type
362
- # The dataset data load type in dataset options.
544
+ # The target dataset's data load type. This only affects how source
545
+ # S3 files are selected in the S3-to-dataset flow.
546
+ #
547
+ # * **REPLACE** - Target dataset will get replaced with the new file
548
+ # added under the source s3 prefix.
549
+ #
550
+ # * **INCREMENTAL** - Target dataset will get updated with the
551
+ # up-to-date content under S3 prefix incorporating any file
552
+ # additions or removals there.
363
553
  # @return [String]
364
554
  #
365
555
  # @!attribute [rw] dedupe_records
366
- # The dataset load option to remove duplicates.
556
+ # The option to perform deduplication on data records sharing same
557
+ # primary key values. If disabled, transformed data with duplicate
558
+ # primary key values will ingest into dataset, for datasets within
559
+ # **asc** namespace, such duplicates will cause ingestion fail. If
560
+ # enabled without dedupeStrategy, deduplication is done by retaining a
561
+ # random data record among those sharing the same primary key values.
562
+ # If enabled with dedupeStragtegy, the deduplication is done following
563
+ # the strategy.
564
+ #
565
+ # Note that target dataset may have partition configured, when dedupe
566
+ # is enabled, it only dedupe against primary keys and retain only one
567
+ # record out of those duplicates regardless of its partition status.
367
568
  # @return [Boolean]
368
569
  #
570
+ # @!attribute [rw] dedupe_strategy
571
+ # The deduplication strategy to dedupe the data records sharing same
572
+ # primary key values of the target dataset. This strategy only applies
573
+ # to target dataset with primary keys and with dedupeRecords option
574
+ # enabled. If transformed data still got duplicates after the
575
+ # dedupeStrategy evaluation, a random data record is chosen to be
576
+ # retained.
577
+ # @return [Types::DataIntegrationFlowDedupeStrategy]
578
+ #
369
579
  # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowDatasetOptions AWS API Documentation
370
580
  #
371
581
  class DataIntegrationFlowDatasetOptions < Struct.new(
372
582
  :load_type,
373
- :dedupe_records)
583
+ :dedupe_records,
584
+ :dedupe_strategy)
585
+ SENSITIVE = []
586
+ include Aws::Structure
587
+ end
588
+
589
+ # The details of a flow execution with dataset source.
590
+ #
591
+ # @!attribute [rw] dataset_identifier
592
+ # The ARN of the dataset source.
593
+ # @return [String]
594
+ #
595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowDatasetSource AWS API Documentation
596
+ #
597
+ class DataIntegrationFlowDatasetSource < Struct.new(
598
+ :dataset_identifier)
374
599
  SENSITIVE = []
375
600
  include Aws::Structure
376
601
  end
@@ -413,6 +638,162 @@ module Aws::SupplyChain
413
638
  include Aws::Structure
414
639
  end
415
640
 
641
+ # The deduplication strategy details.
642
+ #
643
+ # @!attribute [rw] type
644
+ # The type of the deduplication strategy.
645
+ #
646
+ # * **FIELD\_PRIORITY** - Field priority configuration for the
647
+ # deduplication strategy specifies an ordered list of fields used to
648
+ # tie-break the data records sharing the same primary key values.
649
+ # Fields earlier in the list have higher priority for evaluation.
650
+ # For each field, the sort order determines whether to retain data
651
+ # record with larger or smaller field value.
652
+ #
653
+ # ^
654
+ # @return [String]
655
+ #
656
+ # @!attribute [rw] field_priority
657
+ # The field priority deduplication strategy.
658
+ # @return [Types::DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration]
659
+ #
660
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowDedupeStrategy AWS API Documentation
661
+ #
662
+ class DataIntegrationFlowDedupeStrategy < Struct.new(
663
+ :type,
664
+ :field_priority)
665
+ SENSITIVE = []
666
+ include Aws::Structure
667
+ end
668
+
669
+ # The flow execution details.
670
+ #
671
+ # @!attribute [rw] instance_id
672
+ # The flow execution's instanceId.
673
+ # @return [String]
674
+ #
675
+ # @!attribute [rw] flow_name
676
+ # The flow execution's flowName.
677
+ # @return [String]
678
+ #
679
+ # @!attribute [rw] execution_id
680
+ # The flow executionId.
681
+ # @return [String]
682
+ #
683
+ # @!attribute [rw] status
684
+ # The status of flow execution.
685
+ # @return [String]
686
+ #
687
+ # @!attribute [rw] source_info
688
+ # The source information for a flow execution.
689
+ # @return [Types::DataIntegrationFlowExecutionSourceInfo]
690
+ #
691
+ # @!attribute [rw] message
692
+ # The failure message (if any) of failed flow execution.
693
+ # @return [String]
694
+ #
695
+ # @!attribute [rw] start_time
696
+ # The flow execution start timestamp.
697
+ # @return [Time]
698
+ #
699
+ # @!attribute [rw] end_time
700
+ # The flow execution end timestamp.
701
+ # @return [Time]
702
+ #
703
+ # @!attribute [rw] output_metadata
704
+ # The flow execution output metadata.
705
+ # @return [Types::DataIntegrationFlowExecutionOutputMetadata]
706
+ #
707
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowExecution AWS API Documentation
708
+ #
709
+ class DataIntegrationFlowExecution < Struct.new(
710
+ :instance_id,
711
+ :flow_name,
712
+ :execution_id,
713
+ :status,
714
+ :source_info,
715
+ :message,
716
+ :start_time,
717
+ :end_time,
718
+ :output_metadata)
719
+ SENSITIVE = []
720
+ include Aws::Structure
721
+ end
722
+
723
+ # The output metadata of the flow execution.
724
+ #
725
+ # @!attribute [rw] diagnostic_reports_root_s3uri
726
+ # The S3 URI under which all diagnostic files (such as deduped records
727
+ # if any) are stored.
728
+ # @return [String]
729
+ #
730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowExecutionOutputMetadata AWS API Documentation
731
+ #
732
+ class DataIntegrationFlowExecutionOutputMetadata < Struct.new(
733
+ :diagnostic_reports_root_s3uri)
734
+ SENSITIVE = []
735
+ include Aws::Structure
736
+ end
737
+
738
+ # The source information of a flow execution.
739
+ #
740
+ # @!attribute [rw] source_type
741
+ # The data integration flow execution source type.
742
+ # @return [String]
743
+ #
744
+ # @!attribute [rw] s3_source
745
+ # The source details of a flow execution with S3 source.
746
+ # @return [Types::DataIntegrationFlowS3Source]
747
+ #
748
+ # @!attribute [rw] dataset_source
749
+ # The source details of a flow execution with dataset source.
750
+ # @return [Types::DataIntegrationFlowDatasetSource]
751
+ #
752
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowExecutionSourceInfo AWS API Documentation
753
+ #
754
+ class DataIntegrationFlowExecutionSourceInfo < Struct.new(
755
+ :source_type,
756
+ :s3_source,
757
+ :dataset_source)
758
+ SENSITIVE = []
759
+ include Aws::Structure
760
+ end
761
+
762
+ # The field used in the field priority deduplication strategy.
763
+ #
764
+ # @!attribute [rw] name
765
+ # The name of the deduplication field. Must exist in the dataset and
766
+ # not be a primary key.
767
+ # @return [String]
768
+ #
769
+ # @!attribute [rw] sort_order
770
+ # The sort order for the deduplication field.
771
+ # @return [String]
772
+ #
773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowFieldPriorityDedupeField AWS API Documentation
774
+ #
775
+ class DataIntegrationFlowFieldPriorityDedupeField < Struct.new(
776
+ :name,
777
+ :sort_order)
778
+ SENSITIVE = []
779
+ include Aws::Structure
780
+ end
781
+
782
+ # The field priority deduplication strategy details.
783
+ #
784
+ # @!attribute [rw] fields
785
+ # The list of field names and their sort order for deduplication,
786
+ # arranged in descending priority from highest to lowest.
787
+ # @return [Array<Types::DataIntegrationFlowFieldPriorityDedupeField>]
788
+ #
789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration AWS API Documentation
790
+ #
791
+ class DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration < Struct.new(
792
+ :fields)
793
+ SENSITIVE = []
794
+ include Aws::Structure
795
+ end
796
+
416
797
  # The Amazon S3 options used in S3 source and target configurations.
417
798
  #
418
799
  # @!attribute [rw] file_type
@@ -427,6 +808,25 @@ module Aws::SupplyChain
427
808
  include Aws::Structure
428
809
  end
429
810
 
811
+ # The details of a flow execution with S3 source.
812
+ #
813
+ # @!attribute [rw] bucket_name
814
+ # The S3 bucket name of the S3 source.
815
+ # @return [String]
816
+ #
817
+ # @!attribute [rw] key
818
+ # The S3 object key of the S3 source.
819
+ # @return [String]
820
+ #
821
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowS3Source AWS API Documentation
822
+ #
823
+ class DataIntegrationFlowS3Source < Struct.new(
824
+ :bucket_name,
825
+ :key)
826
+ SENSITIVE = []
827
+ include Aws::Structure
828
+ end
829
+
430
830
  # The S3 DataIntegrationFlow source configuration parameters.
431
831
  #
432
832
  # @!attribute [rw] bucket_name
@@ -434,7 +834,8 @@ module Aws::SupplyChain
434
834
  # @return [String]
435
835
  #
436
836
  # @!attribute [rw] prefix
437
- # The prefix of the S3 source objects.
837
+ # The prefix of the S3 source objects. To trigger data ingestion, S3
838
+ # files need to be put under `s3://bucketName/prefix/`.
438
839
  # @return [String]
439
840
  #
440
841
  # @!attribute [rw] options
@@ -485,7 +886,7 @@ module Aws::SupplyChain
485
886
  #
486
887
  class DataIntegrationFlowSQLTransformationConfiguration < Struct.new(
487
888
  :query)
488
- SENSITIVE = []
889
+ SENSITIVE = [:query]
489
890
  include Aws::Structure
490
891
  end
491
892
 
@@ -530,7 +931,10 @@ module Aws::SupplyChain
530
931
  # @return [Types::DataIntegrationFlowS3TargetConfiguration]
531
932
  #
532
933
  # @!attribute [rw] dataset_target
533
- # The dataset DataIntegrationFlow target.
934
+ # The dataset DataIntegrationFlow target. Note that for AWS Supply
935
+ # Chain dataset under **asc** namespace, it has a connection\_id
936
+ # internal field that is not allowed to be provided by client
937
+ # directly, they will be auto populated.
534
938
  # @return [Types::DataIntegrationFlowDatasetTargetConfiguration]
535
939
  #
536
940
  # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataIntegrationFlowTarget AWS API Documentation
@@ -569,7 +973,8 @@ module Aws::SupplyChain
569
973
  # @return [String]
570
974
  #
571
975
  # @!attribute [rw] namespace
572
- # The name space of the dataset. The available values are:
976
+ # The namespace of the dataset, besides the custom defined namespace,
977
+ # every instance comes with below pre-defined namespaces:
573
978
  #
574
979
  # * **asc** - For information on the Amazon Web Services Supply Chain
575
980
  # supported datasets see
@@ -583,8 +988,8 @@ module Aws::SupplyChain
583
988
  # @return [String]
584
989
  #
585
990
  # @!attribute [rw] name
586
- # The name of the dataset. For **asc** name space, the name must be
587
- # one of the supported data entities under
991
+ # The name of the dataset. For **asc** namespace, the name must be one
992
+ # of the supported data entities under
588
993
  # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
589
994
  #
590
995
  #
@@ -604,6 +1009,10 @@ module Aws::SupplyChain
604
1009
  # The description of the dataset.
605
1010
  # @return [String]
606
1011
  #
1012
+ # @!attribute [rw] partition_spec
1013
+ # The partition specification for a dataset.
1014
+ # @return [Types::DataLakeDatasetPartitionSpec]
1015
+ #
607
1016
  # @!attribute [rw] created_time
608
1017
  # The creation time of the dataset.
609
1018
  # @return [Time]
@@ -621,13 +1030,99 @@ module Aws::SupplyChain
621
1030
  :arn,
622
1031
  :schema,
623
1032
  :description,
1033
+ :partition_spec,
624
1034
  :created_time,
625
1035
  :last_modified_time)
626
1036
  SENSITIVE = []
627
1037
  include Aws::Structure
628
1038
  end
629
1039
 
630
- # The schema details of the dataset.
1040
+ # The detail of the partition field.
1041
+ #
1042
+ # @!attribute [rw] name
1043
+ # The name of the partition field.
1044
+ # @return [String]
1045
+ #
1046
+ # @!attribute [rw] transform
1047
+ # The transformation of the partition field. A transformation
1048
+ # specifies how to partition on a given field. For example, with
1049
+ # timestamp you can specify that you'd like to partition fields by
1050
+ # day, e.g. data record with value 2025-01-03T00:00:00Z in partition
1051
+ # field is in 2025-01-03 partition. Also noted that data record
1052
+ # without any value in optional partition field is in NULL partition.
1053
+ # @return [Types::DataLakeDatasetPartitionFieldTransform]
1054
+ #
1055
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataLakeDatasetPartitionField AWS API Documentation
1056
+ #
1057
+ class DataLakeDatasetPartitionField < Struct.new(
1058
+ :name,
1059
+ :transform)
1060
+ SENSITIVE = []
1061
+ include Aws::Structure
1062
+ end
1063
+
1064
+ # The detail of the partition field transformation.
1065
+ #
1066
+ # @!attribute [rw] type
1067
+ # The type of partitioning transformation for this field. The
1068
+ # available options are:
1069
+ #
1070
+ # * **IDENTITY** - Partitions data on a given field by its exact
1071
+ # values.
1072
+ #
1073
+ # * **YEAR** - Partitions data on a timestamp field using year
1074
+ # granularity.
1075
+ #
1076
+ # * **MONTH** - Partitions data on a timestamp field using month
1077
+ # granularity.
1078
+ #
1079
+ # * **DAY** - Partitions data on a timestamp field using day
1080
+ # granularity.
1081
+ #
1082
+ # * **HOUR** - Partitions data on a timestamp field using hour
1083
+ # granularity.
1084
+ # @return [String]
1085
+ #
1086
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataLakeDatasetPartitionFieldTransform AWS API Documentation
1087
+ #
1088
+ class DataLakeDatasetPartitionFieldTransform < Struct.new(
1089
+ :type)
1090
+ SENSITIVE = []
1091
+ include Aws::Structure
1092
+ end
1093
+
1094
+ # The partition specification for a dataset.
1095
+ #
1096
+ # @!attribute [rw] fields
1097
+ # The fields on which to partition a dataset. The partitions will be
1098
+ # applied hierarchically based on the order of this list.
1099
+ # @return [Array<Types::DataLakeDatasetPartitionField>]
1100
+ #
1101
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataLakeDatasetPartitionSpec AWS API Documentation
1102
+ #
1103
+ class DataLakeDatasetPartitionSpec < Struct.new(
1104
+ :fields)
1105
+ SENSITIVE = []
1106
+ include Aws::Structure
1107
+ end
1108
+
1109
+ # The detail of the primary key field.
1110
+ #
1111
+ # @!attribute [rw] name
1112
+ # The name of the primary key field.
1113
+ # @return [String]
1114
+ #
1115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataLakeDatasetPrimaryKeyField AWS API Documentation
1116
+ #
1117
+ class DataLakeDatasetPrimaryKeyField < Struct.new(
1118
+ :name)
1119
+ SENSITIVE = []
1120
+ include Aws::Structure
1121
+ end
1122
+
1123
+ # The schema details of the dataset. Note that for AWS Supply Chain
1124
+ # dataset under **asc** namespace, it may have internal fields like
1125
+ # connection\_id that will be auto populated by data ingestion methods.
631
1126
  #
632
1127
  # @!attribute [rw] name
633
1128
  # The name of the dataset schema.
@@ -637,11 +1132,27 @@ module Aws::SupplyChain
637
1132
  # The list of field details of the dataset schema.
638
1133
  # @return [Array<Types::DataLakeDatasetSchemaField>]
639
1134
  #
1135
+ # @!attribute [rw] primary_keys
1136
+ # The list of primary key fields for the dataset. Primary keys defined
1137
+ # can help data ingestion methods to ensure data uniqueness:
1138
+ # CreateDataIntegrationFlow's dedupe strategy will leverage primary
1139
+ # keys to perform records deduplication before write to dataset;
1140
+ # SendDataIntegrationEvent's UPSERT and DELETE can only work with
1141
+ # dataset with primary keys. For more details, refer to those data
1142
+ # ingestion documentations.
1143
+ #
1144
+ # Note that defining primary keys does not necessarily mean the
1145
+ # dataset cannot have duplicate records, duplicate records can still
1146
+ # be ingested if CreateDataIntegrationFlow's dedupe disabled or
1147
+ # through SendDataIntegrationEvent's APPEND operation.
1148
+ # @return [Array<Types::DataLakeDatasetPrimaryKeyField>]
1149
+ #
640
1150
  # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataLakeDatasetSchema AWS API Documentation
641
1151
  #
642
1152
  class DataLakeDatasetSchema < Struct.new(
643
1153
  :name,
644
- :fields)
1154
+ :fields,
1155
+ :primary_keys)
645
1156
  SENSITIVE = []
646
1157
  include Aws::Structure
647
1158
  end
@@ -670,6 +1181,45 @@ module Aws::SupplyChain
670
1181
  include Aws::Structure
671
1182
  end
672
1183
 
1184
+ # The data lake namespace details.
1185
+ #
1186
+ # @!attribute [rw] instance_id
1187
+ # The Amazon Web Services Supply Chain instance identifier.
1188
+ # @return [String]
1189
+ #
1190
+ # @!attribute [rw] name
1191
+ # The name of the namespace.
1192
+ # @return [String]
1193
+ #
1194
+ # @!attribute [rw] arn
1195
+ # The arn of the namespace.
1196
+ # @return [String]
1197
+ #
1198
+ # @!attribute [rw] description
1199
+ # The description of the namespace.
1200
+ # @return [String]
1201
+ #
1202
+ # @!attribute [rw] created_time
1203
+ # The creation time of the namespace.
1204
+ # @return [Time]
1205
+ #
1206
+ # @!attribute [rw] last_modified_time
1207
+ # The last modified time of the namespace.
1208
+ # @return [Time]
1209
+ #
1210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DataLakeNamespace AWS API Documentation
1211
+ #
1212
+ class DataLakeNamespace < Struct.new(
1213
+ :instance_id,
1214
+ :name,
1215
+ :arn,
1216
+ :description,
1217
+ :created_time,
1218
+ :last_modified_time)
1219
+ SENSITIVE = []
1220
+ include Aws::Structure
1221
+ end
1222
+
673
1223
  # The request parameters for DeleteDataIntegrationFlow.
674
1224
  #
675
1225
  # @!attribute [rw] instance_id
@@ -715,7 +1265,8 @@ module Aws::SupplyChain
715
1265
  # @return [String]
716
1266
  #
717
1267
  # @!attribute [rw] namespace
718
- # The name space of the dataset. The available values are:
1268
+ # The namespace of the dataset, besides the custom defined namespace,
1269
+ # every instance comes with below pre-defined namespaces:
719
1270
  #
720
1271
  # * **asc** - For information on the Amazon Web Services Supply Chain
721
1272
  # supported datasets see
@@ -729,18 +1280,42 @@ module Aws::SupplyChain
729
1280
  # @return [String]
730
1281
  #
731
1282
  # @!attribute [rw] name
732
- # The name of the dataset. For **asc** name space, the name must be
733
- # one of the supported data entities under
1283
+ # The name of the dataset. For **asc** namespace, the name must be one
1284
+ # of the supported data entities under
734
1285
  # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
735
1286
  #
736
1287
  #
737
1288
  #
738
- # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
1289
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
1290
+ # @return [String]
1291
+ #
1292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataLakeDatasetRequest AWS API Documentation
1293
+ #
1294
+ class DeleteDataLakeDatasetRequest < Struct.new(
1295
+ :instance_id,
1296
+ :namespace,
1297
+ :name)
1298
+ SENSITIVE = []
1299
+ include Aws::Structure
1300
+ end
1301
+
1302
+ # The response parameters of DeleteDataLakeDataset.
1303
+ #
1304
+ # @!attribute [rw] instance_id
1305
+ # The AWS Supply Chain instance identifier.
1306
+ # @return [String]
1307
+ #
1308
+ # @!attribute [rw] namespace
1309
+ # The namespace of deleted dataset.
1310
+ # @return [String]
1311
+ #
1312
+ # @!attribute [rw] name
1313
+ # The name of deleted dataset.
739
1314
  # @return [String]
740
1315
  #
741
- # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataLakeDatasetRequest AWS API Documentation
1316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataLakeDatasetResponse AWS API Documentation
742
1317
  #
743
- class DeleteDataLakeDatasetRequest < Struct.new(
1318
+ class DeleteDataLakeDatasetResponse < Struct.new(
744
1319
  :instance_id,
745
1320
  :namespace,
746
1321
  :name)
@@ -748,25 +1323,41 @@ module Aws::SupplyChain
748
1323
  include Aws::Structure
749
1324
  end
750
1325
 
751
- # The response parameters of DeleteDataLakeDataset.
1326
+ # The request parameters of DeleteDataLakeNamespace.
752
1327
  #
753
1328
  # @!attribute [rw] instance_id
754
1329
  # The AWS Supply Chain instance identifier.
755
1330
  # @return [String]
756
1331
  #
757
- # @!attribute [rw] namespace
758
- # The name space of deleted dataset.
1332
+ # @!attribute [rw] name
1333
+ # The name of the namespace. Noted you cannot delete pre-defined
1334
+ # namespace like **asc**, **default** which are only deleted through
1335
+ # instance deletion.
1336
+ # @return [String]
1337
+ #
1338
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataLakeNamespaceRequest AWS API Documentation
1339
+ #
1340
+ class DeleteDataLakeNamespaceRequest < Struct.new(
1341
+ :instance_id,
1342
+ :name)
1343
+ SENSITIVE = []
1344
+ include Aws::Structure
1345
+ end
1346
+
1347
+ # The response parameters of DeleteDataLakeNamespace.
1348
+ #
1349
+ # @!attribute [rw] instance_id
1350
+ # The AWS Supply Chain instance identifier.
759
1351
  # @return [String]
760
1352
  #
761
1353
  # @!attribute [rw] name
762
- # The name of deleted dataset.
1354
+ # The name of deleted namespace.
763
1355
  # @return [String]
764
1356
  #
765
- # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataLakeDatasetResponse AWS API Documentation
1357
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/DeleteDataLakeNamespaceResponse AWS API Documentation
766
1358
  #
767
- class DeleteDataLakeDatasetResponse < Struct.new(
1359
+ class DeleteDataLakeNamespaceResponse < Struct.new(
768
1360
  :instance_id,
769
- :namespace,
770
1361
  :name)
771
1362
  SENSITIVE = []
772
1363
  include Aws::Structure
@@ -833,6 +1424,77 @@ module Aws::SupplyChain
833
1424
  include Aws::Structure
834
1425
  end
835
1426
 
1427
+ # The request parameters for GetDataIntegrationEvent.
1428
+ #
1429
+ # @!attribute [rw] instance_id
1430
+ # The Amazon Web Services Supply Chain instance identifier.
1431
+ # @return [String]
1432
+ #
1433
+ # @!attribute [rw] event_id
1434
+ # The unique event identifier.
1435
+ # @return [String]
1436
+ #
1437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataIntegrationEventRequest AWS API Documentation
1438
+ #
1439
+ class GetDataIntegrationEventRequest < Struct.new(
1440
+ :instance_id,
1441
+ :event_id)
1442
+ SENSITIVE = []
1443
+ include Aws::Structure
1444
+ end
1445
+
1446
+ # The response parameters for GetDataIntegrationEvent.
1447
+ #
1448
+ # @!attribute [rw] event
1449
+ # The details of the DataIntegrationEvent returned.
1450
+ # @return [Types::DataIntegrationEvent]
1451
+ #
1452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataIntegrationEventResponse AWS API Documentation
1453
+ #
1454
+ class GetDataIntegrationEventResponse < Struct.new(
1455
+ :event)
1456
+ SENSITIVE = []
1457
+ include Aws::Structure
1458
+ end
1459
+
1460
+ # The request parameters of GetFlowExecution.
1461
+ #
1462
+ # @!attribute [rw] instance_id
1463
+ # The AWS Supply Chain instance identifier.
1464
+ # @return [String]
1465
+ #
1466
+ # @!attribute [rw] flow_name
1467
+ # The flow name.
1468
+ # @return [String]
1469
+ #
1470
+ # @!attribute [rw] execution_id
1471
+ # The flow execution identifier.
1472
+ # @return [String]
1473
+ #
1474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataIntegrationFlowExecutionRequest AWS API Documentation
1475
+ #
1476
+ class GetDataIntegrationFlowExecutionRequest < Struct.new(
1477
+ :instance_id,
1478
+ :flow_name,
1479
+ :execution_id)
1480
+ SENSITIVE = []
1481
+ include Aws::Structure
1482
+ end
1483
+
1484
+ # The response parameters of GetFlowExecution.
1485
+ #
1486
+ # @!attribute [rw] flow_execution
1487
+ # The flow execution details.
1488
+ # @return [Types::DataIntegrationFlowExecution]
1489
+ #
1490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataIntegrationFlowExecutionResponse AWS API Documentation
1491
+ #
1492
+ class GetDataIntegrationFlowExecutionResponse < Struct.new(
1493
+ :flow_execution)
1494
+ SENSITIVE = []
1495
+ include Aws::Structure
1496
+ end
1497
+
836
1498
  # The request parameters for GetDataIntegrationFlow.
837
1499
  #
838
1500
  # @!attribute [rw] instance_id
@@ -873,7 +1535,8 @@ module Aws::SupplyChain
873
1535
  # @return [String]
874
1536
  #
875
1537
  # @!attribute [rw] namespace
876
- # The name space of the dataset. The available values are:
1538
+ # The namespace of the dataset, besides the custom defined namespace,
1539
+ # every instance comes with below pre-defined namespaces:
877
1540
  #
878
1541
  # * **asc** - For information on the Amazon Web Services Supply Chain
879
1542
  # supported datasets see
@@ -887,8 +1550,8 @@ module Aws::SupplyChain
887
1550
  # @return [String]
888
1551
  #
889
1552
  # @!attribute [rw] name
890
- # The name of the dataset. For **asc** name space, the name must be
891
- # one of the supported data entities under
1553
+ # The name of the dataset. For **asc** namespace, the name must be one
1554
+ # of the supported data entities under
892
1555
  # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
893
1556
  #
894
1557
  #
@@ -906,7 +1569,7 @@ module Aws::SupplyChain
906
1569
  include Aws::Structure
907
1570
  end
908
1571
 
909
- # The response parameters for UpdateDataLakeDataset.
1572
+ # The response parameters for GetDataLakeDataset.
910
1573
  #
911
1574
  # @!attribute [rw] dataset
912
1575
  # The fetched dataset details.
@@ -920,6 +1583,51 @@ module Aws::SupplyChain
920
1583
  include Aws::Structure
921
1584
  end
922
1585
 
1586
+ # The request parameters for GetDataLakeNamespace.
1587
+ #
1588
+ # @!attribute [rw] instance_id
1589
+ # The Amazon Web Services Supply Chain instance identifier.
1590
+ # @return [String]
1591
+ #
1592
+ # @!attribute [rw] name
1593
+ # The name of the namespace. Besides the namespaces user created, you
1594
+ # can also specify the pre-defined namespaces:
1595
+ #
1596
+ # * **asc** - Pre-defined namespace containing Amazon Web Services
1597
+ # Supply Chain supported datasets, see
1598
+ # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
1599
+ #
1600
+ # * **default** - Pre-defined namespace containing datasets with
1601
+ # custom user-defined schemas.
1602
+ #
1603
+ #
1604
+ #
1605
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
1606
+ # @return [String]
1607
+ #
1608
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataLakeNamespaceRequest AWS API Documentation
1609
+ #
1610
+ class GetDataLakeNamespaceRequest < Struct.new(
1611
+ :instance_id,
1612
+ :name)
1613
+ SENSITIVE = []
1614
+ include Aws::Structure
1615
+ end
1616
+
1617
+ # The response parameters for GetDataLakeNamespace.
1618
+ #
1619
+ # @!attribute [rw] namespace
1620
+ # The fetched namespace details.
1621
+ # @return [Types::DataLakeNamespace]
1622
+ #
1623
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetDataLakeNamespaceResponse AWS API Documentation
1624
+ #
1625
+ class GetDataLakeNamespaceResponse < Struct.new(
1626
+ :namespace)
1627
+ SENSITIVE = []
1628
+ include Aws::Structure
1629
+ end
1630
+
923
1631
  # The request parameters for GetInstance.
924
1632
  #
925
1633
  # @!attribute [rw] instance_id
@@ -1031,6 +1739,106 @@ module Aws::SupplyChain
1031
1739
  include Aws::Structure
1032
1740
  end
1033
1741
 
1742
+ # The request parameters for ListDataIntegrationEvents.
1743
+ #
1744
+ # @!attribute [rw] instance_id
1745
+ # The Amazon Web Services Supply Chain instance identifier.
1746
+ # @return [String]
1747
+ #
1748
+ # @!attribute [rw] event_type
1749
+ # List data integration events for the specified eventType.
1750
+ # @return [String]
1751
+ #
1752
+ # @!attribute [rw] next_token
1753
+ # The pagination token to fetch the next page of the data integration
1754
+ # events.
1755
+ # @return [String]
1756
+ #
1757
+ # @!attribute [rw] max_results
1758
+ # Specify the maximum number of data integration events to fetch in
1759
+ # one paginated request.
1760
+ # @return [Integer]
1761
+ #
1762
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataIntegrationEventsRequest AWS API Documentation
1763
+ #
1764
+ class ListDataIntegrationEventsRequest < Struct.new(
1765
+ :instance_id,
1766
+ :event_type,
1767
+ :next_token,
1768
+ :max_results)
1769
+ SENSITIVE = []
1770
+ include Aws::Structure
1771
+ end
1772
+
1773
+ # The response parameters for ListDataIntegrationEvents.
1774
+ #
1775
+ # @!attribute [rw] events
1776
+ # The list of data integration events.
1777
+ # @return [Array<Types::DataIntegrationEvent>]
1778
+ #
1779
+ # @!attribute [rw] next_token
1780
+ # The pagination token to fetch the next page of the
1781
+ # ListDataIntegrationEvents.
1782
+ # @return [String]
1783
+ #
1784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataIntegrationEventsResponse AWS API Documentation
1785
+ #
1786
+ class ListDataIntegrationEventsResponse < Struct.new(
1787
+ :events,
1788
+ :next_token)
1789
+ SENSITIVE = []
1790
+ include Aws::Structure
1791
+ end
1792
+
1793
+ # The request parameters of ListFlowExecutions.
1794
+ #
1795
+ # @!attribute [rw] instance_id
1796
+ # The AWS Supply Chain instance identifier.
1797
+ # @return [String]
1798
+ #
1799
+ # @!attribute [rw] flow_name
1800
+ # The flow name.
1801
+ # @return [String]
1802
+ #
1803
+ # @!attribute [rw] next_token
1804
+ # The pagination token to fetch next page of flow executions.
1805
+ # @return [String]
1806
+ #
1807
+ # @!attribute [rw] max_results
1808
+ # The number to specify the max number of flow executions to fetch in
1809
+ # this paginated request.
1810
+ # @return [Integer]
1811
+ #
1812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataIntegrationFlowExecutionsRequest AWS API Documentation
1813
+ #
1814
+ class ListDataIntegrationFlowExecutionsRequest < Struct.new(
1815
+ :instance_id,
1816
+ :flow_name,
1817
+ :next_token,
1818
+ :max_results)
1819
+ SENSITIVE = []
1820
+ include Aws::Structure
1821
+ end
1822
+
1823
+ # The response parameters of ListFlowExecutions.
1824
+ #
1825
+ # @!attribute [rw] flow_executions
1826
+ # The list of flow executions.
1827
+ # @return [Array<Types::DataIntegrationFlowExecution>]
1828
+ #
1829
+ # @!attribute [rw] next_token
1830
+ # The pagination token to fetch next page of flow executions.
1831
+ # @return [String]
1832
+ #
1833
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataIntegrationFlowExecutionsResponse AWS API Documentation
1834
+ #
1835
+ class ListDataIntegrationFlowExecutionsResponse < Struct.new(
1836
+ :flow_executions,
1837
+ :next_token)
1838
+ SENSITIVE = []
1839
+ include Aws::Structure
1840
+ end
1841
+
1034
1842
  # The request parameters for ListDataIntegrationFlows.
1035
1843
  #
1036
1844
  # @!attribute [rw] instance_id
@@ -1084,7 +1892,8 @@ module Aws::SupplyChain
1084
1892
  # @return [String]
1085
1893
  #
1086
1894
  # @!attribute [rw] namespace
1087
- # The name space of the dataset. The available values are:
1895
+ # The namespace of the dataset, besides the custom defined namespace,
1896
+ # every instance comes with below pre-defined namespaces:
1088
1897
  #
1089
1898
  # * **asc** - For information on the Amazon Web Services Supply Chain
1090
1899
  # supported datasets see
@@ -1135,6 +1944,50 @@ module Aws::SupplyChain
1135
1944
  include Aws::Structure
1136
1945
  end
1137
1946
 
1947
+ # The request parameters of ListDataLakeNamespaces.
1948
+ #
1949
+ # @!attribute [rw] instance_id
1950
+ # The Amazon Web Services Supply Chain instance identifier.
1951
+ # @return [String]
1952
+ #
1953
+ # @!attribute [rw] next_token
1954
+ # The pagination token to fetch next page of namespaces.
1955
+ # @return [String]
1956
+ #
1957
+ # @!attribute [rw] max_results
1958
+ # The max number of namespaces to fetch in this paginated request.
1959
+ # @return [Integer]
1960
+ #
1961
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataLakeNamespacesRequest AWS API Documentation
1962
+ #
1963
+ class ListDataLakeNamespacesRequest < Struct.new(
1964
+ :instance_id,
1965
+ :next_token,
1966
+ :max_results)
1967
+ SENSITIVE = []
1968
+ include Aws::Structure
1969
+ end
1970
+
1971
+ # The response parameters of ListDataLakeNamespaces.
1972
+ #
1973
+ # @!attribute [rw] namespaces
1974
+ # The list of fetched namespace details. Noted it only contains custom
1975
+ # namespaces, pre-defined namespaces are not included.
1976
+ # @return [Array<Types::DataLakeNamespace>]
1977
+ #
1978
+ # @!attribute [rw] next_token
1979
+ # The pagination token to fetch next page of namespaces.
1980
+ # @return [String]
1981
+ #
1982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataLakeNamespacesResponse AWS API Documentation
1983
+ #
1984
+ class ListDataLakeNamespacesResponse < Struct.new(
1985
+ :namespaces,
1986
+ :next_token)
1987
+ SENSITIVE = []
1988
+ include Aws::Structure
1989
+ end
1990
+
1138
1991
  # The request parameters for ListInstances.
1139
1992
  #
1140
1993
  # @!attribute [rw] next_token
@@ -1234,11 +2087,79 @@ module Aws::SupplyChain
1234
2087
  #
1235
2088
  # @!attribute [rw] event_type
1236
2089
  # The data event type.
2090
+ #
2091
+ # * **scn.data.dataset** - Send data directly to any specified
2092
+ # dataset.
2093
+ #
2094
+ # * **scn.data.supplyplan** - Send data to [supply\_plan][1] dataset.
2095
+ #
2096
+ # * **scn.data.shipmentstoporder** - Send data to
2097
+ # [shipment\_stop\_order][2] dataset.
2098
+ #
2099
+ # * **scn.data.shipmentstop** - Send data to [shipment\_stop][3]
2100
+ # dataset.
2101
+ #
2102
+ # * **scn.data.shipment** - Send data to [shipment][4] dataset.
2103
+ #
2104
+ # * **scn.data.reservation** - Send data to [reservation][5] dataset.
2105
+ #
2106
+ # * **scn.data.processproduct** - Send data to [process\_product][6]
2107
+ # dataset.
2108
+ #
2109
+ # * **scn.data.processoperation** - Send data to
2110
+ # [process\_operation][7] dataset.
2111
+ #
2112
+ # * **scn.data.processheader** - Send data to [process\_header][8]
2113
+ # dataset.
2114
+ #
2115
+ # * **scn.data.forecast** - Send data to [forecast][9] dataset.
2116
+ #
2117
+ # * **scn.data.inventorylevel** - Send data to [inv\_level][10]
2118
+ # dataset.
2119
+ #
2120
+ # * **scn.data.inboundorder** - Send data to [inbound\_order][11]
2121
+ # dataset.
2122
+ #
2123
+ # * **scn.data.inboundorderline** - Send data to
2124
+ # [inbound\_order\_line][12] dataset.
2125
+ #
2126
+ # * **scn.data.inboundorderlineschedule** - Send data to
2127
+ # [inbound\_order\_line\_schedule][13] dataset.
2128
+ #
2129
+ # * **scn.data.outboundorderline** - Send data to
2130
+ # [outbound\_order\_line][14] dataset.
2131
+ #
2132
+ # * **scn.data.outboundshipment** - Send data to
2133
+ # [outbound\_shipment][15] dataset.
2134
+ #
2135
+ #
2136
+ #
2137
+ # [1]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/supply-plan-entity.html
2138
+ # [2]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/replenishment-shipment-stop-order-entity.html
2139
+ # [3]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/replenishment-shipment-stop-entity.html
2140
+ # [4]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/replenishment-shipment-entity.html
2141
+ # [5]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/planning-reservation-entity.html
2142
+ # [6]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/operation-process-product-entity.html
2143
+ # [7]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/operation-process-operation-entity.html
2144
+ # [8]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/operation-process-header-entity.html
2145
+ # [9]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/forecast-forecast-entity.html
2146
+ # [10]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/inventory_mgmnt-inv-level-entity.html
2147
+ # [11]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/replenishment-inbound-order-entity.html
2148
+ # [12]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/replenishment-inbound-order-line-entity.html
2149
+ # [13]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/replenishment-inbound-order-line-schedule-entity.html
2150
+ # [14]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/outbound-fulfillment-order-line-entity.html
2151
+ # [15]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/outbound-fulfillment-shipment-entity.html
1237
2152
  # @return [String]
1238
2153
  #
1239
2154
  # @!attribute [rw] data
1240
- # The data payload of the event. For more information on the data
1241
- # schema to use, see [Data entities supported in AWS Supply Chain][1].
2155
+ # The data payload of the event, should follow the data schema of the
2156
+ # target dataset, or see [Data entities supported in AWS Supply
2157
+ # Chain][1]. To send single data record, use JsonObject format; to
2158
+ # send multiple data records, use JsonArray format.
2159
+ #
2160
+ # Note that for AWS Supply Chain dataset under **asc** namespace, it
2161
+ # has a connection\_id internal field that is not allowed to be
2162
+ # provided by client directly, they will be auto populated.
1242
2163
  #
1243
2164
  #
1244
2165
  #
@@ -1247,20 +2168,32 @@ module Aws::SupplyChain
1247
2168
  #
1248
2169
  # @!attribute [rw] event_group_id
1249
2170
  # Event identifier (for example, orderId for InboundOrder) used for
1250
- # data sharing or partitioning.
2171
+ # data sharding or partitioning. Noted under one eventGroupId of same
2172
+ # eventType and instanceId, events are processed sequentially in the
2173
+ # order they are received by the server.
1251
2174
  # @return [String]
1252
2175
  #
1253
2176
  # @!attribute [rw] event_timestamp
1254
- # The event timestamp (in epoch seconds).
2177
+ # The timestamp (in epoch seconds) associated with the event. If not
2178
+ # provided, it will be assigned with current timestamp.
1255
2179
  # @return [Time]
1256
2180
  #
1257
2181
  # @!attribute [rw] client_token
1258
- # The idempotent client token.
2182
+ # The idempotent client token. The token is active for 8 hours, and
2183
+ # within its lifetime, it ensures the request completes only once upon
2184
+ # retry with same client token. If omitted, the AWS SDK generates a
2185
+ # unique value so that AWS SDK can safely retry the request upon
2186
+ # network errors.
1259
2187
  #
1260
2188
  # **A suitable default value is auto-generated.** You should normally
1261
2189
  # not need to pass this option.
1262
2190
  # @return [String]
1263
2191
  #
2192
+ # @!attribute [rw] dataset_target
2193
+ # The target dataset configuration for **scn.data.dataset** event
2194
+ # type.
2195
+ # @return [Types::DataIntegrationEventDatasetTargetConfiguration]
2196
+ #
1264
2197
  # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/SendDataIntegrationEventRequest AWS API Documentation
1265
2198
  #
1266
2199
  class SendDataIntegrationEventRequest < Struct.new(
@@ -1269,7 +2202,8 @@ module Aws::SupplyChain
1269
2202
  :data,
1270
2203
  :event_group_id,
1271
2204
  :event_timestamp,
1272
- :client_token)
2205
+ :client_token,
2206
+ :dataset_target)
1273
2207
  SENSITIVE = [:data]
1274
2208
  include Aws::Structure
1275
2209
  end
@@ -1423,7 +2357,8 @@ module Aws::SupplyChain
1423
2357
  # @return [String]
1424
2358
  #
1425
2359
  # @!attribute [rw] namespace
1426
- # The name space of the dataset. The available values are:
2360
+ # The namespace of the dataset, besides the custom defined namespace,
2361
+ # every instance comes with below pre-defined namespaces:
1427
2362
  #
1428
2363
  # * **asc** - For information on the Amazon Web Services Supply Chain
1429
2364
  # supported datasets see
@@ -1437,8 +2372,8 @@ module Aws::SupplyChain
1437
2372
  # @return [String]
1438
2373
  #
1439
2374
  # @!attribute [rw] name
1440
- # The name of the dataset. For **asc** name space, the name must be
1441
- # one of the supported data entities under
2375
+ # The name of the dataset. For **asc** namespace, the name must be one
2376
+ # of the supported data entities under
1442
2377
  # [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html][1].
1443
2378
  #
1444
2379
  #
@@ -1475,6 +2410,46 @@ module Aws::SupplyChain
1475
2410
  include Aws::Structure
1476
2411
  end
1477
2412
 
2413
+ # The request parameters of UpdateDataLakeNamespace.
2414
+ #
2415
+ # @!attribute [rw] instance_id
2416
+ # The Amazon Web Services Chain instance identifier.
2417
+ # @return [String]
2418
+ #
2419
+ # @!attribute [rw] name
2420
+ # The name of the namespace. Noted you cannot update namespace with
2421
+ # name starting with **asc**, **default**, **scn**, **aws**,
2422
+ # **amazon**, **amzn**
2423
+ # @return [String]
2424
+ #
2425
+ # @!attribute [rw] description
2426
+ # The updated description of the data lake namespace.
2427
+ # @return [String]
2428
+ #
2429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UpdateDataLakeNamespaceRequest AWS API Documentation
2430
+ #
2431
+ class UpdateDataLakeNamespaceRequest < Struct.new(
2432
+ :instance_id,
2433
+ :name,
2434
+ :description)
2435
+ SENSITIVE = []
2436
+ include Aws::Structure
2437
+ end
2438
+
2439
+ # The response parameters of UpdateDataLakeNamespace.
2440
+ #
2441
+ # @!attribute [rw] namespace
2442
+ # The updated namespace details.
2443
+ # @return [Types::DataLakeNamespace]
2444
+ #
2445
+ # @see http://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/UpdateDataLakeNamespaceResponse AWS API Documentation
2446
+ #
2447
+ class UpdateDataLakeNamespaceResponse < Struct.new(
2448
+ :namespace)
2449
+ SENSITIVE = []
2450
+ include Aws::Structure
2451
+ end
2452
+
1478
2453
  # The request parameters for UpdateInstance.
1479
2454
  #
1480
2455
  # @!attribute [rw] instance_id