dataexchange.d.ts
44.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class DataExchange extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: DataExchange.Types.ClientConfiguration)
config: Config & DataExchange.Types.ClientConfiguration;
/**
* This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
*/
cancelJob(params: DataExchange.Types.CancelJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
*/
cancelJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation creates a data set.
*/
createDataSet(params: DataExchange.Types.CreateDataSetRequest, callback?: (err: AWSError, data: DataExchange.Types.CreateDataSetResponse) => void): Request<DataExchange.Types.CreateDataSetResponse, AWSError>;
/**
* This operation creates a data set.
*/
createDataSet(callback?: (err: AWSError, data: DataExchange.Types.CreateDataSetResponse) => void): Request<DataExchange.Types.CreateDataSetResponse, AWSError>;
/**
* This operation creates a job.
*/
createJob(params: DataExchange.Types.CreateJobRequest, callback?: (err: AWSError, data: DataExchange.Types.CreateJobResponse) => void): Request<DataExchange.Types.CreateJobResponse, AWSError>;
/**
* This operation creates a job.
*/
createJob(callback?: (err: AWSError, data: DataExchange.Types.CreateJobResponse) => void): Request<DataExchange.Types.CreateJobResponse, AWSError>;
/**
* This operation creates a revision for a data set.
*/
createRevision(params: DataExchange.Types.CreateRevisionRequest, callback?: (err: AWSError, data: DataExchange.Types.CreateRevisionResponse) => void): Request<DataExchange.Types.CreateRevisionResponse, AWSError>;
/**
* This operation creates a revision for a data set.
*/
createRevision(callback?: (err: AWSError, data: DataExchange.Types.CreateRevisionResponse) => void): Request<DataExchange.Types.CreateRevisionResponse, AWSError>;
/**
* This operation deletes an asset.
*/
deleteAsset(params: DataExchange.Types.DeleteAssetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation deletes an asset.
*/
deleteAsset(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation deletes a data set.
*/
deleteDataSet(params: DataExchange.Types.DeleteDataSetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation deletes a data set.
*/
deleteDataSet(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation deletes a revision.
*/
deleteRevision(params: DataExchange.Types.DeleteRevisionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation deletes a revision.
*/
deleteRevision(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation returns information about an asset.
*/
getAsset(params: DataExchange.Types.GetAssetRequest, callback?: (err: AWSError, data: DataExchange.Types.GetAssetResponse) => void): Request<DataExchange.Types.GetAssetResponse, AWSError>;
/**
* This operation returns information about an asset.
*/
getAsset(callback?: (err: AWSError, data: DataExchange.Types.GetAssetResponse) => void): Request<DataExchange.Types.GetAssetResponse, AWSError>;
/**
* This operation returns information about a data set.
*/
getDataSet(params: DataExchange.Types.GetDataSetRequest, callback?: (err: AWSError, data: DataExchange.Types.GetDataSetResponse) => void): Request<DataExchange.Types.GetDataSetResponse, AWSError>;
/**
* This operation returns information about a data set.
*/
getDataSet(callback?: (err: AWSError, data: DataExchange.Types.GetDataSetResponse) => void): Request<DataExchange.Types.GetDataSetResponse, AWSError>;
/**
* This operation returns information about a job.
*/
getJob(params: DataExchange.Types.GetJobRequest, callback?: (err: AWSError, data: DataExchange.Types.GetJobResponse) => void): Request<DataExchange.Types.GetJobResponse, AWSError>;
/**
* This operation returns information about a job.
*/
getJob(callback?: (err: AWSError, data: DataExchange.Types.GetJobResponse) => void): Request<DataExchange.Types.GetJobResponse, AWSError>;
/**
* This operation returns information about a revision.
*/
getRevision(params: DataExchange.Types.GetRevisionRequest, callback?: (err: AWSError, data: DataExchange.Types.GetRevisionResponse) => void): Request<DataExchange.Types.GetRevisionResponse, AWSError>;
/**
* This operation returns information about a revision.
*/
getRevision(callback?: (err: AWSError, data: DataExchange.Types.GetRevisionResponse) => void): Request<DataExchange.Types.GetRevisionResponse, AWSError>;
/**
* This operation lists a data set's revisions sorted by CreatedAt in descending order.
*/
listDataSetRevisions(params: DataExchange.Types.ListDataSetRevisionsRequest, callback?: (err: AWSError, data: DataExchange.Types.ListDataSetRevisionsResponse) => void): Request<DataExchange.Types.ListDataSetRevisionsResponse, AWSError>;
/**
* This operation lists a data set's revisions sorted by CreatedAt in descending order.
*/
listDataSetRevisions(callback?: (err: AWSError, data: DataExchange.Types.ListDataSetRevisionsResponse) => void): Request<DataExchange.Types.ListDataSetRevisionsResponse, AWSError>;
/**
* This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.
*/
listDataSets(params: DataExchange.Types.ListDataSetsRequest, callback?: (err: AWSError, data: DataExchange.Types.ListDataSetsResponse) => void): Request<DataExchange.Types.ListDataSetsResponse, AWSError>;
/**
* This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.
*/
listDataSets(callback?: (err: AWSError, data: DataExchange.Types.ListDataSetsResponse) => void): Request<DataExchange.Types.ListDataSetsResponse, AWSError>;
/**
* This operation lists your jobs sorted by CreatedAt in descending order.
*/
listJobs(params: DataExchange.Types.ListJobsRequest, callback?: (err: AWSError, data: DataExchange.Types.ListJobsResponse) => void): Request<DataExchange.Types.ListJobsResponse, AWSError>;
/**
* This operation lists your jobs sorted by CreatedAt in descending order.
*/
listJobs(callback?: (err: AWSError, data: DataExchange.Types.ListJobsResponse) => void): Request<DataExchange.Types.ListJobsResponse, AWSError>;
/**
* This operation lists a revision's assets sorted alphabetically in descending order.
*/
listRevisionAssets(params: DataExchange.Types.ListRevisionAssetsRequest, callback?: (err: AWSError, data: DataExchange.Types.ListRevisionAssetsResponse) => void): Request<DataExchange.Types.ListRevisionAssetsResponse, AWSError>;
/**
* This operation lists a revision's assets sorted alphabetically in descending order.
*/
listRevisionAssets(callback?: (err: AWSError, data: DataExchange.Types.ListRevisionAssetsResponse) => void): Request<DataExchange.Types.ListRevisionAssetsResponse, AWSError>;
/**
* This operation lists the tags on the resource.
*/
listTagsForResource(params: DataExchange.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: DataExchange.Types.ListTagsForResourceResponse) => void): Request<DataExchange.Types.ListTagsForResourceResponse, AWSError>;
/**
* This operation lists the tags on the resource.
*/
listTagsForResource(callback?: (err: AWSError, data: DataExchange.Types.ListTagsForResourceResponse) => void): Request<DataExchange.Types.ListTagsForResourceResponse, AWSError>;
/**
* This operation starts a job.
*/
startJob(params: DataExchange.Types.StartJobRequest, callback?: (err: AWSError, data: DataExchange.Types.StartJobResponse) => void): Request<DataExchange.Types.StartJobResponse, AWSError>;
/**
* This operation starts a job.
*/
startJob(callback?: (err: AWSError, data: DataExchange.Types.StartJobResponse) => void): Request<DataExchange.Types.StartJobResponse, AWSError>;
/**
* This operation tags a resource.
*/
tagResource(params: DataExchange.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation tags a resource.
*/
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation removes one or more tags from a resource.
*/
untagResource(params: DataExchange.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation removes one or more tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This operation updates an asset.
*/
updateAsset(params: DataExchange.Types.UpdateAssetRequest, callback?: (err: AWSError, data: DataExchange.Types.UpdateAssetResponse) => void): Request<DataExchange.Types.UpdateAssetResponse, AWSError>;
/**
* This operation updates an asset.
*/
updateAsset(callback?: (err: AWSError, data: DataExchange.Types.UpdateAssetResponse) => void): Request<DataExchange.Types.UpdateAssetResponse, AWSError>;
/**
* This operation updates a data set.
*/
updateDataSet(params: DataExchange.Types.UpdateDataSetRequest, callback?: (err: AWSError, data: DataExchange.Types.UpdateDataSetResponse) => void): Request<DataExchange.Types.UpdateDataSetResponse, AWSError>;
/**
* This operation updates a data set.
*/
updateDataSet(callback?: (err: AWSError, data: DataExchange.Types.UpdateDataSetResponse) => void): Request<DataExchange.Types.UpdateDataSetResponse, AWSError>;
/**
* This operation updates a revision.
*/
updateRevision(params: DataExchange.Types.UpdateRevisionRequest, callback?: (err: AWSError, data: DataExchange.Types.UpdateRevisionResponse) => void): Request<DataExchange.Types.UpdateRevisionResponse, AWSError>;
/**
* This operation updates a revision.
*/
updateRevision(callback?: (err: AWSError, data: DataExchange.Types.UpdateRevisionResponse) => void): Request<DataExchange.Types.UpdateRevisionResponse, AWSError>;
}
declare namespace DataExchange {
export type Arn = string;
export interface AssetDestinationEntry {
/**
* The unique identifier for the asset.
*/
AssetId: Id;
/**
* The S3 bucket that is the destination for the asset.
*/
Bucket: __string;
/**
* The name of the object in Amazon S3 for the asset.
*/
Key?: __string;
}
export interface AssetDetails {
S3SnapshotAsset?: S3SnapshotAsset;
}
export interface AssetEntry {
/**
* The ARN for the asset.
*/
Arn: Arn;
/**
* Information about the asset, including its size.
*/
AssetDetails: AssetDetails;
/**
* The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
*/
AssetType: AssetType;
/**
* The date and time that the asset was created, in ISO 8601 format.
*/
CreatedAt: Timestamp;
/**
* The unique identifier for the data set associated with this asset.
*/
DataSetId: Id;
/**
* The unique identifier for the asset.
*/
Id: Id;
/**
* The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
*/
Name: AssetName;
/**
* The unique identifier for the revision associated with this asset.
*/
RevisionId: Id;
/**
* The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.
*/
SourceId?: Id;
/**
* The date and time that the asset was last updated, in ISO 8601 format.
*/
UpdatedAt: Timestamp;
}
export type AssetName = string;
export interface AssetSourceEntry {
/**
* The S3 bucket that's part of the source of the asset.
*/
Bucket: __string;
/**
* The name of the object in Amazon S3 for the asset.
*/
Key: __string;
}
export type AssetType = "S3_SNAPSHOT"|string;
export interface CancelJobRequest {
/**
* The unique identifier for a job.
*/
JobId: __string;
}
export type Code = "ACCESS_DENIED_EXCEPTION"|"INTERNAL_SERVER_EXCEPTION"|"MALWARE_DETECTED"|"RESOURCE_NOT_FOUND_EXCEPTION"|"SERVICE_QUOTA_EXCEEDED_EXCEPTION"|"VALIDATION_EXCEPTION"|"MALWARE_SCAN_ENCRYPTED_FILE"|string;
export interface CreateDataSetRequest {
/**
* The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
*/
AssetType: AssetType;
/**
* A description for the data set. This value can be up to 16,348 characters long.
*/
Description: Description;
/**
* The name of the data set.
*/
Name: Name;
/**
* A data set tag is an optional label that you can assign to a data set when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.
*/
Tags?: MapOf__string;
}
export interface CreateDataSetResponse {
/**
* The ARN for the data set.
*/
Arn?: Arn;
/**
* The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
*/
AssetType?: AssetType;
/**
* The date and time that the data set was created, in ISO 8601 format.
*/
CreatedAt?: Timestamp;
/**
* The description for the data set.
*/
Description?: Description;
/**
* The unique identifier for the data set.
*/
Id?: Id;
/**
* The name of the data set.
*/
Name?: Name;
/**
* A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
*/
Origin?: Origin;
/**
* If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
*/
OriginDetails?: OriginDetails;
/**
* The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.
*/
SourceId?: Id;
/**
* The tags for the data set.
*/
Tags?: MapOf__string;
/**
* The date and time that the data set was last updated, in ISO 8601 format.
*/
UpdatedAt?: Timestamp;
}
export interface CreateJobRequest {
/**
* The details for the CreateJob request.
*/
Details: RequestDetails;
/**
* The type of job to be created.
*/
Type: Type;
}
export interface CreateJobResponse {
/**
* The ARN for the job.
*/
Arn?: Arn;
/**
* The date and time that the job was created, in ISO 8601 format.
*/
CreatedAt?: Timestamp;
/**
* Details about the job.
*/
Details?: ResponseDetails;
/**
* The errors associated with jobs.
*/
Errors?: ListOfJobError;
/**
* The unique identifier for the job.
*/
Id?: Id;
/**
* The state of the job.
*/
State?: State;
/**
* The job type.
*/
Type?: Type;
/**
* The date and time that the job was last updated, in ISO 8601 format.
*/
UpdatedAt?: Timestamp;
}
export interface CreateRevisionRequest {
/**
* An optional comment about the revision.
*/
Comment?: __stringMin0Max16384;
/**
* The unique identifier for a data set.
*/
DataSetId: __string;
/**
* A revision tag is an optional label that you can assign to a revision when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.
*/
Tags?: MapOf__string;
}
export interface CreateRevisionResponse {
/**
* The ARN for the revision
*/
Arn?: Arn;
/**
* An optional comment about the revision.
*/
Comment?: __stringMin0Max16384;
/**
* The date and time that the revision was created, in ISO 8601 format.
*/
CreatedAt?: Timestamp;
/**
* The unique identifier for the data set associated with this revision.
*/
DataSetId?: Id;
/**
* To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.
*/
Finalized?: __boolean;
/**
* The unique identifier for the revision.
*/
Id?: Id;
/**
* The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.
*/
SourceId?: Id;
/**
* The tags for the revision.
*/
Tags?: MapOf__string;
/**
* The date and time that the revision was last updated, in ISO 8601 format.
*/
UpdatedAt?: Timestamp;
}
export interface DataSetEntry {
/**
* The ARN for the data set.
*/
Arn: Arn;
/**
* The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
*/
AssetType: AssetType;
/**
* The date and time that the data set was created, in ISO 8601 format.
*/
CreatedAt: Timestamp;
/**
* The description for the data set.
*/
Description: Description;
/**
* The unique identifier for the data set.
*/
Id: Id;
/**
* The name of the data set.
*/
Name: Name;
/**
* A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
*/
Origin: Origin;
/**
* If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
*/
OriginDetails?: OriginDetails;
/**
* The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.
*/
SourceId?: Id;
/**
* The date and time that the data set was last updated, in ISO 8601 format.
*/
UpdatedAt: Timestamp;
}
export interface DeleteAssetRequest {
/**
* The unique identifier for an asset.
*/
AssetId: __string;
/**
* The unique identifier for a data set.
*/
DataSetId: __string;
/**
* The unique identifier for a revision.
*/
RevisionId: __string;
}
export interface DeleteDataSetRequest {
/**
* The unique identifier for a data set.
*/
DataSetId: __string;
}
export interface DeleteRevisionRequest {
/**
* The unique identifier for a data set.
*/
DataSetId: __string;
/**
* The unique identifier for a revision.
*/
RevisionId: __string;
}
export type Description = string;
export interface Details {
ImportAssetFromSignedUrlJobErrorDetails?: ImportAssetFromSignedUrlJobErrorDetails;
ImportAssetsFromS3JobErrorDetails?: ListOfAssetSourceEntry;
}
export interface ExportAssetToSignedUrlRequestDetails {
/**
* The unique identifier for the asset that is exported to a signed URL.
*/
AssetId: Id;
/**
* The unique identifier for the data set associated with this export job.
*/
DataSetId: Id;
/**
* The unique identifier for the revision associated with this export request.
*/
RevisionId: Id;
}
export interface ExportAssetToSignedUrlResponseDetails {
/**
* The unique identifier for the asset associated with this export job.
*/
AssetId: Id;
/**
* The unique identifier for the data set associated with this export job.
*/
DataSetId: Id;
/**
* The unique identifier for the revision associated with this export response.
*/
RevisionId: Id;
/**
* The signed URL for the export request.
*/
SignedUrl?: __string;
/**
* The date and time that the signed URL expires, in ISO 8601 format.
*/
SignedUrlExpiresAt?: Timestamp;
}
export interface ExportAssetsToS3RequestDetails {
/**
* The destination for the asset.
*/
AssetDestinations: ListOfAssetDestinationEntry;
/**
* The unique identifier for the data set associated with this export job.
*/
DataSetId: Id;
/**
* The unique identifier for the revision associated with this export request.
*/
RevisionId: Id;
}
export interface ExportAssetsToS3ResponseDetails {
/**
* The destination in Amazon S3 where the asset is exported.
*/
AssetDestinations: ListOfAssetDestinationEntry;
/**
* The unique identifier for the data set associated with this export job.
*/
DataSetId: Id;
/**
* The unique identifier for the revision associated with this export response.
*/
RevisionId: Id;
}
export interface GetAssetRequest {
/**
* The unique identifier for an asset.
*/
AssetId: __string;
/**
* The unique identifier for a data set.
*/
DataSetId: __string;
/**
* The unique identifier for a revision.
*/
RevisionId: __string;
}
export interface GetAssetResponse {
/**
* The ARN for the asset.
*/
Arn?: Arn;
/**
* Information about the asset, including its size.
*/
AssetDetails?: AssetDetails;
/**
* The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
*/
AssetType?: AssetType;
/**
* The date and time that the asset was created, in ISO 8601 format.
*/
CreatedAt?: Timestamp;
/**
* The unique identifier for the data set associated with this asset.
*/
DataSetId?: Id;
/**
* The unique identifier for the asset.
*/
Id?: Id;
/**
* The name of the asset When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
*/
Name?: AssetName;
/**
* The unique identifier for the revision associated with this asset.
*/
RevisionId?: Id;
/**
* The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.
*/
SourceId?: Id;
/**
* The date and time that the asset was last updated, in ISO 8601 format.
*/
UpdatedAt?: Timestamp;
}
export interface GetDataSetRequest {
/**
* The unique identifier for a data set.
*/
DataSetId: __string;
}
export interface GetDataSetResponse {
/**
* The ARN for the data set.
*/
Arn?: Arn;
/**
* The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
*/
AssetType?: AssetType;
/**
* The date and time that the data set was created, in ISO 8601 format.
*/
CreatedAt?: Timestamp;
/**
* The description for the data set.
*/
Description?: Description;
/**
* The unique identifier for the data set.
*/
Id?: Id;
/**
* The name of the data set.
*/
Name?: Name;
/**
* A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
*/
Origin?: Origin;
/**
* If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
*/
OriginDetails?: OriginDetails;
/**
* The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.
*/
SourceId?: Id;
/**
* The tags for the data set.
*/
Tags?: MapOf__string;
/**
* The date and time that the data set was last updated, in ISO 8601 format.
*/
UpdatedAt?: Timestamp;
}
export interface GetJobRequest {
/**
* The unique identifier for a job.
*/
JobId: __string;
}
export interface GetJobResponse {
/**
* The ARN for the job.
*/
Arn?: Arn;
/**
* The date and time that the job was created, in ISO 8601 format.
*/
CreatedAt?: Timestamp;
/**
* Details about the job.
*/
Details?: ResponseDetails;
/**
* The errors associated with jobs.
*/
Errors?: ListOfJobError;
/**
* The unique identifier for the job.
*/
Id?: Id;
/**
* The state of the job.
*/
State?: State;
/**
* The job type.
*/
Type?: Type;
/**
* The date and time that the job was last updated, in ISO 8601 format.
*/
UpdatedAt?: Timestamp;
}
export interface GetRevisionRequest {
/**
* The unique identifier for a data set.
*/
DataSetId: __string;
/**
* The unique identifier for a revision.
*/
RevisionId: __string;
}
export interface GetRevisionResponse {
/**
* The ARN for the revision
*/
Arn?: Arn;
/**
* An optional comment about the revision.
*/
Comment?: __stringMin0Max16384;
/**
* The date and time that the revision was created, in ISO 8601 format.
*/
CreatedAt?: Timestamp;
/**
* The unique identifier for the data set associated with this revision.
*/
DataSetId?: Id;
/**
* To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.
*/
Finalized?: __boolean;
/**
* The unique identifier for the revision.
*/
Id?: Id;
/**
* The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.
*/
SourceId?: Id;
/**
* The tags for the revision.
*/
Tags?: MapOf__string;
/**
* The date and time that the revision was last updated, in ISO 8601 format.
*/
UpdatedAt?: Timestamp;
}
export type Id = string;
export interface ImportAssetFromSignedUrlJobErrorDetails {
AssetName: AssetName;
}
export interface ImportAssetFromSignedUrlRequestDetails {
/**
* The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.
*/
AssetName: AssetName;
/**
* The unique identifier for the data set associated with this import job.
*/
DataSetId: Id;
/**
* The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
*/
Md5Hash: __stringMin24Max24PatternAZaZ094AZaZ092AZaZ093;
/**
* The unique identifier for the revision associated with this import request.
*/
RevisionId: Id;
}
export interface ImportAssetFromSignedUrlResponseDetails {
/**
* The name for the asset associated with this import response.
*/
AssetName: AssetName;
/**
* The unique identifier for the data set associated with this import job.
*/
DataSetId: Id;
/**
* The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
*/
Md5Hash?: __stringMin24Max24PatternAZaZ094AZaZ092AZaZ093;
/**
* The unique identifier for the revision associated with this import response.
*/
RevisionId: Id;
/**
* The signed URL.
*/
SignedUrl?: __string;
/**
* The time and date at which the signed URL expires, in ISO 8601 format.
*/
SignedUrlExpiresAt?: Timestamp;
}
export interface ImportAssetsFromS3RequestDetails {
/**
* Is a list of S3 bucket and object key pairs.
*/
AssetSources: ListOfAssetSourceEntry;
/**
* The unique identifier for the data set associated with this import job.
*/
DataSetId: Id;
/**
* The unique identifier for the revision associated with this import request.
*/
RevisionId: Id;
}
export interface ImportAssetsFromS3ResponseDetails {
/**
* Is a list of Amazon S3 bucket and object key pairs.
*/
AssetSources: ListOfAssetSourceEntry;
/**
* The unique identifier for the data set associated with this import job.
*/
DataSetId: Id;
/**
* The unique identifier for the revision associated with this import response.
*/
RevisionId: Id;
}
export interface JobEntry {
/**
* The ARN for the job.
*/
Arn: Arn;
/**
* The date and time that the job was created, in ISO 8601 format.
*/
CreatedAt: Timestamp;
/**
* Details of the operation to be performed by the job, such as export destination details or import source details.
*/
Details: ResponseDetails;
/**
* Errors for jobs.
*/
Errors?: ListOfJobError;
/**
* The unique identifier for the job.
*/
Id: Id;
/**
* The state of the job.
*/
State: State;
/**
* The job type.
*/
Type: Type;
/**
* The date and time that the job was last updated, in ISO 8601 format.
*/
UpdatedAt: Timestamp;
}
export interface JobError {
/**
* The code for the job error.
*/
Code: Code;
Details?: Details;
/**
* The name of the limit that was reached.
*/
LimitName?: JobErrorLimitName;
/**
* The value of the exceeded limit.
*/
LimitValue?: __double;
/**
* The message related to the job error.
*/
Message: __string;
/**
* The unqiue identifier for the resource related to the error.
*/
ResourceId?: __string;
/**
* The type of resource related to the error.
*/
ResourceType?: JobErrorResourceTypes;
}
export type JobErrorLimitName = "Assets per revision"|"Asset size in GB"|string;
export type JobErrorResourceTypes = "REVISION"|"ASSET"|string;
export interface ListDataSetRevisionsRequest {
/**
* The unique identifier for a data set.
*/
DataSetId: __string;
/**
* The maximum number of results returned by a single call.
*/
MaxResults?: MaxResults;
/**
* The token value retrieved from a previous call to access the next page of results.
*/
NextToken?: __string;
}
export interface ListDataSetRevisionsResponse {
/**
* The token value retrieved from a previous call to access the next page of results.
*/
NextToken?: NextToken;
/**
* The asset objects listed by the request.
*/
Revisions?: ListOfRevisionEntry;
}
export interface ListDataSetsRequest {
/**
* The maximum number of results returned by a single call.
*/
MaxResults?: MaxResults;
/**
* The token value retrieved from a previous call to access the next page of results.
*/
NextToken?: __string;
/**
* A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
*/
Origin?: __string;
}
export interface ListDataSetsResponse {
/**
* The data set objects listed by the request.
*/
DataSets?: ListOfDataSetEntry;
/**
* The token value retrieved from a previous call to access the next page of results.
*/
NextToken?: NextToken;
}
export interface ListJobsRequest {
/**
* The unique identifier for a data set.
*/
DataSetId?: __string;
/**
* The maximum number of results returned by a single call.
*/
MaxResults?: MaxResults;
/**
* The token value retrieved from a previous call to access the next page of results.
*/
NextToken?: __string;
/**
* The unique identifier for a revision.
*/
RevisionId?: __string;
}
export interface ListJobsResponse {
/**
* The jobs listed by the request.
*/
Jobs?: ListOfJobEntry;
/**
* The token value retrieved from a previous call to access the next page of results.
*/
NextToken?: NextToken;
}
export type ListOfAssetDestinationEntry = AssetDestinationEntry[];
export type ListOfAssetSourceEntry = AssetSourceEntry[];
export interface ListRevisionAssetsRequest {
/**
* The unique identifier for a data set.
*/
DataSetId: __string;
/**
* The maximum number of results returned by a single call.
*/
MaxResults?: MaxResults;
/**
* The token value retrieved from a previous call to access the next page of results.
*/
NextToken?: __string;
/**
* The unique identifier for a revision.
*/
RevisionId: __string;
}
export interface ListRevisionAssetsResponse {
/**
* The asset objects listed by the request.
*/
Assets?: ListOfAssetEntry;
/**
* The token value retrieved from a previous call to access the next page of results.
*/
NextToken?: NextToken;
}
export interface ListTagsForResourceRequest {
/**
* An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
*/
ResourceArn: __string;
}
export interface ListTagsForResourceResponse {
/**
* A label that consists of a customer-defined key and an optional value.
*/
Tags?: MapOf__string;
}
export type MaxResults = number;
export type Name = string;
export type NextToken = string;
export type Origin = "OWNED"|"ENTITLED"|string;
export interface OriginDetails {
ProductId: __string;
}
export interface RequestDetails {
/**
* Details about the export to signed URL request.
*/
ExportAssetToSignedUrl?: ExportAssetToSignedUrlRequestDetails;
/**
* Details about the export to Amazon S3 request.
*/
ExportAssetsToS3?: ExportAssetsToS3RequestDetails;
/**
* Details about the import from signed URL request.
*/
ImportAssetFromSignedUrl?: ImportAssetFromSignedUrlRequestDetails;
/**
* Details about the import from Amazon S3 request.
*/
ImportAssetsFromS3?: ImportAssetsFromS3RequestDetails;
}
export interface ResponseDetails {
/**
* Details for the export to signed URL response.
*/
ExportAssetToSignedUrl?: ExportAssetToSignedUrlResponseDetails;
/**
* Details for the export to Amazon S3 response.
*/
ExportAssetsToS3?: ExportAssetsToS3ResponseDetails;
/**
* Details for the import from signed URL response.
*/
ImportAssetFromSignedUrl?: ImportAssetFromSignedUrlResponseDetails;
/**
* Details for the import from Amazon S3 response.
*/
ImportAssetsFromS3?: ImportAssetsFromS3ResponseDetails;
}
export interface RevisionEntry {
/**
* The ARN for the revision.
*/
Arn: Arn;
/**
* An optional comment about the revision.
*/
Comment?: __stringMin0Max16384;
/**
* The date and time that the revision was created, in ISO 8601 format.
*/
CreatedAt: Timestamp;
/**
* The unique identifier for the data set associated with this revision.
*/
DataSetId: Id;
/**
* To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.
*/
Finalized?: __boolean;
/**
* The unique identifier for the revision.
*/
Id: Id;
/**
* The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.
*/
SourceId?: Id;
/**
* The date and time that the revision was last updated, in ISO 8601 format.
*/
UpdatedAt: Timestamp;
}
export interface S3SnapshotAsset {
/**
* The size of the S3 object that is the object.
*/
Size: __doubleMin0;
}
export interface StartJobRequest {
/**
* The unique identifier for a job.
*/
JobId: __string;
}
export interface StartJobResponse {
}
export type State = "WAITING"|"IN_PROGRESS"|"ERROR"|"COMPLETED"|"CANCELLED"|"TIMED_OUT"|string;
export interface TagResourceRequest {
/**
* An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
*/
ResourceArn: __string;
/**
* A label that consists of a customer-defined key and an optional value.
*/
Tags: MapOf__string;
}
export type Timestamp = Date;
export type Type = "IMPORT_ASSETS_FROM_S3"|"IMPORT_ASSET_FROM_SIGNED_URL"|"EXPORT_ASSETS_TO_S3"|"EXPORT_ASSET_TO_SIGNED_URL"|string;
export interface UntagResourceRequest {
/**
* An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
*/
ResourceArn: __string;
/**
* The key tags.
*/
TagKeys: ListOf__string;
}
export interface UpdateAssetRequest {
/**
* The unique identifier for an asset.
*/
AssetId: __string;
/**
* The unique identifier for a data set.
*/
DataSetId: __string;
/**
* The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
*/
Name: AssetName;
/**
* The unique identifier for a revision.
*/
RevisionId: __string;
}
export interface UpdateAssetResponse {
/**
* The ARN for the asset.
*/
Arn?: Arn;
/**
* Information about the asset, including its size.
*/
AssetDetails?: AssetDetails;
/**
* The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
*/
AssetType?: AssetType;
/**
* The date and time that the asset was created, in ISO 8601 format.
*/
CreatedAt?: Timestamp;
/**
* The unique identifier for the data set associated with this asset.
*/
DataSetId?: Id;
/**
* The unique identifier for the asset.
*/
Id?: Id;
/**
* The name of the asset When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
*/
Name?: AssetName;
/**
* The unique identifier for the revision associated with this asset.
*/
RevisionId?: Id;
/**
* The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.
*/
SourceId?: Id;
/**
* The date and time that the asset was last updated, in ISO 8601 format.
*/
UpdatedAt?: Timestamp;
}
export interface UpdateDataSetRequest {
/**
* The unique identifier for a data set.
*/
DataSetId: __string;
/**
* The description for the data set.
*/
Description?: Description;
/**
* The name of the data set.
*/
Name?: Name;
}
export interface UpdateDataSetResponse {
/**
* The ARN for the data set.
*/
Arn?: Arn;
/**
* The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
*/
AssetType?: AssetType;
/**
* The date and time that the data set was created, in ISO 8601 format.
*/
CreatedAt?: Timestamp;
/**
* The description for the data set.
*/
Description?: Description;
/**
* The unique identifier for the data set.
*/
Id?: Id;
/**
* The name of the data set.
*/
Name?: Name;
/**
* A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
*/
Origin?: Origin;
/**
* If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
*/
OriginDetails?: OriginDetails;
/**
* The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.
*/
SourceId?: Id;
/**
* The date and time that the data set was last updated, in ISO 8601 format.
*/
UpdatedAt?: Timestamp;
}
export interface UpdateRevisionRequest {
/**
* An optional comment about the revision.
*/
Comment?: __stringMin0Max16384;
/**
* The unique identifier for a data set.
*/
DataSetId: __string;
/**
* Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.
*/
Finalized?: __boolean;
/**
* The unique identifier for a revision.
*/
RevisionId: __string;
}
export interface UpdateRevisionResponse {
/**
* The ARN for the revision.
*/
Arn?: Arn;
/**
* An optional comment about the revision.
*/
Comment?: __stringMin0Max16384;
/**
* The date and time that the revision was created, in ISO 8601 format.
*/
CreatedAt?: Timestamp;
/**
* The unique identifier for the data set associated with this revision.
*/
DataSetId?: Id;
/**
* To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.
*/
Finalized?: __boolean;
/**
* The unique identifier for the revision.
*/
Id?: Id;
/**
* The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.
*/
SourceId?: Id;
/**
* The date and time that the revision was last updated, in ISO 8601 format.
*/
UpdatedAt?: Timestamp;
}
export type __boolean = boolean;
export type __double = number;
export type __doubleMin0 = number;
export type ListOfAssetEntry = AssetEntry[];
export type ListOfDataSetEntry = DataSetEntry[];
export type ListOfJobEntry = JobEntry[];
export type ListOfJobError = JobError[];
export type ListOfRevisionEntry = RevisionEntry[];
export type ListOf__string = __string[];
export type MapOf__string = {[key: string]: __string};
export type __string = string;
export type __stringMin0Max16384 = string;
export type __stringMin24Max24PatternAZaZ094AZaZ092AZaZ093 = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2017-07-25"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the DataExchange client.
*/
export import Types = DataExchange;
}
export = DataExchange;