@aws-sdk/client-dataexchange 3.379.1 → 3.382.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.
- package/dist-types/models/models_0.d.ts +453 -0
- package/package.json +5 -5
|
@@ -8,6 +8,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
9
9
|
readonly $fault: "client";
|
|
10
10
|
/**
|
|
11
|
+
* @public
|
|
11
12
|
* <p>Access to the resource is denied.</p>
|
|
12
13
|
*/
|
|
13
14
|
Message: string | undefined;
|
|
@@ -34,10 +35,12 @@ export type ServerSideEncryptionTypes = (typeof ServerSideEncryptionTypes)[keyof
|
|
|
34
35
|
*/
|
|
35
36
|
export interface ExportServerSideEncryption {
|
|
36
37
|
/**
|
|
38
|
+
* @public
|
|
37
39
|
* <p>The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.</p>
|
|
38
40
|
*/
|
|
39
41
|
KmsKeyArn?: string;
|
|
40
42
|
/**
|
|
43
|
+
* @public
|
|
41
44
|
* <p>The type of server side encryption used for encrypting the objects in Amazon S3.</p>
|
|
42
45
|
*/
|
|
43
46
|
Type: ServerSideEncryptionTypes | string | undefined;
|
|
@@ -48,10 +51,12 @@ export interface ExportServerSideEncryption {
|
|
|
48
51
|
*/
|
|
49
52
|
export interface AutoExportRevisionDestinationEntry {
|
|
50
53
|
/**
|
|
54
|
+
* @public
|
|
51
55
|
* <p>The Amazon S3 bucket that is the destination for the event action.</p>
|
|
52
56
|
*/
|
|
53
57
|
Bucket: string | undefined;
|
|
54
58
|
/**
|
|
59
|
+
* @public
|
|
55
60
|
* <p>A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see <a href="https://docs.aws.amazon.com/data-exchange/latest/userguide/jobs.html#revision-export-keypatterns">Key patterns when exporting revisions</a>.</p>
|
|
56
61
|
*/
|
|
57
62
|
KeyPattern?: string;
|
|
@@ -62,10 +67,12 @@ export interface AutoExportRevisionDestinationEntry {
|
|
|
62
67
|
*/
|
|
63
68
|
export interface AutoExportRevisionToS3RequestDetails {
|
|
64
69
|
/**
|
|
70
|
+
* @public
|
|
65
71
|
* <p>Encryption configuration for the auto export job.</p>
|
|
66
72
|
*/
|
|
67
73
|
Encryption?: ExportServerSideEncryption;
|
|
68
74
|
/**
|
|
75
|
+
* @public
|
|
69
76
|
* <p>A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.</p>
|
|
70
77
|
*/
|
|
71
78
|
RevisionDestination: AutoExportRevisionDestinationEntry | undefined;
|
|
@@ -76,6 +83,7 @@ export interface AutoExportRevisionToS3RequestDetails {
|
|
|
76
83
|
*/
|
|
77
84
|
export interface Action {
|
|
78
85
|
/**
|
|
86
|
+
* @public
|
|
79
87
|
* <p>Details for the export revision to Amazon S3 action.</p>
|
|
80
88
|
*/
|
|
81
89
|
ExportRevisionToS3?: AutoExportRevisionToS3RequestDetails;
|
|
@@ -97,38 +105,47 @@ export type ProtocolType = (typeof ProtocolType)[keyof typeof ProtocolType];
|
|
|
97
105
|
*/
|
|
98
106
|
export interface ApiGatewayApiAsset {
|
|
99
107
|
/**
|
|
108
|
+
* @public
|
|
100
109
|
* <p>The API description of the API asset.</p>
|
|
101
110
|
*/
|
|
102
111
|
ApiDescription?: string;
|
|
103
112
|
/**
|
|
113
|
+
* @public
|
|
104
114
|
* <p>The API endpoint of the API asset.</p>
|
|
105
115
|
*/
|
|
106
116
|
ApiEndpoint?: string;
|
|
107
117
|
/**
|
|
118
|
+
* @public
|
|
108
119
|
* <p>The unique identifier of the API asset.</p>
|
|
109
120
|
*/
|
|
110
121
|
ApiId?: string;
|
|
111
122
|
/**
|
|
123
|
+
* @public
|
|
112
124
|
* <p>The API key of the API asset.</p>
|
|
113
125
|
*/
|
|
114
126
|
ApiKey?: string;
|
|
115
127
|
/**
|
|
128
|
+
* @public
|
|
116
129
|
* <p>The API name of the API asset.</p>
|
|
117
130
|
*/
|
|
118
131
|
ApiName?: string;
|
|
119
132
|
/**
|
|
133
|
+
* @public
|
|
120
134
|
* <p>The download URL of the API specification of the API asset.</p>
|
|
121
135
|
*/
|
|
122
136
|
ApiSpecificationDownloadUrl?: string;
|
|
123
137
|
/**
|
|
138
|
+
* @public
|
|
124
139
|
* <p>The date and time that the upload URL expires, in ISO 8601 format.</p>
|
|
125
140
|
*/
|
|
126
141
|
ApiSpecificationDownloadUrlExpiresAt?: Date;
|
|
127
142
|
/**
|
|
143
|
+
* @public
|
|
128
144
|
* <p>The protocol type of the API asset.</p>
|
|
129
145
|
*/
|
|
130
146
|
ProtocolType?: ProtocolType | string;
|
|
131
147
|
/**
|
|
148
|
+
* @public
|
|
132
149
|
* <p>The stage of the API asset.</p>
|
|
133
150
|
*/
|
|
134
151
|
Stage?: string;
|
|
@@ -139,14 +156,17 @@ export interface ApiGatewayApiAsset {
|
|
|
139
156
|
*/
|
|
140
157
|
export interface AssetDestinationEntry {
|
|
141
158
|
/**
|
|
159
|
+
* @public
|
|
142
160
|
* <p>The unique identifier for the asset.</p>
|
|
143
161
|
*/
|
|
144
162
|
AssetId: string | undefined;
|
|
145
163
|
/**
|
|
164
|
+
* @public
|
|
146
165
|
* <p>The Amazon S3 bucket that is the destination for the asset.</p>
|
|
147
166
|
*/
|
|
148
167
|
Bucket: string | undefined;
|
|
149
168
|
/**
|
|
169
|
+
* @public
|
|
150
170
|
* <p>The name of the object in Amazon S3 for the asset.</p>
|
|
151
171
|
*/
|
|
152
172
|
Key?: string;
|
|
@@ -157,10 +177,12 @@ export interface AssetDestinationEntry {
|
|
|
157
177
|
*/
|
|
158
178
|
export interface LFTag {
|
|
159
179
|
/**
|
|
180
|
+
* @public
|
|
160
181
|
* <p>The key name for the LF-tag.</p>
|
|
161
182
|
*/
|
|
162
183
|
TagKey: string | undefined;
|
|
163
184
|
/**
|
|
185
|
+
* @public
|
|
164
186
|
* <p>A list of LF-tag values.</p>
|
|
165
187
|
*/
|
|
166
188
|
TagValues: string[] | undefined;
|
|
@@ -171,6 +193,7 @@ export interface LFTag {
|
|
|
171
193
|
*/
|
|
172
194
|
export interface DatabaseLFTagPolicy {
|
|
173
195
|
/**
|
|
196
|
+
* @public
|
|
174
197
|
* <p>A list of LF-tag conditions that apply to database resources.</p>
|
|
175
198
|
*/
|
|
176
199
|
Expression: LFTag[] | undefined;
|
|
@@ -181,6 +204,7 @@ export interface DatabaseLFTagPolicy {
|
|
|
181
204
|
*/
|
|
182
205
|
export interface TableLFTagPolicy {
|
|
183
206
|
/**
|
|
207
|
+
* @public
|
|
184
208
|
* <p>A list of LF-tag conditions that apply to table resources.</p>
|
|
185
209
|
*/
|
|
186
210
|
Expression: LFTag[] | undefined;
|
|
@@ -191,10 +215,12 @@ export interface TableLFTagPolicy {
|
|
|
191
215
|
*/
|
|
192
216
|
export interface LFResourceDetails {
|
|
193
217
|
/**
|
|
218
|
+
* @public
|
|
194
219
|
* <p>Details about the database resource included in the AWS Lake Formation data permission.</p>
|
|
195
220
|
*/
|
|
196
221
|
Database?: DatabaseLFTagPolicy;
|
|
197
222
|
/**
|
|
223
|
+
* @public
|
|
198
224
|
* <p>Details about the table resource included in the AWS Lake Formation data permission.</p>
|
|
199
225
|
*/
|
|
200
226
|
Table?: TableLFTagPolicy;
|
|
@@ -217,14 +243,17 @@ export type LFResourceType = (typeof LFResourceType)[keyof typeof LFResourceType
|
|
|
217
243
|
*/
|
|
218
244
|
export interface LFTagPolicyDetails {
|
|
219
245
|
/**
|
|
246
|
+
* @public
|
|
220
247
|
* <p>The identifier for the AWS Glue Data Catalog.</p>
|
|
221
248
|
*/
|
|
222
249
|
CatalogId: string | undefined;
|
|
223
250
|
/**
|
|
251
|
+
* @public
|
|
224
252
|
* <p>The resource type for which the LF-tag policy applies.</p>
|
|
225
253
|
*/
|
|
226
254
|
ResourceType: LFResourceType | string | undefined;
|
|
227
255
|
/**
|
|
256
|
+
* @public
|
|
228
257
|
* <p>Details for the Lake Formation Resources included in the LF-tag policy.</p>
|
|
229
258
|
*/
|
|
230
259
|
ResourceDetails: LFResourceDetails | undefined;
|
|
@@ -235,6 +264,7 @@ export interface LFTagPolicyDetails {
|
|
|
235
264
|
*/
|
|
236
265
|
export interface LakeFormationDataPermissionDetails {
|
|
237
266
|
/**
|
|
267
|
+
* @public
|
|
238
268
|
* <p>Details about the LF-tag policy.</p>
|
|
239
269
|
*/
|
|
240
270
|
LFTagPolicy?: LFTagPolicyDetails;
|
|
@@ -268,18 +298,22 @@ export type LFPermission = (typeof LFPermission)[keyof typeof LFPermission];
|
|
|
268
298
|
*/
|
|
269
299
|
export interface LakeFormationDataPermissionAsset {
|
|
270
300
|
/**
|
|
301
|
+
* @public
|
|
271
302
|
* <p>Details about the AWS Lake Formation data permission.</p>
|
|
272
303
|
*/
|
|
273
304
|
LakeFormationDataPermissionDetails: LakeFormationDataPermissionDetails | undefined;
|
|
274
305
|
/**
|
|
306
|
+
* @public
|
|
275
307
|
* <p>The data permission type.</p>
|
|
276
308
|
*/
|
|
277
309
|
LakeFormationDataPermissionType: LakeFormationDataPermissionType | string | undefined;
|
|
278
310
|
/**
|
|
311
|
+
* @public
|
|
279
312
|
* <p>The permissions granted to the subscribers on the resource.</p>
|
|
280
313
|
*/
|
|
281
314
|
Permissions: (LFPermission | string)[] | undefined;
|
|
282
315
|
/**
|
|
316
|
+
* @public
|
|
283
317
|
* <p>The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke permissions to AWS Lake Formation data permissions.</p>
|
|
284
318
|
*/
|
|
285
319
|
RoleArn?: string;
|
|
@@ -290,6 +324,7 @@ export interface LakeFormationDataPermissionAsset {
|
|
|
290
324
|
*/
|
|
291
325
|
export interface RedshiftDataShareAsset {
|
|
292
326
|
/**
|
|
327
|
+
* @public
|
|
293
328
|
* <p>The Amazon Resource Name (ARN) of the datashare asset.</p>
|
|
294
329
|
*/
|
|
295
330
|
Arn: string | undefined;
|
|
@@ -301,6 +336,7 @@ export interface RedshiftDataShareAsset {
|
|
|
301
336
|
*/
|
|
302
337
|
export interface KmsKeyToGrant {
|
|
303
338
|
/**
|
|
339
|
+
* @public
|
|
304
340
|
* <p>The AWS KMS CMK (Key Management System Customer Managed Key) used to encrypt S3 objects
|
|
305
341
|
* in the shared S3 Bucket. AWS Data exchange will create a KMS grant for each subscriber to
|
|
306
342
|
* allow them to access and decrypt their entitled data that is encrypted using this KMS key
|
|
@@ -314,26 +350,32 @@ export interface KmsKeyToGrant {
|
|
|
314
350
|
*/
|
|
315
351
|
export interface S3DataAccessAsset {
|
|
316
352
|
/**
|
|
353
|
+
* @public
|
|
317
354
|
* <p>The Amazon S3 bucket hosting data to be shared in the S3 data access.</p>
|
|
318
355
|
*/
|
|
319
356
|
Bucket: string | undefined;
|
|
320
357
|
/**
|
|
358
|
+
* @public
|
|
321
359
|
* <p>The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.</p>
|
|
322
360
|
*/
|
|
323
361
|
KeyPrefixes?: string[];
|
|
324
362
|
/**
|
|
363
|
+
* @public
|
|
325
364
|
* <p>S3 keys made available using this asset.</p>
|
|
326
365
|
*/
|
|
327
366
|
Keys?: string[];
|
|
328
367
|
/**
|
|
368
|
+
* @public
|
|
329
369
|
* <p>The automatically-generated bucket-style alias for your Amazon S3 Access Point. Customers can access their entitled data using the S3 Access Point alias.</p>
|
|
330
370
|
*/
|
|
331
371
|
S3AccessPointAlias?: string;
|
|
332
372
|
/**
|
|
373
|
+
* @public
|
|
333
374
|
* <p>The ARN for your Amazon S3 Access Point. Customers can also access their entitled data using the S3 Access Point ARN.</p>
|
|
334
375
|
*/
|
|
335
376
|
S3AccessPointArn?: string;
|
|
336
377
|
/**
|
|
378
|
+
* @public
|
|
337
379
|
* <p> List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to
|
|
338
380
|
* encrypt S3 objects being shared in this S3 Data Access asset. Providers must include all
|
|
339
381
|
* AWS KMS keys used to encrypt these shared S3 objects.</p>
|
|
@@ -346,6 +388,7 @@ export interface S3DataAccessAsset {
|
|
|
346
388
|
*/
|
|
347
389
|
export interface S3SnapshotAsset {
|
|
348
390
|
/**
|
|
391
|
+
* @public
|
|
349
392
|
* <p>The size of the Amazon S3 object that is the object.</p>
|
|
350
393
|
*/
|
|
351
394
|
Size: number | undefined;
|
|
@@ -356,22 +399,27 @@ export interface S3SnapshotAsset {
|
|
|
356
399
|
*/
|
|
357
400
|
export interface AssetDetails {
|
|
358
401
|
/**
|
|
402
|
+
* @public
|
|
359
403
|
* <p>The Amazon S3 object that is the asset.</p>
|
|
360
404
|
*/
|
|
361
405
|
S3SnapshotAsset?: S3SnapshotAsset;
|
|
362
406
|
/**
|
|
407
|
+
* @public
|
|
363
408
|
* <p>The Amazon Redshift datashare that is the asset.</p>
|
|
364
409
|
*/
|
|
365
410
|
RedshiftDataShareAsset?: RedshiftDataShareAsset;
|
|
366
411
|
/**
|
|
412
|
+
* @public
|
|
367
413
|
* <p>Information about the API Gateway API asset.</p>
|
|
368
414
|
*/
|
|
369
415
|
ApiGatewayApiAsset?: ApiGatewayApiAsset;
|
|
370
416
|
/**
|
|
417
|
+
* @public
|
|
371
418
|
* <p>The Amazon S3 data access that is the asset.</p>
|
|
372
419
|
*/
|
|
373
420
|
S3DataAccessAsset?: S3DataAccessAsset;
|
|
374
421
|
/**
|
|
422
|
+
* @public
|
|
375
423
|
* <p>The AWS Lake Formation data permission that is the asset.</p>
|
|
376
424
|
*/
|
|
377
425
|
LakeFormationDataPermissionAsset?: LakeFormationDataPermissionAsset;
|
|
@@ -404,30 +452,37 @@ export type AssetType = (typeof AssetType)[keyof typeof AssetType];
|
|
|
404
452
|
*/
|
|
405
453
|
export interface AssetEntry {
|
|
406
454
|
/**
|
|
455
|
+
* @public
|
|
407
456
|
* <p>The ARN for the asset.</p>
|
|
408
457
|
*/
|
|
409
458
|
Arn: string | undefined;
|
|
410
459
|
/**
|
|
460
|
+
* @public
|
|
411
461
|
* <p>Details about the asset.</p>
|
|
412
462
|
*/
|
|
413
463
|
AssetDetails: AssetDetails | undefined;
|
|
414
464
|
/**
|
|
465
|
+
* @public
|
|
415
466
|
* <p>The type of asset that is added to a data set.</p>
|
|
416
467
|
*/
|
|
417
468
|
AssetType: AssetType | string | undefined;
|
|
418
469
|
/**
|
|
470
|
+
* @public
|
|
419
471
|
* <p>The date and time that the asset was created, in ISO 8601 format.</p>
|
|
420
472
|
*/
|
|
421
473
|
CreatedAt: Date | undefined;
|
|
422
474
|
/**
|
|
475
|
+
* @public
|
|
423
476
|
* <p>The unique identifier for the data set associated with this asset.</p>
|
|
424
477
|
*/
|
|
425
478
|
DataSetId: string | undefined;
|
|
426
479
|
/**
|
|
480
|
+
* @public
|
|
427
481
|
* <p>The unique identifier for the asset.</p>
|
|
428
482
|
*/
|
|
429
483
|
Id: string | undefined;
|
|
430
484
|
/**
|
|
485
|
+
* @public
|
|
431
486
|
* <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used
|
|
432
487
|
* as the asset name. When exporting to Amazon S3, the asset name is used as default target
|
|
433
488
|
* Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as
|
|
@@ -438,14 +493,17 @@ export interface AssetEntry {
|
|
|
438
493
|
*/
|
|
439
494
|
Name: string | undefined;
|
|
440
495
|
/**
|
|
496
|
+
* @public
|
|
441
497
|
* <p>The unique identifier for the revision associated with this asset.</p>
|
|
442
498
|
*/
|
|
443
499
|
RevisionId: string | undefined;
|
|
444
500
|
/**
|
|
501
|
+
* @public
|
|
445
502
|
* <p>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.</p>
|
|
446
503
|
*/
|
|
447
504
|
SourceId?: string;
|
|
448
505
|
/**
|
|
506
|
+
* @public
|
|
449
507
|
* <p>The date and time that the asset was last updated, in ISO 8601 format.</p>
|
|
450
508
|
*/
|
|
451
509
|
UpdatedAt: Date | undefined;
|
|
@@ -456,10 +514,12 @@ export interface AssetEntry {
|
|
|
456
514
|
*/
|
|
457
515
|
export interface AssetSourceEntry {
|
|
458
516
|
/**
|
|
517
|
+
* @public
|
|
459
518
|
* <p>The Amazon S3 bucket that's part of the source of the asset.</p>
|
|
460
519
|
*/
|
|
461
520
|
Bucket: string | undefined;
|
|
462
521
|
/**
|
|
522
|
+
* @public
|
|
463
523
|
* <p>The name of the object in Amazon S3 for the asset.</p>
|
|
464
524
|
*/
|
|
465
525
|
Key: string | undefined;
|
|
@@ -469,6 +529,7 @@ export interface AssetSourceEntry {
|
|
|
469
529
|
*/
|
|
470
530
|
export interface CancelJobRequest {
|
|
471
531
|
/**
|
|
532
|
+
* @public
|
|
472
533
|
* <p>The unique identifier for a job.</p>
|
|
473
534
|
*/
|
|
474
535
|
JobId: string | undefined;
|
|
@@ -496,14 +557,17 @@ export declare class ConflictException extends __BaseException {
|
|
|
496
557
|
readonly name: "ConflictException";
|
|
497
558
|
readonly $fault: "client";
|
|
498
559
|
/**
|
|
560
|
+
* @public
|
|
499
561
|
* <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
|
|
500
562
|
*/
|
|
501
563
|
Message: string | undefined;
|
|
502
564
|
/**
|
|
565
|
+
* @public
|
|
503
566
|
* <p>The unique identifier for the resource with the conflict.</p>
|
|
504
567
|
*/
|
|
505
568
|
ResourceId?: string;
|
|
506
569
|
/**
|
|
570
|
+
* @public
|
|
507
571
|
* <p>The type of the resource with the conflict.</p>
|
|
508
572
|
*/
|
|
509
573
|
ResourceType?: ResourceType | string;
|
|
@@ -520,6 +584,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
520
584
|
readonly name: "InternalServerException";
|
|
521
585
|
readonly $fault: "server";
|
|
522
586
|
/**
|
|
587
|
+
* @public
|
|
523
588
|
* <p>The message identifying the service exception that occurred.</p>
|
|
524
589
|
*/
|
|
525
590
|
Message: string | undefined;
|
|
@@ -536,14 +601,17 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
536
601
|
readonly name: "ResourceNotFoundException";
|
|
537
602
|
readonly $fault: "client";
|
|
538
603
|
/**
|
|
604
|
+
* @public
|
|
539
605
|
* <p>The resource couldn't be found.</p>
|
|
540
606
|
*/
|
|
541
607
|
Message: string | undefined;
|
|
542
608
|
/**
|
|
609
|
+
* @public
|
|
543
610
|
* <p>The unique identifier for the resource that couldn't be found.</p>
|
|
544
611
|
*/
|
|
545
612
|
ResourceId?: string;
|
|
546
613
|
/**
|
|
614
|
+
* @public
|
|
547
615
|
* <p>The type of resource that couldn't be found.</p>
|
|
548
616
|
*/
|
|
549
617
|
ResourceType?: ResourceType | string;
|
|
@@ -560,6 +628,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
560
628
|
readonly name: "ThrottlingException";
|
|
561
629
|
readonly $fault: "client";
|
|
562
630
|
/**
|
|
631
|
+
* @public
|
|
563
632
|
* <p>The limit on the number of requests per second was exceeded.</p>
|
|
564
633
|
*/
|
|
565
634
|
Message: string | undefined;
|
|
@@ -588,10 +657,12 @@ export declare class ValidationException extends __BaseException {
|
|
|
588
657
|
readonly name: "ValidationException";
|
|
589
658
|
readonly $fault: "client";
|
|
590
659
|
/**
|
|
660
|
+
* @public
|
|
591
661
|
* <p>The message that informs you about what was invalid about the request.</p>
|
|
592
662
|
*/
|
|
593
663
|
Message: string | undefined;
|
|
594
664
|
/**
|
|
665
|
+
* @public
|
|
595
666
|
* <p>The unique identifier for the resource that couldn't be found.</p>
|
|
596
667
|
*/
|
|
597
668
|
ExceptionCause?: ExceptionCause | string;
|
|
@@ -622,18 +693,22 @@ export type Code = (typeof Code)[keyof typeof Code];
|
|
|
622
693
|
*/
|
|
623
694
|
export interface CreateDataSetRequest {
|
|
624
695
|
/**
|
|
696
|
+
* @public
|
|
625
697
|
* <p>The type of asset that is added to a data set.</p>
|
|
626
698
|
*/
|
|
627
699
|
AssetType: AssetType | string | undefined;
|
|
628
700
|
/**
|
|
701
|
+
* @public
|
|
629
702
|
* <p>A description for the data set. This value can be up to 16,348 characters long.</p>
|
|
630
703
|
*/
|
|
631
704
|
Description: string | undefined;
|
|
632
705
|
/**
|
|
706
|
+
* @public
|
|
633
707
|
* <p>The name of the data set.</p>
|
|
634
708
|
*/
|
|
635
709
|
Name: string | undefined;
|
|
636
710
|
/**
|
|
711
|
+
* @public
|
|
637
712
|
* <p>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.</p>
|
|
638
713
|
*/
|
|
639
714
|
Tags?: Record<string, string>;
|
|
@@ -656,6 +731,7 @@ export type Origin = (typeof Origin)[keyof typeof Origin];
|
|
|
656
731
|
*/
|
|
657
732
|
export interface OriginDetails {
|
|
658
733
|
/**
|
|
734
|
+
* @public
|
|
659
735
|
* <p>The product ID of the origin of the data set.</p>
|
|
660
736
|
*/
|
|
661
737
|
ProductId: string | undefined;
|
|
@@ -665,46 +741,57 @@ export interface OriginDetails {
|
|
|
665
741
|
*/
|
|
666
742
|
export interface CreateDataSetResponse {
|
|
667
743
|
/**
|
|
744
|
+
* @public
|
|
668
745
|
* <p>The ARN for the data set.</p>
|
|
669
746
|
*/
|
|
670
747
|
Arn?: string;
|
|
671
748
|
/**
|
|
749
|
+
* @public
|
|
672
750
|
* <p>The type of asset that is added to a data set.</p>
|
|
673
751
|
*/
|
|
674
752
|
AssetType?: AssetType | string;
|
|
675
753
|
/**
|
|
754
|
+
* @public
|
|
676
755
|
* <p>The date and time that the data set was created, in ISO 8601 format.</p>
|
|
677
756
|
*/
|
|
678
757
|
CreatedAt?: Date;
|
|
679
758
|
/**
|
|
759
|
+
* @public
|
|
680
760
|
* <p>The description for the data set.</p>
|
|
681
761
|
*/
|
|
682
762
|
Description?: string;
|
|
683
763
|
/**
|
|
764
|
+
* @public
|
|
684
765
|
* <p>The unique identifier for the data set.</p>
|
|
685
766
|
*/
|
|
686
767
|
Id?: string;
|
|
687
768
|
/**
|
|
769
|
+
* @public
|
|
688
770
|
* <p>The name of the data set.</p>
|
|
689
771
|
*/
|
|
690
772
|
Name?: string;
|
|
691
773
|
/**
|
|
774
|
+
* @public
|
|
692
775
|
* <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).</p>
|
|
693
776
|
*/
|
|
694
777
|
Origin?: Origin | string;
|
|
695
778
|
/**
|
|
779
|
+
* @public
|
|
696
780
|
* <p>If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.</p>
|
|
697
781
|
*/
|
|
698
782
|
OriginDetails?: OriginDetails;
|
|
699
783
|
/**
|
|
784
|
+
* @public
|
|
700
785
|
* <p>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.</p>
|
|
701
786
|
*/
|
|
702
787
|
SourceId?: string;
|
|
703
788
|
/**
|
|
789
|
+
* @public
|
|
704
790
|
* <p>The tags for the data set.</p>
|
|
705
791
|
*/
|
|
706
792
|
Tags?: Record<string, string>;
|
|
707
793
|
/**
|
|
794
|
+
* @public
|
|
708
795
|
* <p>The date and time that the data set was last updated, in ISO 8601 format.</p>
|
|
709
796
|
*/
|
|
710
797
|
UpdatedAt?: Date;
|
|
@@ -755,14 +842,17 @@ export declare class ServiceLimitExceededException extends __BaseException {
|
|
|
755
842
|
readonly name: "ServiceLimitExceededException";
|
|
756
843
|
readonly $fault: "client";
|
|
757
844
|
/**
|
|
845
|
+
* @public
|
|
758
846
|
* <p>The name of the limit that was reached.</p>
|
|
759
847
|
*/
|
|
760
848
|
LimitName?: LimitName | string;
|
|
761
849
|
/**
|
|
850
|
+
* @public
|
|
762
851
|
* <p>The value of the exceeded limit.</p>
|
|
763
852
|
*/
|
|
764
853
|
LimitValue?: number;
|
|
765
854
|
/**
|
|
855
|
+
* @public
|
|
766
856
|
* <p>The request has exceeded the quotas imposed by the service.</p>
|
|
767
857
|
*/
|
|
768
858
|
Message: string | undefined;
|
|
@@ -777,6 +867,7 @@ export declare class ServiceLimitExceededException extends __BaseException {
|
|
|
777
867
|
*/
|
|
778
868
|
export interface RevisionPublished {
|
|
779
869
|
/**
|
|
870
|
+
* @public
|
|
780
871
|
* <p>The data set ID of the published revision.</p>
|
|
781
872
|
*/
|
|
782
873
|
DataSetId: string | undefined;
|
|
@@ -787,6 +878,7 @@ export interface RevisionPublished {
|
|
|
787
878
|
*/
|
|
788
879
|
export interface Event {
|
|
789
880
|
/**
|
|
881
|
+
* @public
|
|
790
882
|
* <p>What occurs to start the revision publish action.</p>
|
|
791
883
|
*/
|
|
792
884
|
RevisionPublished?: RevisionPublished;
|
|
@@ -796,10 +888,12 @@ export interface Event {
|
|
|
796
888
|
*/
|
|
797
889
|
export interface CreateEventActionRequest {
|
|
798
890
|
/**
|
|
891
|
+
* @public
|
|
799
892
|
* <p>What occurs after a certain event.</p>
|
|
800
893
|
*/
|
|
801
894
|
Action: Action | undefined;
|
|
802
895
|
/**
|
|
896
|
+
* @public
|
|
803
897
|
* <p>What occurs to start an action.</p>
|
|
804
898
|
*/
|
|
805
899
|
Event: Event | undefined;
|
|
@@ -809,26 +903,32 @@ export interface CreateEventActionRequest {
|
|
|
809
903
|
*/
|
|
810
904
|
export interface CreateEventActionResponse {
|
|
811
905
|
/**
|
|
906
|
+
* @public
|
|
812
907
|
* <p>What occurs after a certain event.</p>
|
|
813
908
|
*/
|
|
814
909
|
Action?: Action;
|
|
815
910
|
/**
|
|
911
|
+
* @public
|
|
816
912
|
* <p>The ARN for the event action.</p>
|
|
817
913
|
*/
|
|
818
914
|
Arn?: string;
|
|
819
915
|
/**
|
|
916
|
+
* @public
|
|
820
917
|
* <p>The date and time that the event action was created, in ISO 8601 format.</p>
|
|
821
918
|
*/
|
|
822
919
|
CreatedAt?: Date;
|
|
823
920
|
/**
|
|
921
|
+
* @public
|
|
824
922
|
* <p>What occurs to start an action.</p>
|
|
825
923
|
*/
|
|
826
924
|
Event?: Event;
|
|
827
925
|
/**
|
|
926
|
+
* @public
|
|
828
927
|
* <p>The unique identifier for the event action.</p>
|
|
829
928
|
*/
|
|
830
929
|
Id?: string;
|
|
831
930
|
/**
|
|
931
|
+
* @public
|
|
832
932
|
* <p>The date and time that the event action was last updated, in ISO 8601 format.</p>
|
|
833
933
|
*/
|
|
834
934
|
UpdatedAt?: Date;
|
|
@@ -839,18 +939,22 @@ export interface CreateEventActionResponse {
|
|
|
839
939
|
*/
|
|
840
940
|
export interface S3DataAccessAssetSourceEntry {
|
|
841
941
|
/**
|
|
942
|
+
* @public
|
|
842
943
|
* <p>The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.</p>
|
|
843
944
|
*/
|
|
844
945
|
Bucket: string | undefined;
|
|
845
946
|
/**
|
|
947
|
+
* @public
|
|
846
948
|
* <p>Organizes Amazon S3 asset key prefixes stored in an Amazon S3 bucket.</p>
|
|
847
949
|
*/
|
|
848
950
|
KeyPrefixes?: string[];
|
|
849
951
|
/**
|
|
952
|
+
* @public
|
|
850
953
|
* <p>The keys used to create the Amazon S3 data access.</p>
|
|
851
954
|
*/
|
|
852
955
|
Keys?: string[];
|
|
853
956
|
/**
|
|
957
|
+
* @public
|
|
854
958
|
* <p>List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to
|
|
855
959
|
* encrypt S3 objects being shared in this S3 Data Access asset.</p>
|
|
856
960
|
*/
|
|
@@ -862,14 +966,17 @@ export interface S3DataAccessAssetSourceEntry {
|
|
|
862
966
|
*/
|
|
863
967
|
export interface CreateS3DataAccessFromS3BucketRequestDetails {
|
|
864
968
|
/**
|
|
969
|
+
* @public
|
|
865
970
|
* <p>Details about the S3 data access source asset.</p>
|
|
866
971
|
*/
|
|
867
972
|
AssetSource: S3DataAccessAssetSourceEntry | undefined;
|
|
868
973
|
/**
|
|
974
|
+
* @public
|
|
869
975
|
* <p>The unique identifier for the data set associated with the creation of this Amazon S3 data access.</p>
|
|
870
976
|
*/
|
|
871
977
|
DataSetId: string | undefined;
|
|
872
978
|
/**
|
|
979
|
+
* @public
|
|
873
980
|
* <p>The unique identifier for a revision.</p>
|
|
874
981
|
*/
|
|
875
982
|
RevisionId: string | undefined;
|
|
@@ -880,18 +987,22 @@ export interface CreateS3DataAccessFromS3BucketRequestDetails {
|
|
|
880
987
|
*/
|
|
881
988
|
export interface ExportAssetsToS3RequestDetails {
|
|
882
989
|
/**
|
|
990
|
+
* @public
|
|
883
991
|
* <p>The destination for the asset.</p>
|
|
884
992
|
*/
|
|
885
993
|
AssetDestinations: AssetDestinationEntry[] | undefined;
|
|
886
994
|
/**
|
|
995
|
+
* @public
|
|
887
996
|
* <p>The unique identifier for the data set associated with this export job.</p>
|
|
888
997
|
*/
|
|
889
998
|
DataSetId: string | undefined;
|
|
890
999
|
/**
|
|
1000
|
+
* @public
|
|
891
1001
|
* <p>Encryption configuration for the export job.</p>
|
|
892
1002
|
*/
|
|
893
1003
|
Encryption?: ExportServerSideEncryption;
|
|
894
1004
|
/**
|
|
1005
|
+
* @public
|
|
895
1006
|
* <p>The unique identifier for the revision associated with this export request.</p>
|
|
896
1007
|
*/
|
|
897
1008
|
RevisionId: string | undefined;
|
|
@@ -902,14 +1013,17 @@ export interface ExportAssetsToS3RequestDetails {
|
|
|
902
1013
|
*/
|
|
903
1014
|
export interface ExportAssetToSignedUrlRequestDetails {
|
|
904
1015
|
/**
|
|
1016
|
+
* @public
|
|
905
1017
|
* <p>The unique identifier for the asset that is exported to a signed URL.</p>
|
|
906
1018
|
*/
|
|
907
1019
|
AssetId: string | undefined;
|
|
908
1020
|
/**
|
|
1021
|
+
* @public
|
|
909
1022
|
* <p>The unique identifier for the data set associated with this export job.</p>
|
|
910
1023
|
*/
|
|
911
1024
|
DataSetId: string | undefined;
|
|
912
1025
|
/**
|
|
1026
|
+
* @public
|
|
913
1027
|
* <p>The unique identifier for the revision associated with this export request.</p>
|
|
914
1028
|
*/
|
|
915
1029
|
RevisionId: string | undefined;
|
|
@@ -920,14 +1034,17 @@ export interface ExportAssetToSignedUrlRequestDetails {
|
|
|
920
1034
|
*/
|
|
921
1035
|
export interface RevisionDestinationEntry {
|
|
922
1036
|
/**
|
|
1037
|
+
* @public
|
|
923
1038
|
* <p>The Amazon S3 bucket that is the destination for the assets in the revision.</p>
|
|
924
1039
|
*/
|
|
925
1040
|
Bucket: string | undefined;
|
|
926
1041
|
/**
|
|
1042
|
+
* @public
|
|
927
1043
|
* <p>A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see <a href="https://docs.aws.amazon.com/data-exchange/latest/userguide/jobs.html#revision-export-keypatterns">Key patterns when exporting revisions</a>.</p>
|
|
928
1044
|
*/
|
|
929
1045
|
KeyPattern?: string;
|
|
930
1046
|
/**
|
|
1047
|
+
* @public
|
|
931
1048
|
* <p>The unique identifier for the revision.</p>
|
|
932
1049
|
*/
|
|
933
1050
|
RevisionId: string | undefined;
|
|
@@ -938,14 +1055,17 @@ export interface RevisionDestinationEntry {
|
|
|
938
1055
|
*/
|
|
939
1056
|
export interface ExportRevisionsToS3RequestDetails {
|
|
940
1057
|
/**
|
|
1058
|
+
* @public
|
|
941
1059
|
* <p>The unique identifier for the data set associated with this export job.</p>
|
|
942
1060
|
*/
|
|
943
1061
|
DataSetId: string | undefined;
|
|
944
1062
|
/**
|
|
1063
|
+
* @public
|
|
945
1064
|
* <p>Encryption configuration for the export job.</p>
|
|
946
1065
|
*/
|
|
947
1066
|
Encryption?: ExportServerSideEncryption;
|
|
948
1067
|
/**
|
|
1068
|
+
* @public
|
|
949
1069
|
* <p>The destination for the revision.</p>
|
|
950
1070
|
*/
|
|
951
1071
|
RevisionDestinations: RevisionDestinationEntry[] | undefined;
|
|
@@ -956,38 +1076,47 @@ export interface ExportRevisionsToS3RequestDetails {
|
|
|
956
1076
|
*/
|
|
957
1077
|
export interface ImportAssetFromApiGatewayApiRequestDetails {
|
|
958
1078
|
/**
|
|
1079
|
+
* @public
|
|
959
1080
|
* <p>The API description. Markdown supported.</p>
|
|
960
1081
|
*/
|
|
961
1082
|
ApiDescription?: string;
|
|
962
1083
|
/**
|
|
1084
|
+
* @public
|
|
963
1085
|
* <p>The API Gateway API ID.</p>
|
|
964
1086
|
*/
|
|
965
1087
|
ApiId: string | undefined;
|
|
966
1088
|
/**
|
|
1089
|
+
* @public
|
|
967
1090
|
* <p>The API Gateway API key.</p>
|
|
968
1091
|
*/
|
|
969
1092
|
ApiKey?: string;
|
|
970
1093
|
/**
|
|
1094
|
+
* @public
|
|
971
1095
|
* <p>The API name.</p>
|
|
972
1096
|
*/
|
|
973
1097
|
ApiName: string | undefined;
|
|
974
1098
|
/**
|
|
1099
|
+
* @public
|
|
975
1100
|
* <p>The Base64-encoded MD5 hash of the OpenAPI 3.0 JSON API specification file. It is used to ensure the integrity of the file.</p>
|
|
976
1101
|
*/
|
|
977
1102
|
ApiSpecificationMd5Hash: string | undefined;
|
|
978
1103
|
/**
|
|
1104
|
+
* @public
|
|
979
1105
|
* <p>The data set ID.</p>
|
|
980
1106
|
*/
|
|
981
1107
|
DataSetId: string | undefined;
|
|
982
1108
|
/**
|
|
1109
|
+
* @public
|
|
983
1110
|
* <p>The protocol type.</p>
|
|
984
1111
|
*/
|
|
985
1112
|
ProtocolType: ProtocolType | string | undefined;
|
|
986
1113
|
/**
|
|
1114
|
+
* @public
|
|
987
1115
|
* <p>The revision ID.</p>
|
|
988
1116
|
*/
|
|
989
1117
|
RevisionId: string | undefined;
|
|
990
1118
|
/**
|
|
1119
|
+
* @public
|
|
991
1120
|
* <p>The API stage.</p>
|
|
992
1121
|
*/
|
|
993
1122
|
Stage: string | undefined;
|
|
@@ -998,18 +1127,22 @@ export interface ImportAssetFromApiGatewayApiRequestDetails {
|
|
|
998
1127
|
*/
|
|
999
1128
|
export interface ImportAssetFromSignedUrlRequestDetails {
|
|
1000
1129
|
/**
|
|
1130
|
+
* @public
|
|
1001
1131
|
* <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name.</p>
|
|
1002
1132
|
*/
|
|
1003
1133
|
AssetName: string | undefined;
|
|
1004
1134
|
/**
|
|
1135
|
+
* @public
|
|
1005
1136
|
* <p>The unique identifier for the data set associated with this import job.</p>
|
|
1006
1137
|
*/
|
|
1007
1138
|
DataSetId: string | undefined;
|
|
1008
1139
|
/**
|
|
1140
|
+
* @public
|
|
1009
1141
|
* <p>The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.</p>
|
|
1010
1142
|
*/
|
|
1011
1143
|
Md5Hash: string | undefined;
|
|
1012
1144
|
/**
|
|
1145
|
+
* @public
|
|
1013
1146
|
* <p>The unique identifier for the revision associated with this import request.</p>
|
|
1014
1147
|
*/
|
|
1015
1148
|
RevisionId: string | undefined;
|
|
@@ -1031,10 +1164,12 @@ export type DatabaseLFTagPolicyPermission = (typeof DatabaseLFTagPolicyPermissio
|
|
|
1031
1164
|
*/
|
|
1032
1165
|
export interface DatabaseLFTagPolicyAndPermissions {
|
|
1033
1166
|
/**
|
|
1167
|
+
* @public
|
|
1034
1168
|
* <p>A list of LF-tag conditions that apply to database resources.</p>
|
|
1035
1169
|
*/
|
|
1036
1170
|
Expression: LFTag[] | undefined;
|
|
1037
1171
|
/**
|
|
1172
|
+
* @public
|
|
1038
1173
|
* <p>The permissions granted to subscribers on database resources.</p>
|
|
1039
1174
|
*/
|
|
1040
1175
|
Permissions: (DatabaseLFTagPolicyPermission | string)[] | undefined;
|
|
@@ -1057,10 +1192,12 @@ export type TableTagPolicyLFPermission = (typeof TableTagPolicyLFPermission)[key
|
|
|
1057
1192
|
*/
|
|
1058
1193
|
export interface TableLFTagPolicyAndPermissions {
|
|
1059
1194
|
/**
|
|
1195
|
+
* @public
|
|
1060
1196
|
* <p>A list of LF-tag conditions that apply to table resources.</p>
|
|
1061
1197
|
*/
|
|
1062
1198
|
Expression: LFTag[] | undefined;
|
|
1063
1199
|
/**
|
|
1200
|
+
* @public
|
|
1064
1201
|
* <p>The permissions granted to subscribers on table resources.</p>
|
|
1065
1202
|
*/
|
|
1066
1203
|
Permissions: (TableTagPolicyLFPermission | string)[] | undefined;
|
|
@@ -1071,26 +1208,32 @@ export interface TableLFTagPolicyAndPermissions {
|
|
|
1071
1208
|
*/
|
|
1072
1209
|
export interface ImportAssetsFromLakeFormationTagPolicyRequestDetails {
|
|
1073
1210
|
/**
|
|
1211
|
+
* @public
|
|
1074
1212
|
* <p>The identifier for the AWS Glue Data Catalog.</p>
|
|
1075
1213
|
*/
|
|
1076
1214
|
CatalogId: string | undefined;
|
|
1077
1215
|
/**
|
|
1216
|
+
* @public
|
|
1078
1217
|
* <p>A structure for the database object.</p>
|
|
1079
1218
|
*/
|
|
1080
1219
|
Database?: DatabaseLFTagPolicyAndPermissions;
|
|
1081
1220
|
/**
|
|
1221
|
+
* @public
|
|
1082
1222
|
* <p>A structure for the table object.</p>
|
|
1083
1223
|
*/
|
|
1084
1224
|
Table?: TableLFTagPolicyAndPermissions;
|
|
1085
1225
|
/**
|
|
1226
|
+
* @public
|
|
1086
1227
|
* <p>The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke permissions of subscribers to AWS Lake Formation data permissions.</p>
|
|
1087
1228
|
*/
|
|
1088
1229
|
RoleArn: string | undefined;
|
|
1089
1230
|
/**
|
|
1231
|
+
* @public
|
|
1090
1232
|
* <p>The unique identifier for the data set associated with this import job.</p>
|
|
1091
1233
|
*/
|
|
1092
1234
|
DataSetId: string | undefined;
|
|
1093
1235
|
/**
|
|
1236
|
+
* @public
|
|
1094
1237
|
* <p>The unique identifier for the revision associated with this import job.</p>
|
|
1095
1238
|
*/
|
|
1096
1239
|
RevisionId: string | undefined;
|
|
@@ -1101,6 +1244,7 @@ export interface ImportAssetsFromLakeFormationTagPolicyRequestDetails {
|
|
|
1101
1244
|
*/
|
|
1102
1245
|
export interface RedshiftDataShareAssetSourceEntry {
|
|
1103
1246
|
/**
|
|
1247
|
+
* @public
|
|
1104
1248
|
* <p>The Amazon Resource Name (ARN) of the datashare asset.</p>
|
|
1105
1249
|
*/
|
|
1106
1250
|
DataShareArn: string | undefined;
|
|
@@ -1111,14 +1255,17 @@ export interface RedshiftDataShareAssetSourceEntry {
|
|
|
1111
1255
|
*/
|
|
1112
1256
|
export interface ImportAssetsFromRedshiftDataSharesRequestDetails {
|
|
1113
1257
|
/**
|
|
1258
|
+
* @public
|
|
1114
1259
|
* <p>A list of Amazon Redshift datashare assets.</p>
|
|
1115
1260
|
*/
|
|
1116
1261
|
AssetSources: RedshiftDataShareAssetSourceEntry[] | undefined;
|
|
1117
1262
|
/**
|
|
1263
|
+
* @public
|
|
1118
1264
|
* <p>The unique identifier for the data set associated with this import job.</p>
|
|
1119
1265
|
*/
|
|
1120
1266
|
DataSetId: string | undefined;
|
|
1121
1267
|
/**
|
|
1268
|
+
* @public
|
|
1122
1269
|
* <p>The unique identifier for the revision associated with this import job.</p>
|
|
1123
1270
|
*/
|
|
1124
1271
|
RevisionId: string | undefined;
|
|
@@ -1129,14 +1276,17 @@ export interface ImportAssetsFromRedshiftDataSharesRequestDetails {
|
|
|
1129
1276
|
*/
|
|
1130
1277
|
export interface ImportAssetsFromS3RequestDetails {
|
|
1131
1278
|
/**
|
|
1279
|
+
* @public
|
|
1132
1280
|
* <p>Is a list of Amazon S3 bucket and object key pairs.</p>
|
|
1133
1281
|
*/
|
|
1134
1282
|
AssetSources: AssetSourceEntry[] | undefined;
|
|
1135
1283
|
/**
|
|
1284
|
+
* @public
|
|
1136
1285
|
* <p>The unique identifier for the data set associated with this import job.</p>
|
|
1137
1286
|
*/
|
|
1138
1287
|
DataSetId: string | undefined;
|
|
1139
1288
|
/**
|
|
1289
|
+
* @public
|
|
1140
1290
|
* <p>The unique identifier for the revision associated with this import request.</p>
|
|
1141
1291
|
*/
|
|
1142
1292
|
RevisionId: string | undefined;
|
|
@@ -1147,38 +1297,47 @@ export interface ImportAssetsFromS3RequestDetails {
|
|
|
1147
1297
|
*/
|
|
1148
1298
|
export interface RequestDetails {
|
|
1149
1299
|
/**
|
|
1300
|
+
* @public
|
|
1150
1301
|
* <p>Details about the export to signed URL request.</p>
|
|
1151
1302
|
*/
|
|
1152
1303
|
ExportAssetToSignedUrl?: ExportAssetToSignedUrlRequestDetails;
|
|
1153
1304
|
/**
|
|
1305
|
+
* @public
|
|
1154
1306
|
* <p>Details about the export to Amazon S3 request.</p>
|
|
1155
1307
|
*/
|
|
1156
1308
|
ExportAssetsToS3?: ExportAssetsToS3RequestDetails;
|
|
1157
1309
|
/**
|
|
1310
|
+
* @public
|
|
1158
1311
|
* <p>Details about the export to Amazon S3 request.</p>
|
|
1159
1312
|
*/
|
|
1160
1313
|
ExportRevisionsToS3?: ExportRevisionsToS3RequestDetails;
|
|
1161
1314
|
/**
|
|
1315
|
+
* @public
|
|
1162
1316
|
* <p>Details about the import from Amazon S3 request.</p>
|
|
1163
1317
|
*/
|
|
1164
1318
|
ImportAssetFromSignedUrl?: ImportAssetFromSignedUrlRequestDetails;
|
|
1165
1319
|
/**
|
|
1320
|
+
* @public
|
|
1166
1321
|
* <p>Details about the import asset from API Gateway API request.</p>
|
|
1167
1322
|
*/
|
|
1168
1323
|
ImportAssetsFromS3?: ImportAssetsFromS3RequestDetails;
|
|
1169
1324
|
/**
|
|
1325
|
+
* @public
|
|
1170
1326
|
* <p>Details from an import from Amazon Redshift datashare request.</p>
|
|
1171
1327
|
*/
|
|
1172
1328
|
ImportAssetsFromRedshiftDataShares?: ImportAssetsFromRedshiftDataSharesRequestDetails;
|
|
1173
1329
|
/**
|
|
1330
|
+
* @public
|
|
1174
1331
|
* <p>Details about the import from signed URL request.</p>
|
|
1175
1332
|
*/
|
|
1176
1333
|
ImportAssetFromApiGatewayApi?: ImportAssetFromApiGatewayApiRequestDetails;
|
|
1177
1334
|
/**
|
|
1335
|
+
* @public
|
|
1178
1336
|
* <p>Details of the request to create S3 data access from the Amazon S3 bucket.</p>
|
|
1179
1337
|
*/
|
|
1180
1338
|
CreateS3DataAccessFromS3Bucket?: CreateS3DataAccessFromS3BucketRequestDetails;
|
|
1181
1339
|
/**
|
|
1340
|
+
* @public
|
|
1182
1341
|
* <p>Request details for the ImportAssetsFromLakeFormationTagPolicy job.</p>
|
|
1183
1342
|
*/
|
|
1184
1343
|
ImportAssetsFromLakeFormationTagPolicy?: ImportAssetsFromLakeFormationTagPolicyRequestDetails;
|
|
@@ -1207,10 +1366,12 @@ export type Type = (typeof Type)[keyof typeof Type];
|
|
|
1207
1366
|
*/
|
|
1208
1367
|
export interface CreateJobRequest {
|
|
1209
1368
|
/**
|
|
1369
|
+
* @public
|
|
1210
1370
|
* <p>The details for the CreateJob request.</p>
|
|
1211
1371
|
*/
|
|
1212
1372
|
Details: RequestDetails | undefined;
|
|
1213
1373
|
/**
|
|
1374
|
+
* @public
|
|
1214
1375
|
* <p>The type of job to be created.</p>
|
|
1215
1376
|
*/
|
|
1216
1377
|
Type: Type | string | undefined;
|
|
@@ -1221,14 +1382,17 @@ export interface CreateJobRequest {
|
|
|
1221
1382
|
*/
|
|
1222
1383
|
export interface CreateS3DataAccessFromS3BucketResponseDetails {
|
|
1223
1384
|
/**
|
|
1385
|
+
* @public
|
|
1224
1386
|
* <p>Details about the asset source from an Amazon S3 bucket.</p>
|
|
1225
1387
|
*/
|
|
1226
1388
|
AssetSource: S3DataAccessAssetSourceEntry | undefined;
|
|
1227
1389
|
/**
|
|
1390
|
+
* @public
|
|
1228
1391
|
* <p>The unique identifier for this data set.</p>
|
|
1229
1392
|
*/
|
|
1230
1393
|
DataSetId: string | undefined;
|
|
1231
1394
|
/**
|
|
1395
|
+
* @public
|
|
1232
1396
|
* <p>The unique identifier for the revision.</p>
|
|
1233
1397
|
*/
|
|
1234
1398
|
RevisionId: string | undefined;
|
|
@@ -1239,18 +1403,22 @@ export interface CreateS3DataAccessFromS3BucketResponseDetails {
|
|
|
1239
1403
|
*/
|
|
1240
1404
|
export interface ExportAssetsToS3ResponseDetails {
|
|
1241
1405
|
/**
|
|
1406
|
+
* @public
|
|
1242
1407
|
* <p>The destination in Amazon S3 where the asset is exported.</p>
|
|
1243
1408
|
*/
|
|
1244
1409
|
AssetDestinations: AssetDestinationEntry[] | undefined;
|
|
1245
1410
|
/**
|
|
1411
|
+
* @public
|
|
1246
1412
|
* <p>The unique identifier for the data set associated with this export job.</p>
|
|
1247
1413
|
*/
|
|
1248
1414
|
DataSetId: string | undefined;
|
|
1249
1415
|
/**
|
|
1416
|
+
* @public
|
|
1250
1417
|
* <p>Encryption configuration of the export job.</p>
|
|
1251
1418
|
*/
|
|
1252
1419
|
Encryption?: ExportServerSideEncryption;
|
|
1253
1420
|
/**
|
|
1421
|
+
* @public
|
|
1254
1422
|
* <p>The unique identifier for the revision associated with this export response.</p>
|
|
1255
1423
|
*/
|
|
1256
1424
|
RevisionId: string | undefined;
|
|
@@ -1261,22 +1429,27 @@ export interface ExportAssetsToS3ResponseDetails {
|
|
|
1261
1429
|
*/
|
|
1262
1430
|
export interface ExportAssetToSignedUrlResponseDetails {
|
|
1263
1431
|
/**
|
|
1432
|
+
* @public
|
|
1264
1433
|
* <p>The unique identifier for the asset associated with this export job.</p>
|
|
1265
1434
|
*/
|
|
1266
1435
|
AssetId: string | undefined;
|
|
1267
1436
|
/**
|
|
1437
|
+
* @public
|
|
1268
1438
|
* <p>The unique identifier for the data set associated with this export job.</p>
|
|
1269
1439
|
*/
|
|
1270
1440
|
DataSetId: string | undefined;
|
|
1271
1441
|
/**
|
|
1442
|
+
* @public
|
|
1272
1443
|
* <p>The unique identifier for the revision associated with this export response.</p>
|
|
1273
1444
|
*/
|
|
1274
1445
|
RevisionId: string | undefined;
|
|
1275
1446
|
/**
|
|
1447
|
+
* @public
|
|
1276
1448
|
* <p>The signed URL for the export request.</p>
|
|
1277
1449
|
*/
|
|
1278
1450
|
SignedUrl?: string;
|
|
1279
1451
|
/**
|
|
1452
|
+
* @public
|
|
1280
1453
|
* <p>The date and time that the signed URL expires, in ISO 8601 format.</p>
|
|
1281
1454
|
*/
|
|
1282
1455
|
SignedUrlExpiresAt?: Date;
|
|
@@ -1287,18 +1460,22 @@ export interface ExportAssetToSignedUrlResponseDetails {
|
|
|
1287
1460
|
*/
|
|
1288
1461
|
export interface ExportRevisionsToS3ResponseDetails {
|
|
1289
1462
|
/**
|
|
1463
|
+
* @public
|
|
1290
1464
|
* <p>The unique identifier for the data set associated with this export job.</p>
|
|
1291
1465
|
*/
|
|
1292
1466
|
DataSetId: string | undefined;
|
|
1293
1467
|
/**
|
|
1468
|
+
* @public
|
|
1294
1469
|
* <p>Encryption configuration of the export job.</p>
|
|
1295
1470
|
*/
|
|
1296
1471
|
Encryption?: ExportServerSideEncryption;
|
|
1297
1472
|
/**
|
|
1473
|
+
* @public
|
|
1298
1474
|
* <p>The destination in Amazon S3 where the revision is exported.</p>
|
|
1299
1475
|
*/
|
|
1300
1476
|
RevisionDestinations: RevisionDestinationEntry[] | undefined;
|
|
1301
1477
|
/**
|
|
1478
|
+
* @public
|
|
1302
1479
|
* <p>The Amazon Resource Name (ARN) of the event action.</p>
|
|
1303
1480
|
*/
|
|
1304
1481
|
EventActionArn?: string;
|
|
@@ -1309,46 +1486,57 @@ export interface ExportRevisionsToS3ResponseDetails {
|
|
|
1309
1486
|
*/
|
|
1310
1487
|
export interface ImportAssetFromApiGatewayApiResponseDetails {
|
|
1311
1488
|
/**
|
|
1489
|
+
* @public
|
|
1312
1490
|
* <p>The API description.</p>
|
|
1313
1491
|
*/
|
|
1314
1492
|
ApiDescription?: string;
|
|
1315
1493
|
/**
|
|
1494
|
+
* @public
|
|
1316
1495
|
* <p>The API ID.</p>
|
|
1317
1496
|
*/
|
|
1318
1497
|
ApiId: string | undefined;
|
|
1319
1498
|
/**
|
|
1499
|
+
* @public
|
|
1320
1500
|
* <p>The API key.</p>
|
|
1321
1501
|
*/
|
|
1322
1502
|
ApiKey?: string;
|
|
1323
1503
|
/**
|
|
1504
|
+
* @public
|
|
1324
1505
|
* <p>The API name.</p>
|
|
1325
1506
|
*/
|
|
1326
1507
|
ApiName: string | undefined;
|
|
1327
1508
|
/**
|
|
1509
|
+
* @public
|
|
1328
1510
|
* <p>The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location.</p>
|
|
1329
1511
|
*/
|
|
1330
1512
|
ApiSpecificationMd5Hash: string | undefined;
|
|
1331
1513
|
/**
|
|
1514
|
+
* @public
|
|
1332
1515
|
* <p>The upload URL of the API specification.</p>
|
|
1333
1516
|
*/
|
|
1334
1517
|
ApiSpecificationUploadUrl: string | undefined;
|
|
1335
1518
|
/**
|
|
1519
|
+
* @public
|
|
1336
1520
|
* <p>The date and time that the upload URL expires, in ISO 8601 format.</p>
|
|
1337
1521
|
*/
|
|
1338
1522
|
ApiSpecificationUploadUrlExpiresAt: Date | undefined;
|
|
1339
1523
|
/**
|
|
1524
|
+
* @public
|
|
1340
1525
|
* <p>The data set ID.</p>
|
|
1341
1526
|
*/
|
|
1342
1527
|
DataSetId: string | undefined;
|
|
1343
1528
|
/**
|
|
1529
|
+
* @public
|
|
1344
1530
|
* <p>The protocol type.</p>
|
|
1345
1531
|
*/
|
|
1346
1532
|
ProtocolType: ProtocolType | string | undefined;
|
|
1347
1533
|
/**
|
|
1534
|
+
* @public
|
|
1348
1535
|
* <p>The revision ID.</p>
|
|
1349
1536
|
*/
|
|
1350
1537
|
RevisionId: string | undefined;
|
|
1351
1538
|
/**
|
|
1539
|
+
* @public
|
|
1352
1540
|
* <p>The API stage.</p>
|
|
1353
1541
|
*/
|
|
1354
1542
|
Stage: string | undefined;
|
|
@@ -1359,26 +1547,32 @@ export interface ImportAssetFromApiGatewayApiResponseDetails {
|
|
|
1359
1547
|
*/
|
|
1360
1548
|
export interface ImportAssetFromSignedUrlResponseDetails {
|
|
1361
1549
|
/**
|
|
1550
|
+
* @public
|
|
1362
1551
|
* <p>The name for the asset associated with this import job.</p>
|
|
1363
1552
|
*/
|
|
1364
1553
|
AssetName: string | undefined;
|
|
1365
1554
|
/**
|
|
1555
|
+
* @public
|
|
1366
1556
|
* <p>The unique identifier for the data set associated with this import job.</p>
|
|
1367
1557
|
*/
|
|
1368
1558
|
DataSetId: string | undefined;
|
|
1369
1559
|
/**
|
|
1560
|
+
* @public
|
|
1370
1561
|
* <p>The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.</p>
|
|
1371
1562
|
*/
|
|
1372
1563
|
Md5Hash?: string;
|
|
1373
1564
|
/**
|
|
1565
|
+
* @public
|
|
1374
1566
|
* <p>The unique identifier for the revision associated with this import response.</p>
|
|
1375
1567
|
*/
|
|
1376
1568
|
RevisionId: string | undefined;
|
|
1377
1569
|
/**
|
|
1570
|
+
* @public
|
|
1378
1571
|
* <p>The signed URL.</p>
|
|
1379
1572
|
*/
|
|
1380
1573
|
SignedUrl?: string;
|
|
1381
1574
|
/**
|
|
1575
|
+
* @public
|
|
1382
1576
|
* <p>The time and date at which the signed URL expires, in ISO 8601 format.</p>
|
|
1383
1577
|
*/
|
|
1384
1578
|
SignedUrlExpiresAt?: Date;
|
|
@@ -1389,26 +1583,32 @@ export interface ImportAssetFromSignedUrlResponseDetails {
|
|
|
1389
1583
|
*/
|
|
1390
1584
|
export interface ImportAssetsFromLakeFormationTagPolicyResponseDetails {
|
|
1391
1585
|
/**
|
|
1586
|
+
* @public
|
|
1392
1587
|
* <p>The identifier for the AWS Glue Data Catalog.</p>
|
|
1393
1588
|
*/
|
|
1394
1589
|
CatalogId: string | undefined;
|
|
1395
1590
|
/**
|
|
1591
|
+
* @public
|
|
1396
1592
|
* <p>A structure for the database object.</p>
|
|
1397
1593
|
*/
|
|
1398
1594
|
Database?: DatabaseLFTagPolicyAndPermissions;
|
|
1399
1595
|
/**
|
|
1596
|
+
* @public
|
|
1400
1597
|
* <p>A structure for the table object.</p>
|
|
1401
1598
|
*/
|
|
1402
1599
|
Table?: TableLFTagPolicyAndPermissions;
|
|
1403
1600
|
/**
|
|
1601
|
+
* @public
|
|
1404
1602
|
* <p>The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke permissions to AWS Lake Formation data permissions.</p>
|
|
1405
1603
|
*/
|
|
1406
1604
|
RoleArn: string | undefined;
|
|
1407
1605
|
/**
|
|
1606
|
+
* @public
|
|
1408
1607
|
* <p>The unique identifier for the data set associated with this import job.</p>
|
|
1409
1608
|
*/
|
|
1410
1609
|
DataSetId: string | undefined;
|
|
1411
1610
|
/**
|
|
1611
|
+
* @public
|
|
1412
1612
|
* <p>The unique identifier for the revision associated with this import job.</p>
|
|
1413
1613
|
*/
|
|
1414
1614
|
RevisionId: string | undefined;
|
|
@@ -1419,14 +1619,17 @@ export interface ImportAssetsFromLakeFormationTagPolicyResponseDetails {
|
|
|
1419
1619
|
*/
|
|
1420
1620
|
export interface ImportAssetsFromRedshiftDataSharesResponseDetails {
|
|
1421
1621
|
/**
|
|
1622
|
+
* @public
|
|
1422
1623
|
* <p>A list of Amazon Redshift datashare asset sources.</p>
|
|
1423
1624
|
*/
|
|
1424
1625
|
AssetSources: RedshiftDataShareAssetSourceEntry[] | undefined;
|
|
1425
1626
|
/**
|
|
1627
|
+
* @public
|
|
1426
1628
|
* <p>The unique identifier for the data set associated with this import job.</p>
|
|
1427
1629
|
*/
|
|
1428
1630
|
DataSetId: string | undefined;
|
|
1429
1631
|
/**
|
|
1632
|
+
* @public
|
|
1430
1633
|
* <p>The unique identifier for the revision associated with this import job.</p>
|
|
1431
1634
|
*/
|
|
1432
1635
|
RevisionId: string | undefined;
|
|
@@ -1437,14 +1640,17 @@ export interface ImportAssetsFromRedshiftDataSharesResponseDetails {
|
|
|
1437
1640
|
*/
|
|
1438
1641
|
export interface ImportAssetsFromS3ResponseDetails {
|
|
1439
1642
|
/**
|
|
1643
|
+
* @public
|
|
1440
1644
|
* <p>Is a list of Amazon S3 bucket and object key pairs.</p>
|
|
1441
1645
|
*/
|
|
1442
1646
|
AssetSources: AssetSourceEntry[] | undefined;
|
|
1443
1647
|
/**
|
|
1648
|
+
* @public
|
|
1444
1649
|
* <p>The unique identifier for the data set associated with this import job.</p>
|
|
1445
1650
|
*/
|
|
1446
1651
|
DataSetId: string | undefined;
|
|
1447
1652
|
/**
|
|
1653
|
+
* @public
|
|
1448
1654
|
* <p>The unique identifier for the revision associated with this import response.</p>
|
|
1449
1655
|
*/
|
|
1450
1656
|
RevisionId: string | undefined;
|
|
@@ -1455,38 +1661,47 @@ export interface ImportAssetsFromS3ResponseDetails {
|
|
|
1455
1661
|
*/
|
|
1456
1662
|
export interface ResponseDetails {
|
|
1457
1663
|
/**
|
|
1664
|
+
* @public
|
|
1458
1665
|
* <p>Details for the export to signed URL response.</p>
|
|
1459
1666
|
*/
|
|
1460
1667
|
ExportAssetToSignedUrl?: ExportAssetToSignedUrlResponseDetails;
|
|
1461
1668
|
/**
|
|
1669
|
+
* @public
|
|
1462
1670
|
* <p>Details for the export to Amazon S3 response.</p>
|
|
1463
1671
|
*/
|
|
1464
1672
|
ExportAssetsToS3?: ExportAssetsToS3ResponseDetails;
|
|
1465
1673
|
/**
|
|
1674
|
+
* @public
|
|
1466
1675
|
* <p>Details for the export revisions to Amazon S3 response.</p>
|
|
1467
1676
|
*/
|
|
1468
1677
|
ExportRevisionsToS3?: ExportRevisionsToS3ResponseDetails;
|
|
1469
1678
|
/**
|
|
1679
|
+
* @public
|
|
1470
1680
|
* <p>Details for the import from signed URL response.</p>
|
|
1471
1681
|
*/
|
|
1472
1682
|
ImportAssetFromSignedUrl?: ImportAssetFromSignedUrlResponseDetails;
|
|
1473
1683
|
/**
|
|
1684
|
+
* @public
|
|
1474
1685
|
* <p>Details for the import from Amazon S3 response.</p>
|
|
1475
1686
|
*/
|
|
1476
1687
|
ImportAssetsFromS3?: ImportAssetsFromS3ResponseDetails;
|
|
1477
1688
|
/**
|
|
1689
|
+
* @public
|
|
1478
1690
|
* <p>Details from an import from Amazon Redshift datashare response.</p>
|
|
1479
1691
|
*/
|
|
1480
1692
|
ImportAssetsFromRedshiftDataShares?: ImportAssetsFromRedshiftDataSharesResponseDetails;
|
|
1481
1693
|
/**
|
|
1694
|
+
* @public
|
|
1482
1695
|
* <p>The response details.</p>
|
|
1483
1696
|
*/
|
|
1484
1697
|
ImportAssetFromApiGatewayApi?: ImportAssetFromApiGatewayApiResponseDetails;
|
|
1485
1698
|
/**
|
|
1699
|
+
* @public
|
|
1486
1700
|
* <p>Response details from the CreateS3DataAccessFromS3Bucket job.</p>
|
|
1487
1701
|
*/
|
|
1488
1702
|
CreateS3DataAccessFromS3Bucket?: CreateS3DataAccessFromS3BucketResponseDetails;
|
|
1489
1703
|
/**
|
|
1704
|
+
* @public
|
|
1490
1705
|
* <p>Response details from the ImportAssetsFromLakeFormationTagPolicy job.</p>
|
|
1491
1706
|
*/
|
|
1492
1707
|
ImportAssetsFromLakeFormationTagPolicy?: ImportAssetsFromLakeFormationTagPolicyResponseDetails;
|
|
@@ -1497,6 +1712,7 @@ export interface ResponseDetails {
|
|
|
1497
1712
|
*/
|
|
1498
1713
|
export interface ImportAssetFromSignedUrlJobErrorDetails {
|
|
1499
1714
|
/**
|
|
1715
|
+
* @public
|
|
1500
1716
|
* <p>Details about the job error.</p>
|
|
1501
1717
|
*/
|
|
1502
1718
|
AssetName: string | undefined;
|
|
@@ -1507,10 +1723,12 @@ export interface ImportAssetFromSignedUrlJobErrorDetails {
|
|
|
1507
1723
|
*/
|
|
1508
1724
|
export interface Details {
|
|
1509
1725
|
/**
|
|
1726
|
+
* @public
|
|
1510
1727
|
* <p>Information about the job error.</p>
|
|
1511
1728
|
*/
|
|
1512
1729
|
ImportAssetFromSignedUrlJobErrorDetails?: ImportAssetFromSignedUrlJobErrorDetails;
|
|
1513
1730
|
/**
|
|
1731
|
+
* @public
|
|
1514
1732
|
* <p>Details about the job error.</p>
|
|
1515
1733
|
*/
|
|
1516
1734
|
ImportAssetsFromS3JobErrorDetails?: AssetSourceEntry[];
|
|
@@ -1549,30 +1767,37 @@ export type JobErrorResourceTypes = (typeof JobErrorResourceTypes)[keyof typeof
|
|
|
1549
1767
|
*/
|
|
1550
1768
|
export interface JobError {
|
|
1551
1769
|
/**
|
|
1770
|
+
* @public
|
|
1552
1771
|
* <p>The code for the job error.</p>
|
|
1553
1772
|
*/
|
|
1554
1773
|
Code: Code | string | undefined;
|
|
1555
1774
|
/**
|
|
1775
|
+
* @public
|
|
1556
1776
|
* <p>The details about the job error.</p>
|
|
1557
1777
|
*/
|
|
1558
1778
|
Details?: Details;
|
|
1559
1779
|
/**
|
|
1780
|
+
* @public
|
|
1560
1781
|
* <p>The name of the limit that was reached.</p>
|
|
1561
1782
|
*/
|
|
1562
1783
|
LimitName?: JobErrorLimitName | string;
|
|
1563
1784
|
/**
|
|
1785
|
+
* @public
|
|
1564
1786
|
* <p>The value of the exceeded limit.</p>
|
|
1565
1787
|
*/
|
|
1566
1788
|
LimitValue?: number;
|
|
1567
1789
|
/**
|
|
1790
|
+
* @public
|
|
1568
1791
|
* <p>The message related to the job error.</p>
|
|
1569
1792
|
*/
|
|
1570
1793
|
Message: string | undefined;
|
|
1571
1794
|
/**
|
|
1795
|
+
* @public
|
|
1572
1796
|
* <p>The unique identifier for the resource related to the error.</p>
|
|
1573
1797
|
*/
|
|
1574
1798
|
ResourceId?: string;
|
|
1575
1799
|
/**
|
|
1800
|
+
* @public
|
|
1576
1801
|
* <p>The type of resource related to the error.</p>
|
|
1577
1802
|
*/
|
|
1578
1803
|
ResourceType?: JobErrorResourceTypes | string;
|
|
@@ -1598,34 +1823,42 @@ export type State = (typeof State)[keyof typeof State];
|
|
|
1598
1823
|
*/
|
|
1599
1824
|
export interface CreateJobResponse {
|
|
1600
1825
|
/**
|
|
1826
|
+
* @public
|
|
1601
1827
|
* <p>The ARN for the job.</p>
|
|
1602
1828
|
*/
|
|
1603
1829
|
Arn?: string;
|
|
1604
1830
|
/**
|
|
1831
|
+
* @public
|
|
1605
1832
|
* <p>The date and time that the job was created, in ISO 8601 format.</p>
|
|
1606
1833
|
*/
|
|
1607
1834
|
CreatedAt?: Date;
|
|
1608
1835
|
/**
|
|
1836
|
+
* @public
|
|
1609
1837
|
* <p>Details about the job.</p>
|
|
1610
1838
|
*/
|
|
1611
1839
|
Details?: ResponseDetails;
|
|
1612
1840
|
/**
|
|
1841
|
+
* @public
|
|
1613
1842
|
* <p>The errors associated with jobs.</p>
|
|
1614
1843
|
*/
|
|
1615
1844
|
Errors?: JobError[];
|
|
1616
1845
|
/**
|
|
1846
|
+
* @public
|
|
1617
1847
|
* <p>The unique identifier for the job.</p>
|
|
1618
1848
|
*/
|
|
1619
1849
|
Id?: string;
|
|
1620
1850
|
/**
|
|
1851
|
+
* @public
|
|
1621
1852
|
* <p>The state of the job.</p>
|
|
1622
1853
|
*/
|
|
1623
1854
|
State?: State | string;
|
|
1624
1855
|
/**
|
|
1856
|
+
* @public
|
|
1625
1857
|
* <p>The job type.</p>
|
|
1626
1858
|
*/
|
|
1627
1859
|
Type?: Type | string;
|
|
1628
1860
|
/**
|
|
1861
|
+
* @public
|
|
1629
1862
|
* <p>The date and time that the job was last updated, in ISO 8601 format.</p>
|
|
1630
1863
|
*/
|
|
1631
1864
|
UpdatedAt?: Date;
|
|
@@ -1635,14 +1868,17 @@ export interface CreateJobResponse {
|
|
|
1635
1868
|
*/
|
|
1636
1869
|
export interface CreateRevisionRequest {
|
|
1637
1870
|
/**
|
|
1871
|
+
* @public
|
|
1638
1872
|
* <p>An optional comment about the revision.</p>
|
|
1639
1873
|
*/
|
|
1640
1874
|
Comment?: string;
|
|
1641
1875
|
/**
|
|
1876
|
+
* @public
|
|
1642
1877
|
* <p>The unique identifier for a data set.</p>
|
|
1643
1878
|
*/
|
|
1644
1879
|
DataSetId: string | undefined;
|
|
1645
1880
|
/**
|
|
1881
|
+
* @public
|
|
1646
1882
|
* <p>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.</p>
|
|
1647
1883
|
*/
|
|
1648
1884
|
Tags?: Record<string, string>;
|
|
@@ -1652,50 +1888,62 @@ export interface CreateRevisionRequest {
|
|
|
1652
1888
|
*/
|
|
1653
1889
|
export interface CreateRevisionResponse {
|
|
1654
1890
|
/**
|
|
1891
|
+
* @public
|
|
1655
1892
|
* <p>The ARN for the revision.</p>
|
|
1656
1893
|
*/
|
|
1657
1894
|
Arn?: string;
|
|
1658
1895
|
/**
|
|
1896
|
+
* @public
|
|
1659
1897
|
* <p>An optional comment about the revision.</p>
|
|
1660
1898
|
*/
|
|
1661
1899
|
Comment?: string;
|
|
1662
1900
|
/**
|
|
1901
|
+
* @public
|
|
1663
1902
|
* <p>The date and time that the revision was created, in ISO 8601 format.</p>
|
|
1664
1903
|
*/
|
|
1665
1904
|
CreatedAt?: Date;
|
|
1666
1905
|
/**
|
|
1906
|
+
* @public
|
|
1667
1907
|
* <p>The unique identifier for the data set associated with the data set revision.</p>
|
|
1668
1908
|
*/
|
|
1669
1909
|
DataSetId?: string;
|
|
1670
1910
|
/**
|
|
1911
|
+
* @public
|
|
1671
1912
|
* <p>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.</p>
|
|
1672
1913
|
*/
|
|
1673
1914
|
Finalized?: boolean;
|
|
1674
1915
|
/**
|
|
1916
|
+
* @public
|
|
1675
1917
|
* <p>The unique identifier for the revision.</p>
|
|
1676
1918
|
*/
|
|
1677
1919
|
Id?: string;
|
|
1678
1920
|
/**
|
|
1921
|
+
* @public
|
|
1679
1922
|
* <p>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.</p>
|
|
1680
1923
|
*/
|
|
1681
1924
|
SourceId?: string;
|
|
1682
1925
|
/**
|
|
1926
|
+
* @public
|
|
1683
1927
|
* <p>The tags for the revision.</p>
|
|
1684
1928
|
*/
|
|
1685
1929
|
Tags?: Record<string, string>;
|
|
1686
1930
|
/**
|
|
1931
|
+
* @public
|
|
1687
1932
|
* <p>The date and time that the revision was last updated, in ISO 8601 format.</p>
|
|
1688
1933
|
*/
|
|
1689
1934
|
UpdatedAt?: Date;
|
|
1690
1935
|
/**
|
|
1936
|
+
* @public
|
|
1691
1937
|
* <p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>
|
|
1692
1938
|
*/
|
|
1693
1939
|
RevocationComment?: string;
|
|
1694
1940
|
/**
|
|
1941
|
+
* @public
|
|
1695
1942
|
* <p>A status indicating that subscribers' access to the revision was revoked.</p>
|
|
1696
1943
|
*/
|
|
1697
1944
|
Revoked?: boolean;
|
|
1698
1945
|
/**
|
|
1946
|
+
* @public
|
|
1699
1947
|
* <p>The date and time that the revision was revoked, in ISO 8601 format.</p>
|
|
1700
1948
|
*/
|
|
1701
1949
|
RevokedAt?: Date;
|
|
@@ -1705,14 +1953,17 @@ export interface CreateRevisionResponse {
|
|
|
1705
1953
|
*/
|
|
1706
1954
|
export interface DeleteAssetRequest {
|
|
1707
1955
|
/**
|
|
1956
|
+
* @public
|
|
1708
1957
|
* <p>The unique identifier for an asset.</p>
|
|
1709
1958
|
*/
|
|
1710
1959
|
AssetId: string | undefined;
|
|
1711
1960
|
/**
|
|
1961
|
+
* @public
|
|
1712
1962
|
* <p>The unique identifier for a data set.</p>
|
|
1713
1963
|
*/
|
|
1714
1964
|
DataSetId: string | undefined;
|
|
1715
1965
|
/**
|
|
1966
|
+
* @public
|
|
1716
1967
|
* <p>The unique identifier for a revision.</p>
|
|
1717
1968
|
*/
|
|
1718
1969
|
RevisionId: string | undefined;
|
|
@@ -1722,6 +1973,7 @@ export interface DeleteAssetRequest {
|
|
|
1722
1973
|
*/
|
|
1723
1974
|
export interface DeleteDataSetRequest {
|
|
1724
1975
|
/**
|
|
1976
|
+
* @public
|
|
1725
1977
|
* <p>The unique identifier for a data set.</p>
|
|
1726
1978
|
*/
|
|
1727
1979
|
DataSetId: string | undefined;
|
|
@@ -1731,6 +1983,7 @@ export interface DeleteDataSetRequest {
|
|
|
1731
1983
|
*/
|
|
1732
1984
|
export interface DeleteEventActionRequest {
|
|
1733
1985
|
/**
|
|
1986
|
+
* @public
|
|
1734
1987
|
* <p>The unique identifier for the event action.</p>
|
|
1735
1988
|
*/
|
|
1736
1989
|
EventActionId: string | undefined;
|
|
@@ -1740,10 +1993,12 @@ export interface DeleteEventActionRequest {
|
|
|
1740
1993
|
*/
|
|
1741
1994
|
export interface DeleteRevisionRequest {
|
|
1742
1995
|
/**
|
|
1996
|
+
* @public
|
|
1743
1997
|
* <p>The unique identifier for a data set.</p>
|
|
1744
1998
|
*/
|
|
1745
1999
|
DataSetId: string | undefined;
|
|
1746
2000
|
/**
|
|
2001
|
+
* @public
|
|
1747
2002
|
* <p>The unique identifier for a revision.</p>
|
|
1748
2003
|
*/
|
|
1749
2004
|
RevisionId: string | undefined;
|
|
@@ -1753,14 +2008,17 @@ export interface DeleteRevisionRequest {
|
|
|
1753
2008
|
*/
|
|
1754
2009
|
export interface GetAssetRequest {
|
|
1755
2010
|
/**
|
|
2011
|
+
* @public
|
|
1756
2012
|
* <p>The unique identifier for an asset.</p>
|
|
1757
2013
|
*/
|
|
1758
2014
|
AssetId: string | undefined;
|
|
1759
2015
|
/**
|
|
2016
|
+
* @public
|
|
1760
2017
|
* <p>The unique identifier for a data set.</p>
|
|
1761
2018
|
*/
|
|
1762
2019
|
DataSetId: string | undefined;
|
|
1763
2020
|
/**
|
|
2021
|
+
* @public
|
|
1764
2022
|
* <p>The unique identifier for a revision.</p>
|
|
1765
2023
|
*/
|
|
1766
2024
|
RevisionId: string | undefined;
|
|
@@ -1770,30 +2028,37 @@ export interface GetAssetRequest {
|
|
|
1770
2028
|
*/
|
|
1771
2029
|
export interface GetAssetResponse {
|
|
1772
2030
|
/**
|
|
2031
|
+
* @public
|
|
1773
2032
|
* <p>The ARN for the asset.</p>
|
|
1774
2033
|
*/
|
|
1775
2034
|
Arn?: string;
|
|
1776
2035
|
/**
|
|
2036
|
+
* @public
|
|
1777
2037
|
* <p>Details about the asset.</p>
|
|
1778
2038
|
*/
|
|
1779
2039
|
AssetDetails?: AssetDetails;
|
|
1780
2040
|
/**
|
|
2041
|
+
* @public
|
|
1781
2042
|
* <p>The type of asset that is added to a data set.</p>
|
|
1782
2043
|
*/
|
|
1783
2044
|
AssetType?: AssetType | string;
|
|
1784
2045
|
/**
|
|
2046
|
+
* @public
|
|
1785
2047
|
* <p>The date and time that the asset was created, in ISO 8601 format.</p>
|
|
1786
2048
|
*/
|
|
1787
2049
|
CreatedAt?: Date;
|
|
1788
2050
|
/**
|
|
2051
|
+
* @public
|
|
1789
2052
|
* <p>The unique identifier for the data set associated with this asset.</p>
|
|
1790
2053
|
*/
|
|
1791
2054
|
DataSetId?: string;
|
|
1792
2055
|
/**
|
|
2056
|
+
* @public
|
|
1793
2057
|
* <p>The unique identifier for the asset.</p>
|
|
1794
2058
|
*/
|
|
1795
2059
|
Id?: string;
|
|
1796
2060
|
/**
|
|
2061
|
+
* @public
|
|
1797
2062
|
* <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used
|
|
1798
2063
|
* as the asset name. When exporting to Amazon S3, the asset name is used as default target
|
|
1799
2064
|
* Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as
|
|
@@ -1804,14 +2069,17 @@ export interface GetAssetResponse {
|
|
|
1804
2069
|
*/
|
|
1805
2070
|
Name?: string;
|
|
1806
2071
|
/**
|
|
2072
|
+
* @public
|
|
1807
2073
|
* <p>The unique identifier for the revision associated with this asset.</p>
|
|
1808
2074
|
*/
|
|
1809
2075
|
RevisionId?: string;
|
|
1810
2076
|
/**
|
|
2077
|
+
* @public
|
|
1811
2078
|
* <p>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.</p>
|
|
1812
2079
|
*/
|
|
1813
2080
|
SourceId?: string;
|
|
1814
2081
|
/**
|
|
2082
|
+
* @public
|
|
1815
2083
|
* <p>The date and time that the asset was last updated, in ISO 8601 format.</p>
|
|
1816
2084
|
*/
|
|
1817
2085
|
UpdatedAt?: Date;
|
|
@@ -1821,6 +2089,7 @@ export interface GetAssetResponse {
|
|
|
1821
2089
|
*/
|
|
1822
2090
|
export interface GetDataSetRequest {
|
|
1823
2091
|
/**
|
|
2092
|
+
* @public
|
|
1824
2093
|
* <p>The unique identifier for a data set.</p>
|
|
1825
2094
|
*/
|
|
1826
2095
|
DataSetId: string | undefined;
|
|
@@ -1830,46 +2099,57 @@ export interface GetDataSetRequest {
|
|
|
1830
2099
|
*/
|
|
1831
2100
|
export interface GetDataSetResponse {
|
|
1832
2101
|
/**
|
|
2102
|
+
* @public
|
|
1833
2103
|
* <p>The ARN for the data set.</p>
|
|
1834
2104
|
*/
|
|
1835
2105
|
Arn?: string;
|
|
1836
2106
|
/**
|
|
2107
|
+
* @public
|
|
1837
2108
|
* <p>The type of asset that is added to a data set.</p>
|
|
1838
2109
|
*/
|
|
1839
2110
|
AssetType?: AssetType | string;
|
|
1840
2111
|
/**
|
|
2112
|
+
* @public
|
|
1841
2113
|
* <p>The date and time that the data set was created, in ISO 8601 format.</p>
|
|
1842
2114
|
*/
|
|
1843
2115
|
CreatedAt?: Date;
|
|
1844
2116
|
/**
|
|
2117
|
+
* @public
|
|
1845
2118
|
* <p>The description for the data set.</p>
|
|
1846
2119
|
*/
|
|
1847
2120
|
Description?: string;
|
|
1848
2121
|
/**
|
|
2122
|
+
* @public
|
|
1849
2123
|
* <p>The unique identifier for the data set.</p>
|
|
1850
2124
|
*/
|
|
1851
2125
|
Id?: string;
|
|
1852
2126
|
/**
|
|
2127
|
+
* @public
|
|
1853
2128
|
* <p>The name of the data set.</p>
|
|
1854
2129
|
*/
|
|
1855
2130
|
Name?: string;
|
|
1856
2131
|
/**
|
|
2132
|
+
* @public
|
|
1857
2133
|
* <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).</p>
|
|
1858
2134
|
*/
|
|
1859
2135
|
Origin?: Origin | string;
|
|
1860
2136
|
/**
|
|
2137
|
+
* @public
|
|
1861
2138
|
* <p>If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.</p>
|
|
1862
2139
|
*/
|
|
1863
2140
|
OriginDetails?: OriginDetails;
|
|
1864
2141
|
/**
|
|
2142
|
+
* @public
|
|
1865
2143
|
* <p>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.</p>
|
|
1866
2144
|
*/
|
|
1867
2145
|
SourceId?: string;
|
|
1868
2146
|
/**
|
|
2147
|
+
* @public
|
|
1869
2148
|
* <p>The tags for the data set.</p>
|
|
1870
2149
|
*/
|
|
1871
2150
|
Tags?: Record<string, string>;
|
|
1872
2151
|
/**
|
|
2152
|
+
* @public
|
|
1873
2153
|
* <p>The date and time that the data set was last updated, in ISO 8601 format.</p>
|
|
1874
2154
|
*/
|
|
1875
2155
|
UpdatedAt?: Date;
|
|
@@ -1879,6 +2159,7 @@ export interface GetDataSetResponse {
|
|
|
1879
2159
|
*/
|
|
1880
2160
|
export interface GetEventActionRequest {
|
|
1881
2161
|
/**
|
|
2162
|
+
* @public
|
|
1882
2163
|
* <p>The unique identifier for the event action.</p>
|
|
1883
2164
|
*/
|
|
1884
2165
|
EventActionId: string | undefined;
|
|
@@ -1888,26 +2169,32 @@ export interface GetEventActionRequest {
|
|
|
1888
2169
|
*/
|
|
1889
2170
|
export interface GetEventActionResponse {
|
|
1890
2171
|
/**
|
|
2172
|
+
* @public
|
|
1891
2173
|
* <p>What occurs after a certain event.</p>
|
|
1892
2174
|
*/
|
|
1893
2175
|
Action?: Action;
|
|
1894
2176
|
/**
|
|
2177
|
+
* @public
|
|
1895
2178
|
* <p>The ARN for the event action.</p>
|
|
1896
2179
|
*/
|
|
1897
2180
|
Arn?: string;
|
|
1898
2181
|
/**
|
|
2182
|
+
* @public
|
|
1899
2183
|
* <p>The date and time that the event action was created, in ISO 8601 format.</p>
|
|
1900
2184
|
*/
|
|
1901
2185
|
CreatedAt?: Date;
|
|
1902
2186
|
/**
|
|
2187
|
+
* @public
|
|
1903
2188
|
* <p>What occurs to start an action.</p>
|
|
1904
2189
|
*/
|
|
1905
2190
|
Event?: Event;
|
|
1906
2191
|
/**
|
|
2192
|
+
* @public
|
|
1907
2193
|
* <p>The unique identifier for the event action.</p>
|
|
1908
2194
|
*/
|
|
1909
2195
|
Id?: string;
|
|
1910
2196
|
/**
|
|
2197
|
+
* @public
|
|
1911
2198
|
* <p>The date and time that the event action was last updated, in ISO 8601 format.</p>
|
|
1912
2199
|
*/
|
|
1913
2200
|
UpdatedAt?: Date;
|
|
@@ -1917,6 +2204,7 @@ export interface GetEventActionResponse {
|
|
|
1917
2204
|
*/
|
|
1918
2205
|
export interface GetJobRequest {
|
|
1919
2206
|
/**
|
|
2207
|
+
* @public
|
|
1920
2208
|
* <p>The unique identifier for a job.</p>
|
|
1921
2209
|
*/
|
|
1922
2210
|
JobId: string | undefined;
|
|
@@ -1926,34 +2214,42 @@ export interface GetJobRequest {
|
|
|
1926
2214
|
*/
|
|
1927
2215
|
export interface GetJobResponse {
|
|
1928
2216
|
/**
|
|
2217
|
+
* @public
|
|
1929
2218
|
* <p>The ARN for the job.</p>
|
|
1930
2219
|
*/
|
|
1931
2220
|
Arn?: string;
|
|
1932
2221
|
/**
|
|
2222
|
+
* @public
|
|
1933
2223
|
* <p>The date and time that the job was created, in ISO 8601 format.</p>
|
|
1934
2224
|
*/
|
|
1935
2225
|
CreatedAt?: Date;
|
|
1936
2226
|
/**
|
|
2227
|
+
* @public
|
|
1937
2228
|
* <p>Details about the job.</p>
|
|
1938
2229
|
*/
|
|
1939
2230
|
Details?: ResponseDetails;
|
|
1940
2231
|
/**
|
|
2232
|
+
* @public
|
|
1941
2233
|
* <p>The errors associated with jobs.</p>
|
|
1942
2234
|
*/
|
|
1943
2235
|
Errors?: JobError[];
|
|
1944
2236
|
/**
|
|
2237
|
+
* @public
|
|
1945
2238
|
* <p>The unique identifier for the job.</p>
|
|
1946
2239
|
*/
|
|
1947
2240
|
Id?: string;
|
|
1948
2241
|
/**
|
|
2242
|
+
* @public
|
|
1949
2243
|
* <p>The state of the job.</p>
|
|
1950
2244
|
*/
|
|
1951
2245
|
State?: State | string;
|
|
1952
2246
|
/**
|
|
2247
|
+
* @public
|
|
1953
2248
|
* <p>The job type.</p>
|
|
1954
2249
|
*/
|
|
1955
2250
|
Type?: Type | string;
|
|
1956
2251
|
/**
|
|
2252
|
+
* @public
|
|
1957
2253
|
* <p>The date and time that the job was last updated, in ISO 8601 format.</p>
|
|
1958
2254
|
*/
|
|
1959
2255
|
UpdatedAt?: Date;
|
|
@@ -1963,10 +2259,12 @@ export interface GetJobResponse {
|
|
|
1963
2259
|
*/
|
|
1964
2260
|
export interface GetRevisionRequest {
|
|
1965
2261
|
/**
|
|
2262
|
+
* @public
|
|
1966
2263
|
* <p>The unique identifier for a data set.</p>
|
|
1967
2264
|
*/
|
|
1968
2265
|
DataSetId: string | undefined;
|
|
1969
2266
|
/**
|
|
2267
|
+
* @public
|
|
1970
2268
|
* <p>The unique identifier for a revision.</p>
|
|
1971
2269
|
*/
|
|
1972
2270
|
RevisionId: string | undefined;
|
|
@@ -1976,50 +2274,62 @@ export interface GetRevisionRequest {
|
|
|
1976
2274
|
*/
|
|
1977
2275
|
export interface GetRevisionResponse {
|
|
1978
2276
|
/**
|
|
2277
|
+
* @public
|
|
1979
2278
|
* <p>The ARN for the revision.</p>
|
|
1980
2279
|
*/
|
|
1981
2280
|
Arn?: string;
|
|
1982
2281
|
/**
|
|
2282
|
+
* @public
|
|
1983
2283
|
* <p>An optional comment about the revision.</p>
|
|
1984
2284
|
*/
|
|
1985
2285
|
Comment?: string;
|
|
1986
2286
|
/**
|
|
2287
|
+
* @public
|
|
1987
2288
|
* <p>The date and time that the revision was created, in ISO 8601 format.</p>
|
|
1988
2289
|
*/
|
|
1989
2290
|
CreatedAt?: Date;
|
|
1990
2291
|
/**
|
|
2292
|
+
* @public
|
|
1991
2293
|
* <p>The unique identifier for the data set associated with the data set revision.</p>
|
|
1992
2294
|
*/
|
|
1993
2295
|
DataSetId?: string;
|
|
1994
2296
|
/**
|
|
2297
|
+
* @public
|
|
1995
2298
|
* <p>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.</p>
|
|
1996
2299
|
*/
|
|
1997
2300
|
Finalized?: boolean;
|
|
1998
2301
|
/**
|
|
2302
|
+
* @public
|
|
1999
2303
|
* <p>The unique identifier for the revision.</p>
|
|
2000
2304
|
*/
|
|
2001
2305
|
Id?: string;
|
|
2002
2306
|
/**
|
|
2307
|
+
* @public
|
|
2003
2308
|
* <p>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.</p>
|
|
2004
2309
|
*/
|
|
2005
2310
|
SourceId?: string;
|
|
2006
2311
|
/**
|
|
2312
|
+
* @public
|
|
2007
2313
|
* <p>The tags for the revision.</p>
|
|
2008
2314
|
*/
|
|
2009
2315
|
Tags?: Record<string, string>;
|
|
2010
2316
|
/**
|
|
2317
|
+
* @public
|
|
2011
2318
|
* <p>The date and time that the revision was last updated, in ISO 8601 format.</p>
|
|
2012
2319
|
*/
|
|
2013
2320
|
UpdatedAt?: Date;
|
|
2014
2321
|
/**
|
|
2322
|
+
* @public
|
|
2015
2323
|
* <p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>
|
|
2016
2324
|
*/
|
|
2017
2325
|
RevocationComment?: string;
|
|
2018
2326
|
/**
|
|
2327
|
+
* @public
|
|
2019
2328
|
* <p>A status indicating that subscribers' access to the revision was revoked.</p>
|
|
2020
2329
|
*/
|
|
2021
2330
|
Revoked?: boolean;
|
|
2022
2331
|
/**
|
|
2332
|
+
* @public
|
|
2023
2333
|
* <p>The date and time that the revision was revoked, in ISO 8601 format.</p>
|
|
2024
2334
|
*/
|
|
2025
2335
|
RevokedAt?: Date;
|
|
@@ -2029,14 +2339,17 @@ export interface GetRevisionResponse {
|
|
|
2029
2339
|
*/
|
|
2030
2340
|
export interface ListDataSetRevisionsRequest {
|
|
2031
2341
|
/**
|
|
2342
|
+
* @public
|
|
2032
2343
|
* <p>The unique identifier for a data set.</p>
|
|
2033
2344
|
*/
|
|
2034
2345
|
DataSetId: string | undefined;
|
|
2035
2346
|
/**
|
|
2347
|
+
* @public
|
|
2036
2348
|
* <p>The maximum number of results returned by a single call.</p>
|
|
2037
2349
|
*/
|
|
2038
2350
|
MaxResults?: number;
|
|
2039
2351
|
/**
|
|
2352
|
+
* @public
|
|
2040
2353
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2041
2354
|
*/
|
|
2042
2355
|
NextToken?: string;
|
|
@@ -2047,46 +2360,57 @@ export interface ListDataSetRevisionsRequest {
|
|
|
2047
2360
|
*/
|
|
2048
2361
|
export interface RevisionEntry {
|
|
2049
2362
|
/**
|
|
2363
|
+
* @public
|
|
2050
2364
|
* <p>The ARN for the revision.</p>
|
|
2051
2365
|
*/
|
|
2052
2366
|
Arn: string | undefined;
|
|
2053
2367
|
/**
|
|
2368
|
+
* @public
|
|
2054
2369
|
* <p>An optional comment about the revision.</p>
|
|
2055
2370
|
*/
|
|
2056
2371
|
Comment?: string;
|
|
2057
2372
|
/**
|
|
2373
|
+
* @public
|
|
2058
2374
|
* <p>The date and time that the revision was created, in ISO 8601 format.</p>
|
|
2059
2375
|
*/
|
|
2060
2376
|
CreatedAt: Date | undefined;
|
|
2061
2377
|
/**
|
|
2378
|
+
* @public
|
|
2062
2379
|
* <p>The unique identifier for the data set associated with the data set revision.</p>
|
|
2063
2380
|
*/
|
|
2064
2381
|
DataSetId: string | undefined;
|
|
2065
2382
|
/**
|
|
2383
|
+
* @public
|
|
2066
2384
|
* <p>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.</p>
|
|
2067
2385
|
*/
|
|
2068
2386
|
Finalized?: boolean;
|
|
2069
2387
|
/**
|
|
2388
|
+
* @public
|
|
2070
2389
|
* <p>The unique identifier for the revision.</p>
|
|
2071
2390
|
*/
|
|
2072
2391
|
Id: string | undefined;
|
|
2073
2392
|
/**
|
|
2393
|
+
* @public
|
|
2074
2394
|
* <p>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.</p>
|
|
2075
2395
|
*/
|
|
2076
2396
|
SourceId?: string;
|
|
2077
2397
|
/**
|
|
2398
|
+
* @public
|
|
2078
2399
|
* <p>The date and time that the revision was last updated, in ISO 8601 format.</p>
|
|
2079
2400
|
*/
|
|
2080
2401
|
UpdatedAt: Date | undefined;
|
|
2081
2402
|
/**
|
|
2403
|
+
* @public
|
|
2082
2404
|
* <p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>
|
|
2083
2405
|
*/
|
|
2084
2406
|
RevocationComment?: string;
|
|
2085
2407
|
/**
|
|
2408
|
+
* @public
|
|
2086
2409
|
* <p>A status indicating that subscribers' access to the revision was revoked.</p>
|
|
2087
2410
|
*/
|
|
2088
2411
|
Revoked?: boolean;
|
|
2089
2412
|
/**
|
|
2413
|
+
* @public
|
|
2090
2414
|
* <p>The date and time that the revision was revoked, in ISO 8601 format.</p>
|
|
2091
2415
|
*/
|
|
2092
2416
|
RevokedAt?: Date;
|
|
@@ -2096,10 +2420,12 @@ export interface RevisionEntry {
|
|
|
2096
2420
|
*/
|
|
2097
2421
|
export interface ListDataSetRevisionsResponse {
|
|
2098
2422
|
/**
|
|
2423
|
+
* @public
|
|
2099
2424
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2100
2425
|
*/
|
|
2101
2426
|
NextToken?: string;
|
|
2102
2427
|
/**
|
|
2428
|
+
* @public
|
|
2103
2429
|
* <p>The asset objects listed by the request.</p>
|
|
2104
2430
|
*/
|
|
2105
2431
|
Revisions?: RevisionEntry[];
|
|
@@ -2109,14 +2435,17 @@ export interface ListDataSetRevisionsResponse {
|
|
|
2109
2435
|
*/
|
|
2110
2436
|
export interface ListDataSetsRequest {
|
|
2111
2437
|
/**
|
|
2438
|
+
* @public
|
|
2112
2439
|
* <p>The maximum number of results returned by a single call.</p>
|
|
2113
2440
|
*/
|
|
2114
2441
|
MaxResults?: number;
|
|
2115
2442
|
/**
|
|
2443
|
+
* @public
|
|
2116
2444
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2117
2445
|
*/
|
|
2118
2446
|
NextToken?: string;
|
|
2119
2447
|
/**
|
|
2448
|
+
* @public
|
|
2120
2449
|
* <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).</p>
|
|
2121
2450
|
*/
|
|
2122
2451
|
Origin?: string;
|
|
@@ -2127,42 +2456,52 @@ export interface ListDataSetsRequest {
|
|
|
2127
2456
|
*/
|
|
2128
2457
|
export interface DataSetEntry {
|
|
2129
2458
|
/**
|
|
2459
|
+
* @public
|
|
2130
2460
|
* <p>The ARN for the data set.</p>
|
|
2131
2461
|
*/
|
|
2132
2462
|
Arn: string | undefined;
|
|
2133
2463
|
/**
|
|
2464
|
+
* @public
|
|
2134
2465
|
* <p>The type of asset that is added to a data set.</p>
|
|
2135
2466
|
*/
|
|
2136
2467
|
AssetType: AssetType | string | undefined;
|
|
2137
2468
|
/**
|
|
2469
|
+
* @public
|
|
2138
2470
|
* <p>The date and time that the data set was created, in ISO 8601 format.</p>
|
|
2139
2471
|
*/
|
|
2140
2472
|
CreatedAt: Date | undefined;
|
|
2141
2473
|
/**
|
|
2474
|
+
* @public
|
|
2142
2475
|
* <p>The description for the data set.</p>
|
|
2143
2476
|
*/
|
|
2144
2477
|
Description: string | undefined;
|
|
2145
2478
|
/**
|
|
2479
|
+
* @public
|
|
2146
2480
|
* <p>The unique identifier for the data set.</p>
|
|
2147
2481
|
*/
|
|
2148
2482
|
Id: string | undefined;
|
|
2149
2483
|
/**
|
|
2484
|
+
* @public
|
|
2150
2485
|
* <p>The name of the data set.</p>
|
|
2151
2486
|
*/
|
|
2152
2487
|
Name: string | undefined;
|
|
2153
2488
|
/**
|
|
2489
|
+
* @public
|
|
2154
2490
|
* <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).</p>
|
|
2155
2491
|
*/
|
|
2156
2492
|
Origin: Origin | string | undefined;
|
|
2157
2493
|
/**
|
|
2494
|
+
* @public
|
|
2158
2495
|
* <p>If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.</p>
|
|
2159
2496
|
*/
|
|
2160
2497
|
OriginDetails?: OriginDetails;
|
|
2161
2498
|
/**
|
|
2499
|
+
* @public
|
|
2162
2500
|
* <p>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.</p>
|
|
2163
2501
|
*/
|
|
2164
2502
|
SourceId?: string;
|
|
2165
2503
|
/**
|
|
2504
|
+
* @public
|
|
2166
2505
|
* <p>The date and time that the data set was last updated, in ISO 8601 format.</p>
|
|
2167
2506
|
*/
|
|
2168
2507
|
UpdatedAt: Date | undefined;
|
|
@@ -2172,10 +2511,12 @@ export interface DataSetEntry {
|
|
|
2172
2511
|
*/
|
|
2173
2512
|
export interface ListDataSetsResponse {
|
|
2174
2513
|
/**
|
|
2514
|
+
* @public
|
|
2175
2515
|
* <p>The data set objects listed by the request.</p>
|
|
2176
2516
|
*/
|
|
2177
2517
|
DataSets?: DataSetEntry[];
|
|
2178
2518
|
/**
|
|
2519
|
+
* @public
|
|
2179
2520
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2180
2521
|
*/
|
|
2181
2522
|
NextToken?: string;
|
|
@@ -2185,14 +2526,17 @@ export interface ListDataSetsResponse {
|
|
|
2185
2526
|
*/
|
|
2186
2527
|
export interface ListEventActionsRequest {
|
|
2187
2528
|
/**
|
|
2529
|
+
* @public
|
|
2188
2530
|
* <p>The unique identifier for the event source.</p>
|
|
2189
2531
|
*/
|
|
2190
2532
|
EventSourceId?: string;
|
|
2191
2533
|
/**
|
|
2534
|
+
* @public
|
|
2192
2535
|
* <p>The maximum number of results returned by a single call.</p>
|
|
2193
2536
|
*/
|
|
2194
2537
|
MaxResults?: number;
|
|
2195
2538
|
/**
|
|
2539
|
+
* @public
|
|
2196
2540
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2197
2541
|
*/
|
|
2198
2542
|
NextToken?: string;
|
|
@@ -2203,26 +2547,32 @@ export interface ListEventActionsRequest {
|
|
|
2203
2547
|
*/
|
|
2204
2548
|
export interface EventActionEntry {
|
|
2205
2549
|
/**
|
|
2550
|
+
* @public
|
|
2206
2551
|
* <p>What occurs after a certain event.</p>
|
|
2207
2552
|
*/
|
|
2208
2553
|
Action: Action | undefined;
|
|
2209
2554
|
/**
|
|
2555
|
+
* @public
|
|
2210
2556
|
* <p>The Amazon Resource Name (ARN) for the event action.</p>
|
|
2211
2557
|
*/
|
|
2212
2558
|
Arn: string | undefined;
|
|
2213
2559
|
/**
|
|
2560
|
+
* @public
|
|
2214
2561
|
* <p>The date and time that the event action was created, in ISO 8601 format.</p>
|
|
2215
2562
|
*/
|
|
2216
2563
|
CreatedAt: Date | undefined;
|
|
2217
2564
|
/**
|
|
2565
|
+
* @public
|
|
2218
2566
|
* <p>What occurs to start an action.</p>
|
|
2219
2567
|
*/
|
|
2220
2568
|
Event: Event | undefined;
|
|
2221
2569
|
/**
|
|
2570
|
+
* @public
|
|
2222
2571
|
* <p>The unique identifier for the event action.</p>
|
|
2223
2572
|
*/
|
|
2224
2573
|
Id: string | undefined;
|
|
2225
2574
|
/**
|
|
2575
|
+
* @public
|
|
2226
2576
|
* <p>The date and time that the event action was last updated, in ISO 8601 format.</p>
|
|
2227
2577
|
*/
|
|
2228
2578
|
UpdatedAt: Date | undefined;
|
|
@@ -2232,10 +2582,12 @@ export interface EventActionEntry {
|
|
|
2232
2582
|
*/
|
|
2233
2583
|
export interface ListEventActionsResponse {
|
|
2234
2584
|
/**
|
|
2585
|
+
* @public
|
|
2235
2586
|
* <p>The event action objects listed by the request.</p>
|
|
2236
2587
|
*/
|
|
2237
2588
|
EventActions?: EventActionEntry[];
|
|
2238
2589
|
/**
|
|
2590
|
+
* @public
|
|
2239
2591
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2240
2592
|
*/
|
|
2241
2593
|
NextToken?: string;
|
|
@@ -2245,18 +2597,22 @@ export interface ListEventActionsResponse {
|
|
|
2245
2597
|
*/
|
|
2246
2598
|
export interface ListJobsRequest {
|
|
2247
2599
|
/**
|
|
2600
|
+
* @public
|
|
2248
2601
|
* <p>The unique identifier for a data set.</p>
|
|
2249
2602
|
*/
|
|
2250
2603
|
DataSetId?: string;
|
|
2251
2604
|
/**
|
|
2605
|
+
* @public
|
|
2252
2606
|
* <p>The maximum number of results returned by a single call.</p>
|
|
2253
2607
|
*/
|
|
2254
2608
|
MaxResults?: number;
|
|
2255
2609
|
/**
|
|
2610
|
+
* @public
|
|
2256
2611
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2257
2612
|
*/
|
|
2258
2613
|
NextToken?: string;
|
|
2259
2614
|
/**
|
|
2615
|
+
* @public
|
|
2260
2616
|
* <p>The unique identifier for a revision.</p>
|
|
2261
2617
|
*/
|
|
2262
2618
|
RevisionId?: string;
|
|
@@ -2267,34 +2623,42 @@ export interface ListJobsRequest {
|
|
|
2267
2623
|
*/
|
|
2268
2624
|
export interface JobEntry {
|
|
2269
2625
|
/**
|
|
2626
|
+
* @public
|
|
2270
2627
|
* <p>The ARN for the job.</p>
|
|
2271
2628
|
*/
|
|
2272
2629
|
Arn: string | undefined;
|
|
2273
2630
|
/**
|
|
2631
|
+
* @public
|
|
2274
2632
|
* <p>The date and time that the job was created, in ISO 8601 format.</p>
|
|
2275
2633
|
*/
|
|
2276
2634
|
CreatedAt: Date | undefined;
|
|
2277
2635
|
/**
|
|
2636
|
+
* @public
|
|
2278
2637
|
* <p>Details of the operation to be performed by the job, such as export destination details or import source details.</p>
|
|
2279
2638
|
*/
|
|
2280
2639
|
Details: ResponseDetails | undefined;
|
|
2281
2640
|
/**
|
|
2641
|
+
* @public
|
|
2282
2642
|
* <p>Errors for jobs.</p>
|
|
2283
2643
|
*/
|
|
2284
2644
|
Errors?: JobError[];
|
|
2285
2645
|
/**
|
|
2646
|
+
* @public
|
|
2286
2647
|
* <p>The unique identifier for the job.</p>
|
|
2287
2648
|
*/
|
|
2288
2649
|
Id: string | undefined;
|
|
2289
2650
|
/**
|
|
2651
|
+
* @public
|
|
2290
2652
|
* <p>The state of the job.</p>
|
|
2291
2653
|
*/
|
|
2292
2654
|
State: State | string | undefined;
|
|
2293
2655
|
/**
|
|
2656
|
+
* @public
|
|
2294
2657
|
* <p>The job type.</p>
|
|
2295
2658
|
*/
|
|
2296
2659
|
Type: Type | string | undefined;
|
|
2297
2660
|
/**
|
|
2661
|
+
* @public
|
|
2298
2662
|
* <p>The date and time that the job was last updated, in ISO 8601 format.</p>
|
|
2299
2663
|
*/
|
|
2300
2664
|
UpdatedAt: Date | undefined;
|
|
@@ -2304,10 +2668,12 @@ export interface JobEntry {
|
|
|
2304
2668
|
*/
|
|
2305
2669
|
export interface ListJobsResponse {
|
|
2306
2670
|
/**
|
|
2671
|
+
* @public
|
|
2307
2672
|
* <p>The jobs listed by the request.</p>
|
|
2308
2673
|
*/
|
|
2309
2674
|
Jobs?: JobEntry[];
|
|
2310
2675
|
/**
|
|
2676
|
+
* @public
|
|
2311
2677
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2312
2678
|
*/
|
|
2313
2679
|
NextToken?: string;
|
|
@@ -2317,18 +2683,22 @@ export interface ListJobsResponse {
|
|
|
2317
2683
|
*/
|
|
2318
2684
|
export interface ListRevisionAssetsRequest {
|
|
2319
2685
|
/**
|
|
2686
|
+
* @public
|
|
2320
2687
|
* <p>The unique identifier for a data set.</p>
|
|
2321
2688
|
*/
|
|
2322
2689
|
DataSetId: string | undefined;
|
|
2323
2690
|
/**
|
|
2691
|
+
* @public
|
|
2324
2692
|
* <p>The maximum number of results returned by a single call.</p>
|
|
2325
2693
|
*/
|
|
2326
2694
|
MaxResults?: number;
|
|
2327
2695
|
/**
|
|
2696
|
+
* @public
|
|
2328
2697
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2329
2698
|
*/
|
|
2330
2699
|
NextToken?: string;
|
|
2331
2700
|
/**
|
|
2701
|
+
* @public
|
|
2332
2702
|
* <p>The unique identifier for a revision.</p>
|
|
2333
2703
|
*/
|
|
2334
2704
|
RevisionId: string | undefined;
|
|
@@ -2338,10 +2708,12 @@ export interface ListRevisionAssetsRequest {
|
|
|
2338
2708
|
*/
|
|
2339
2709
|
export interface ListRevisionAssetsResponse {
|
|
2340
2710
|
/**
|
|
2711
|
+
* @public
|
|
2341
2712
|
* <p>The asset objects listed by the request.</p>
|
|
2342
2713
|
*/
|
|
2343
2714
|
Assets?: AssetEntry[];
|
|
2344
2715
|
/**
|
|
2716
|
+
* @public
|
|
2345
2717
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2346
2718
|
*/
|
|
2347
2719
|
NextToken?: string;
|
|
@@ -2351,6 +2723,7 @@ export interface ListRevisionAssetsResponse {
|
|
|
2351
2723
|
*/
|
|
2352
2724
|
export interface ListTagsForResourceRequest {
|
|
2353
2725
|
/**
|
|
2726
|
+
* @public
|
|
2354
2727
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.</p>
|
|
2355
2728
|
*/
|
|
2356
2729
|
ResourceArn: string | undefined;
|
|
@@ -2360,6 +2733,7 @@ export interface ListTagsForResourceRequest {
|
|
|
2360
2733
|
*/
|
|
2361
2734
|
export interface ListTagsForResourceResponse {
|
|
2362
2735
|
/**
|
|
2736
|
+
* @public
|
|
2363
2737
|
* <p>A label that consists of a customer-defined key and an optional value.</p>
|
|
2364
2738
|
*/
|
|
2365
2739
|
Tags?: Record<string, string>;
|
|
@@ -2369,14 +2743,17 @@ export interface ListTagsForResourceResponse {
|
|
|
2369
2743
|
*/
|
|
2370
2744
|
export interface RevokeRevisionRequest {
|
|
2371
2745
|
/**
|
|
2746
|
+
* @public
|
|
2372
2747
|
* <p>The unique identifier for a data set.</p>
|
|
2373
2748
|
*/
|
|
2374
2749
|
DataSetId: string | undefined;
|
|
2375
2750
|
/**
|
|
2751
|
+
* @public
|
|
2376
2752
|
* <p>The unique identifier for a revision.</p>
|
|
2377
2753
|
*/
|
|
2378
2754
|
RevisionId: string | undefined;
|
|
2379
2755
|
/**
|
|
2756
|
+
* @public
|
|
2380
2757
|
* <p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>
|
|
2381
2758
|
*/
|
|
2382
2759
|
RevocationComment: string | undefined;
|
|
@@ -2386,46 +2763,57 @@ export interface RevokeRevisionRequest {
|
|
|
2386
2763
|
*/
|
|
2387
2764
|
export interface RevokeRevisionResponse {
|
|
2388
2765
|
/**
|
|
2766
|
+
* @public
|
|
2389
2767
|
* <p>The ARN for the revision.</p>
|
|
2390
2768
|
*/
|
|
2391
2769
|
Arn?: string;
|
|
2392
2770
|
/**
|
|
2771
|
+
* @public
|
|
2393
2772
|
* <p>An optional comment about the revision.</p>
|
|
2394
2773
|
*/
|
|
2395
2774
|
Comment?: string;
|
|
2396
2775
|
/**
|
|
2776
|
+
* @public
|
|
2397
2777
|
* <p>The date and time that the revision was created, in ISO 8601 format.</p>
|
|
2398
2778
|
*/
|
|
2399
2779
|
CreatedAt?: Date;
|
|
2400
2780
|
/**
|
|
2781
|
+
* @public
|
|
2401
2782
|
* <p>The unique identifier for the data set associated with the data set revision.</p>
|
|
2402
2783
|
*/
|
|
2403
2784
|
DataSetId?: string;
|
|
2404
2785
|
/**
|
|
2786
|
+
* @public
|
|
2405
2787
|
* <p>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.</p>
|
|
2406
2788
|
*/
|
|
2407
2789
|
Finalized?: boolean;
|
|
2408
2790
|
/**
|
|
2791
|
+
* @public
|
|
2409
2792
|
* <p>The unique identifier for the revision.</p>
|
|
2410
2793
|
*/
|
|
2411
2794
|
Id?: string;
|
|
2412
2795
|
/**
|
|
2796
|
+
* @public
|
|
2413
2797
|
* <p>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.</p>
|
|
2414
2798
|
*/
|
|
2415
2799
|
SourceId?: string;
|
|
2416
2800
|
/**
|
|
2801
|
+
* @public
|
|
2417
2802
|
* <p>The date and time that the revision was last updated, in ISO 8601 format.</p>
|
|
2418
2803
|
*/
|
|
2419
2804
|
UpdatedAt?: Date;
|
|
2420
2805
|
/**
|
|
2806
|
+
* @public
|
|
2421
2807
|
* <p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>
|
|
2422
2808
|
*/
|
|
2423
2809
|
RevocationComment?: string;
|
|
2424
2810
|
/**
|
|
2811
|
+
* @public
|
|
2425
2812
|
* <p>A status indicating that subscribers' access to the revision was revoked.</p>
|
|
2426
2813
|
*/
|
|
2427
2814
|
Revoked?: boolean;
|
|
2428
2815
|
/**
|
|
2816
|
+
* @public
|
|
2429
2817
|
* <p>The date and time that the revision was revoked, in ISO 8601 format.</p>
|
|
2430
2818
|
*/
|
|
2431
2819
|
RevokedAt?: Date;
|
|
@@ -2435,34 +2823,42 @@ export interface RevokeRevisionResponse {
|
|
|
2435
2823
|
*/
|
|
2436
2824
|
export interface SendApiAssetRequest {
|
|
2437
2825
|
/**
|
|
2826
|
+
* @public
|
|
2438
2827
|
* <p>The request body.</p>
|
|
2439
2828
|
*/
|
|
2440
2829
|
Body?: string;
|
|
2441
2830
|
/**
|
|
2831
|
+
* @public
|
|
2442
2832
|
* <p>Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue).</p>
|
|
2443
2833
|
*/
|
|
2444
2834
|
QueryStringParameters?: Record<string, string>;
|
|
2445
2835
|
/**
|
|
2836
|
+
* @public
|
|
2446
2837
|
* <p>Asset ID value for the API request.</p>
|
|
2447
2838
|
*/
|
|
2448
2839
|
AssetId: string | undefined;
|
|
2449
2840
|
/**
|
|
2841
|
+
* @public
|
|
2450
2842
|
* <p>Data set ID value for the API request.</p>
|
|
2451
2843
|
*/
|
|
2452
2844
|
DataSetId: string | undefined;
|
|
2453
2845
|
/**
|
|
2846
|
+
* @public
|
|
2454
2847
|
* <p>Any header value prefixed with x-amzn-dataexchange-header- will have that stripped before sending the Asset API request. Use this when you want to override a header that AWS Data Exchange uses. Alternatively, you can use the header without a prefix to the HTTP request.</p>
|
|
2455
2848
|
*/
|
|
2456
2849
|
RequestHeaders?: Record<string, string>;
|
|
2457
2850
|
/**
|
|
2851
|
+
* @public
|
|
2458
2852
|
* <p>HTTP method value for the API request. Alternatively, you can use the appropriate verb in your request.</p>
|
|
2459
2853
|
*/
|
|
2460
2854
|
Method?: string;
|
|
2461
2855
|
/**
|
|
2856
|
+
* @public
|
|
2462
2857
|
* <p>URI path value for the API request. Alternatively, you can set the URI path directly by invoking /v1/\{pathValue\}.</p>
|
|
2463
2858
|
*/
|
|
2464
2859
|
Path?: string;
|
|
2465
2860
|
/**
|
|
2861
|
+
* @public
|
|
2466
2862
|
* <p>Revision ID value for the API request.</p>
|
|
2467
2863
|
*/
|
|
2468
2864
|
RevisionId: string | undefined;
|
|
@@ -2472,10 +2868,12 @@ export interface SendApiAssetRequest {
|
|
|
2472
2868
|
*/
|
|
2473
2869
|
export interface SendApiAssetResponse {
|
|
2474
2870
|
/**
|
|
2871
|
+
* @public
|
|
2475
2872
|
* <p>The response body from the underlying API tracked by the API asset.</p>
|
|
2476
2873
|
*/
|
|
2477
2874
|
Body?: string;
|
|
2478
2875
|
/**
|
|
2876
|
+
* @public
|
|
2479
2877
|
* <p>The response headers from the underlying API tracked by the API asset.</p>
|
|
2480
2878
|
*/
|
|
2481
2879
|
ResponseHeaders?: Record<string, string>;
|
|
@@ -2485,6 +2883,7 @@ export interface SendApiAssetResponse {
|
|
|
2485
2883
|
*/
|
|
2486
2884
|
export interface StartJobRequest {
|
|
2487
2885
|
/**
|
|
2886
|
+
* @public
|
|
2488
2887
|
* <p>The unique identifier for a job.</p>
|
|
2489
2888
|
*/
|
|
2490
2889
|
JobId: string | undefined;
|
|
@@ -2499,10 +2898,12 @@ export interface StartJobResponse {
|
|
|
2499
2898
|
*/
|
|
2500
2899
|
export interface TagResourceRequest {
|
|
2501
2900
|
/**
|
|
2901
|
+
* @public
|
|
2502
2902
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.</p>
|
|
2503
2903
|
*/
|
|
2504
2904
|
ResourceArn: string | undefined;
|
|
2505
2905
|
/**
|
|
2906
|
+
* @public
|
|
2506
2907
|
* <p>A label that consists of a customer-defined key and an optional value.</p>
|
|
2507
2908
|
*/
|
|
2508
2909
|
Tags: Record<string, string> | undefined;
|
|
@@ -2512,10 +2913,12 @@ export interface TagResourceRequest {
|
|
|
2512
2913
|
*/
|
|
2513
2914
|
export interface UntagResourceRequest {
|
|
2514
2915
|
/**
|
|
2916
|
+
* @public
|
|
2515
2917
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.</p>
|
|
2516
2918
|
*/
|
|
2517
2919
|
ResourceArn: string | undefined;
|
|
2518
2920
|
/**
|
|
2921
|
+
* @public
|
|
2519
2922
|
* <p>The key tags.</p>
|
|
2520
2923
|
*/
|
|
2521
2924
|
TagKeys: string[] | undefined;
|
|
@@ -2525,14 +2928,17 @@ export interface UntagResourceRequest {
|
|
|
2525
2928
|
*/
|
|
2526
2929
|
export interface UpdateAssetRequest {
|
|
2527
2930
|
/**
|
|
2931
|
+
* @public
|
|
2528
2932
|
* <p>The unique identifier for an asset.</p>
|
|
2529
2933
|
*/
|
|
2530
2934
|
AssetId: string | undefined;
|
|
2531
2935
|
/**
|
|
2936
|
+
* @public
|
|
2532
2937
|
* <p>The unique identifier for a data set.</p>
|
|
2533
2938
|
*/
|
|
2534
2939
|
DataSetId: string | undefined;
|
|
2535
2940
|
/**
|
|
2941
|
+
* @public
|
|
2536
2942
|
* <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used
|
|
2537
2943
|
* as the asset name. When exporting to Amazon S3, the asset name is used as default target
|
|
2538
2944
|
* Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as
|
|
@@ -2543,6 +2949,7 @@ export interface UpdateAssetRequest {
|
|
|
2543
2949
|
*/
|
|
2544
2950
|
Name: string | undefined;
|
|
2545
2951
|
/**
|
|
2952
|
+
* @public
|
|
2546
2953
|
* <p>The unique identifier for a revision.</p>
|
|
2547
2954
|
*/
|
|
2548
2955
|
RevisionId: string | undefined;
|
|
@@ -2552,30 +2959,37 @@ export interface UpdateAssetRequest {
|
|
|
2552
2959
|
*/
|
|
2553
2960
|
export interface UpdateAssetResponse {
|
|
2554
2961
|
/**
|
|
2962
|
+
* @public
|
|
2555
2963
|
* <p>The ARN for the asset.</p>
|
|
2556
2964
|
*/
|
|
2557
2965
|
Arn?: string;
|
|
2558
2966
|
/**
|
|
2967
|
+
* @public
|
|
2559
2968
|
* <p>Details about the asset.</p>
|
|
2560
2969
|
*/
|
|
2561
2970
|
AssetDetails?: AssetDetails;
|
|
2562
2971
|
/**
|
|
2972
|
+
* @public
|
|
2563
2973
|
* <p>The type of asset that is added to a data set.</p>
|
|
2564
2974
|
*/
|
|
2565
2975
|
AssetType?: AssetType | string;
|
|
2566
2976
|
/**
|
|
2977
|
+
* @public
|
|
2567
2978
|
* <p>The date and time that the asset was created, in ISO 8601 format.</p>
|
|
2568
2979
|
*/
|
|
2569
2980
|
CreatedAt?: Date;
|
|
2570
2981
|
/**
|
|
2982
|
+
* @public
|
|
2571
2983
|
* <p>The unique identifier for the data set associated with this asset.</p>
|
|
2572
2984
|
*/
|
|
2573
2985
|
DataSetId?: string;
|
|
2574
2986
|
/**
|
|
2987
|
+
* @public
|
|
2575
2988
|
* <p>The unique identifier for the asset.</p>
|
|
2576
2989
|
*/
|
|
2577
2990
|
Id?: string;
|
|
2578
2991
|
/**
|
|
2992
|
+
* @public
|
|
2579
2993
|
* <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used
|
|
2580
2994
|
* as the asset name. When exporting to Amazon S3, the asset name is used as default target
|
|
2581
2995
|
* Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as
|
|
@@ -2586,14 +3000,17 @@ export interface UpdateAssetResponse {
|
|
|
2586
3000
|
*/
|
|
2587
3001
|
Name?: string;
|
|
2588
3002
|
/**
|
|
3003
|
+
* @public
|
|
2589
3004
|
* <p>The unique identifier for the revision associated with this asset.</p>
|
|
2590
3005
|
*/
|
|
2591
3006
|
RevisionId?: string;
|
|
2592
3007
|
/**
|
|
3008
|
+
* @public
|
|
2593
3009
|
* <p>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.</p>
|
|
2594
3010
|
*/
|
|
2595
3011
|
SourceId?: string;
|
|
2596
3012
|
/**
|
|
3013
|
+
* @public
|
|
2597
3014
|
* <p>The date and time that the asset was last updated, in ISO 8601 format.</p>
|
|
2598
3015
|
*/
|
|
2599
3016
|
UpdatedAt?: Date;
|
|
@@ -2603,14 +3020,17 @@ export interface UpdateAssetResponse {
|
|
|
2603
3020
|
*/
|
|
2604
3021
|
export interface UpdateDataSetRequest {
|
|
2605
3022
|
/**
|
|
3023
|
+
* @public
|
|
2606
3024
|
* <p>The unique identifier for a data set.</p>
|
|
2607
3025
|
*/
|
|
2608
3026
|
DataSetId: string | undefined;
|
|
2609
3027
|
/**
|
|
3028
|
+
* @public
|
|
2610
3029
|
* <p>The description for the data set.</p>
|
|
2611
3030
|
*/
|
|
2612
3031
|
Description?: string;
|
|
2613
3032
|
/**
|
|
3033
|
+
* @public
|
|
2614
3034
|
* <p>The name of the data set.</p>
|
|
2615
3035
|
*/
|
|
2616
3036
|
Name?: string;
|
|
@@ -2620,42 +3040,52 @@ export interface UpdateDataSetRequest {
|
|
|
2620
3040
|
*/
|
|
2621
3041
|
export interface UpdateDataSetResponse {
|
|
2622
3042
|
/**
|
|
3043
|
+
* @public
|
|
2623
3044
|
* <p>The ARN for the data set.</p>
|
|
2624
3045
|
*/
|
|
2625
3046
|
Arn?: string;
|
|
2626
3047
|
/**
|
|
3048
|
+
* @public
|
|
2627
3049
|
* <p>The type of asset that is added to a data set.</p>
|
|
2628
3050
|
*/
|
|
2629
3051
|
AssetType?: AssetType | string;
|
|
2630
3052
|
/**
|
|
3053
|
+
* @public
|
|
2631
3054
|
* <p>The date and time that the data set was created, in ISO 8601 format.</p>
|
|
2632
3055
|
*/
|
|
2633
3056
|
CreatedAt?: Date;
|
|
2634
3057
|
/**
|
|
3058
|
+
* @public
|
|
2635
3059
|
* <p>The description for the data set.</p>
|
|
2636
3060
|
*/
|
|
2637
3061
|
Description?: string;
|
|
2638
3062
|
/**
|
|
3063
|
+
* @public
|
|
2639
3064
|
* <p>The unique identifier for the data set.</p>
|
|
2640
3065
|
*/
|
|
2641
3066
|
Id?: string;
|
|
2642
3067
|
/**
|
|
3068
|
+
* @public
|
|
2643
3069
|
* <p>The name of the data set.</p>
|
|
2644
3070
|
*/
|
|
2645
3071
|
Name?: string;
|
|
2646
3072
|
/**
|
|
3073
|
+
* @public
|
|
2647
3074
|
* <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).</p>
|
|
2648
3075
|
*/
|
|
2649
3076
|
Origin?: Origin | string;
|
|
2650
3077
|
/**
|
|
3078
|
+
* @public
|
|
2651
3079
|
* <p>If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.</p>
|
|
2652
3080
|
*/
|
|
2653
3081
|
OriginDetails?: OriginDetails;
|
|
2654
3082
|
/**
|
|
3083
|
+
* @public
|
|
2655
3084
|
* <p>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.</p>
|
|
2656
3085
|
*/
|
|
2657
3086
|
SourceId?: string;
|
|
2658
3087
|
/**
|
|
3088
|
+
* @public
|
|
2659
3089
|
* <p>The date and time that the data set was last updated, in ISO 8601 format.</p>
|
|
2660
3090
|
*/
|
|
2661
3091
|
UpdatedAt?: Date;
|
|
@@ -2665,10 +3095,12 @@ export interface UpdateDataSetResponse {
|
|
|
2665
3095
|
*/
|
|
2666
3096
|
export interface UpdateEventActionRequest {
|
|
2667
3097
|
/**
|
|
3098
|
+
* @public
|
|
2668
3099
|
* <p>What occurs after a certain event.</p>
|
|
2669
3100
|
*/
|
|
2670
3101
|
Action?: Action;
|
|
2671
3102
|
/**
|
|
3103
|
+
* @public
|
|
2672
3104
|
* <p>The unique identifier for the event action.</p>
|
|
2673
3105
|
*/
|
|
2674
3106
|
EventActionId: string | undefined;
|
|
@@ -2678,26 +3110,32 @@ export interface UpdateEventActionRequest {
|
|
|
2678
3110
|
*/
|
|
2679
3111
|
export interface UpdateEventActionResponse {
|
|
2680
3112
|
/**
|
|
3113
|
+
* @public
|
|
2681
3114
|
* <p>What occurs after a certain event.</p>
|
|
2682
3115
|
*/
|
|
2683
3116
|
Action?: Action;
|
|
2684
3117
|
/**
|
|
3118
|
+
* @public
|
|
2685
3119
|
* <p>The ARN for the event action.</p>
|
|
2686
3120
|
*/
|
|
2687
3121
|
Arn?: string;
|
|
2688
3122
|
/**
|
|
3123
|
+
* @public
|
|
2689
3124
|
* <p>The date and time that the event action was created, in ISO 8601 format.</p>
|
|
2690
3125
|
*/
|
|
2691
3126
|
CreatedAt?: Date;
|
|
2692
3127
|
/**
|
|
3128
|
+
* @public
|
|
2693
3129
|
* <p>What occurs to start an action.</p>
|
|
2694
3130
|
*/
|
|
2695
3131
|
Event?: Event;
|
|
2696
3132
|
/**
|
|
3133
|
+
* @public
|
|
2697
3134
|
* <p>The unique identifier for the event action.</p>
|
|
2698
3135
|
*/
|
|
2699
3136
|
Id?: string;
|
|
2700
3137
|
/**
|
|
3138
|
+
* @public
|
|
2701
3139
|
* <p>The date and time that the event action was last updated, in ISO 8601 format.</p>
|
|
2702
3140
|
*/
|
|
2703
3141
|
UpdatedAt?: Date;
|
|
@@ -2707,18 +3145,22 @@ export interface UpdateEventActionResponse {
|
|
|
2707
3145
|
*/
|
|
2708
3146
|
export interface UpdateRevisionRequest {
|
|
2709
3147
|
/**
|
|
3148
|
+
* @public
|
|
2710
3149
|
* <p>An optional comment about the revision.</p>
|
|
2711
3150
|
*/
|
|
2712
3151
|
Comment?: string;
|
|
2713
3152
|
/**
|
|
3153
|
+
* @public
|
|
2714
3154
|
* <p>The unique identifier for a data set.</p>
|
|
2715
3155
|
*/
|
|
2716
3156
|
DataSetId: string | undefined;
|
|
2717
3157
|
/**
|
|
3158
|
+
* @public
|
|
2718
3159
|
* <p>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.</p>
|
|
2719
3160
|
*/
|
|
2720
3161
|
Finalized?: boolean;
|
|
2721
3162
|
/**
|
|
3163
|
+
* @public
|
|
2722
3164
|
* <p>The unique identifier for a revision.</p>
|
|
2723
3165
|
*/
|
|
2724
3166
|
RevisionId: string | undefined;
|
|
@@ -2728,46 +3170,57 @@ export interface UpdateRevisionRequest {
|
|
|
2728
3170
|
*/
|
|
2729
3171
|
export interface UpdateRevisionResponse {
|
|
2730
3172
|
/**
|
|
3173
|
+
* @public
|
|
2731
3174
|
* <p>The ARN for the revision.</p>
|
|
2732
3175
|
*/
|
|
2733
3176
|
Arn?: string;
|
|
2734
3177
|
/**
|
|
3178
|
+
* @public
|
|
2735
3179
|
* <p>An optional comment about the revision.</p>
|
|
2736
3180
|
*/
|
|
2737
3181
|
Comment?: string;
|
|
2738
3182
|
/**
|
|
3183
|
+
* @public
|
|
2739
3184
|
* <p>The date and time that the revision was created, in ISO 8601 format.</p>
|
|
2740
3185
|
*/
|
|
2741
3186
|
CreatedAt?: Date;
|
|
2742
3187
|
/**
|
|
3188
|
+
* @public
|
|
2743
3189
|
* <p>The unique identifier for the data set associated with the data set revision.</p>
|
|
2744
3190
|
*/
|
|
2745
3191
|
DataSetId?: string;
|
|
2746
3192
|
/**
|
|
3193
|
+
* @public
|
|
2747
3194
|
* <p>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.</p>
|
|
2748
3195
|
*/
|
|
2749
3196
|
Finalized?: boolean;
|
|
2750
3197
|
/**
|
|
3198
|
+
* @public
|
|
2751
3199
|
* <p>The unique identifier for the revision.</p>
|
|
2752
3200
|
*/
|
|
2753
3201
|
Id?: string;
|
|
2754
3202
|
/**
|
|
3203
|
+
* @public
|
|
2755
3204
|
* <p>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.</p>
|
|
2756
3205
|
*/
|
|
2757
3206
|
SourceId?: string;
|
|
2758
3207
|
/**
|
|
3208
|
+
* @public
|
|
2759
3209
|
* <p>The date and time that the revision was last updated, in ISO 8601 format.</p>
|
|
2760
3210
|
*/
|
|
2761
3211
|
UpdatedAt?: Date;
|
|
2762
3212
|
/**
|
|
3213
|
+
* @public
|
|
2763
3214
|
* <p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>
|
|
2764
3215
|
*/
|
|
2765
3216
|
RevocationComment?: string;
|
|
2766
3217
|
/**
|
|
3218
|
+
* @public
|
|
2767
3219
|
* <p>A status indicating that subscribers' access to the revision was revoked.</p>
|
|
2768
3220
|
*/
|
|
2769
3221
|
Revoked?: boolean;
|
|
2770
3222
|
/**
|
|
3223
|
+
* @public
|
|
2771
3224
|
* <p>The date and time that the revision was revoked, in ISO 8601 format.</p>
|
|
2772
3225
|
*/
|
|
2773
3226
|
RevokedAt?: Date;
|