@aws-sdk/client-dataexchange 3.1020.0 → 3.1021.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.
Files changed (30) hide show
  1. package/README.md +1 -18
  2. package/dist-cjs/schemas/schemas_0.js +31 -14
  3. package/dist-es/schemas/schemas_0.js +27 -10
  4. package/dist-types/DataExchange.d.ts +1 -18
  5. package/dist-types/DataExchangeClient.d.ts +1 -18
  6. package/dist-types/commands/AcceptDataGrantCommand.d.ts +1 -2
  7. package/dist-types/commands/CancelJobCommand.d.ts +2 -4
  8. package/dist-types/commands/CreateJobCommand.d.ts +17 -2
  9. package/dist-types/commands/DeleteAssetCommand.d.ts +1 -2
  10. package/dist-types/commands/DeleteDataSetCommand.d.ts +1 -2
  11. package/dist-types/commands/DeleteRevisionCommand.d.ts +1 -2
  12. package/dist-types/commands/GetAssetCommand.d.ts +3 -0
  13. package/dist-types/commands/GetJobCommand.d.ts +8 -0
  14. package/dist-types/commands/ListDataSetRevisionsCommand.d.ts +1 -2
  15. package/dist-types/commands/ListDataSetsCommand.d.ts +1 -2
  16. package/dist-types/commands/ListJobsCommand.d.ts +8 -0
  17. package/dist-types/commands/ListRevisionAssetsCommand.d.ts +1 -2
  18. package/dist-types/commands/RevokeRevisionCommand.d.ts +1 -2
  19. package/dist-types/commands/SendApiAssetCommand.d.ts +1 -2
  20. package/dist-types/commands/SendDataSetNotificationCommand.d.ts +1 -2
  21. package/dist-types/commands/StartJobCommand.d.ts +1 -2
  22. package/dist-types/commands/UpdateAssetCommand.d.ts +1 -2
  23. package/dist-types/commands/UpdateRevisionCommand.d.ts +1 -2
  24. package/dist-types/index.d.ts +1 -18
  25. package/dist-types/models/errors.d.ts +2 -4
  26. package/dist-types/models/models_0.d.ts +169 -320
  27. package/dist-types/schemas/schemas_0.d.ts +2 -0
  28. package/dist-types/ts3.4/models/models_0.d.ts +12 -0
  29. package/dist-types/ts3.4/schemas/schemas_0.d.ts +2 -0
  30. package/package.json +6 -6
@@ -80,14 +80,12 @@ export interface AcceptDataGrantResponse {
80
80
  UpdatedAt: Date | undefined;
81
81
  }
82
82
  /**
83
- * <p>Encryption configuration of the export job. Includes the encryption type in addition to
84
- * the AWS KMS key. The KMS key is only necessary if you chose the KMS encryption type.</p>
83
+ * <p>Encryption configuration of the export job. Includes the encryption type in addition to the AWS KMS key. The KMS key is only necessary if you chose the KMS encryption type.</p>
85
84
  * @public
86
85
  */
87
86
  export interface ExportServerSideEncryption {
88
87
  /**
89
- * <p>The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon
90
- * S3 objects. This parameter is required if you choose aws:kms as an encryption type.</p>
88
+ * <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>
91
89
  * @public
92
90
  */
93
91
  KmsKeyArn?: string | undefined;
@@ -98,8 +96,7 @@ export interface ExportServerSideEncryption {
98
96
  Type: ServerSideEncryptionTypes | undefined;
99
97
  }
100
98
  /**
101
- * <p>A revision destination is the Amazon S3 bucket folder destination to where the export
102
- * will be sent.</p>
99
+ * <p>A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.</p>
103
100
  * @public
104
101
  */
105
102
  export interface AutoExportRevisionDestinationEntry {
@@ -109,8 +106,7 @@ export interface AutoExportRevisionDestinationEntry {
109
106
  */
110
107
  Bucket: string | undefined;
111
108
  /**
112
- * <p>A string representing the pattern for generated names of the individual assets in the
113
- * 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>
109
+ * <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>
114
110
  * @public
115
111
  */
116
112
  KeyPattern?: string | undefined;
@@ -126,8 +122,7 @@ export interface AutoExportRevisionToS3RequestDetails {
126
122
  */
127
123
  Encryption?: ExportServerSideEncryption | undefined;
128
124
  /**
129
- * <p>A revision destination is the Amazon S3 bucket folder destination to where the export
130
- * will be sent.</p>
125
+ * <p>A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.</p>
131
126
  * @public
132
127
  */
133
128
  RevisionDestination: AutoExportRevisionDestinationEntry | undefined;
@@ -194,6 +189,33 @@ export interface ApiGatewayApiAsset {
194
189
  */
195
190
  Stage?: string | undefined;
196
191
  }
192
+ /**
193
+ * <p>A tag consisting of a key-value pair that can be applied to a resource.</p>
194
+ * @public
195
+ */
196
+ export interface Tag {
197
+ /**
198
+ * <p>The key of the tag.</p>
199
+ * @public
200
+ */
201
+ Key: string | undefined;
202
+ /**
203
+ * <p>The value of the tag.</p>
204
+ * @public
205
+ */
206
+ Value: string | undefined;
207
+ }
208
+ /**
209
+ * <p>The configuration for the asset, which can include tags.</p>
210
+ * @public
211
+ */
212
+ export interface AssetConfiguration {
213
+ /**
214
+ * <p>The tags to be applied to assets created by the job.</p>
215
+ * @public
216
+ */
217
+ Tags?: Tag[] | undefined;
218
+ }
197
219
  /**
198
220
  * <p>The destination for the asset.</p>
199
221
  * @public
@@ -254,20 +276,17 @@ export interface TableLFTagPolicy {
254
276
  Expression: LFTag[] | undefined;
255
277
  }
256
278
  /**
257
- * <p>Details about the AWS Lake Formation resource (Table or Database) included in the AWS
258
- * Lake Formation data permission.</p>
279
+ * <p>Details about the AWS Lake Formation resource (Table or Database) included in the AWS Lake Formation data permission.</p>
259
280
  * @public
260
281
  */
261
282
  export interface LFResourceDetails {
262
283
  /**
263
- * <p>Details about the database resource included in the AWS Lake Formation data
264
- * permission.</p>
284
+ * <p>Details about the database resource included in the AWS Lake Formation data permission.</p>
265
285
  * @public
266
286
  */
267
287
  Database?: DatabaseLFTagPolicy | undefined;
268
288
  /**
269
- * <p>Details about the table resource included in the AWS Lake Formation data
270
- * permission.</p>
289
+ * <p>Details about the table resource included in the AWS Lake Formation data permission.</p>
271
290
  * @public
272
291
  */
273
292
  Table?: TableLFTagPolicy | undefined;
@@ -325,8 +344,7 @@ export interface LakeFormationDataPermissionAsset {
325
344
  */
326
345
  Permissions: LFPermission[] | undefined;
327
346
  /**
328
- * <p>The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke
329
- * permissions to AWS Lake Formation data permissions.</p>
347
+ * <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>
330
348
  * @public
331
349
  */
332
350
  RoleArn?: string | undefined;
@@ -343,16 +361,12 @@ export interface RedshiftDataShareAsset {
343
361
  Arn: string | undefined;
344
362
  }
345
363
  /**
346
- * <p>The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the shared S3
347
- * objects.</p>
364
+ * <p>The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the shared S3 objects.</p>
348
365
  * @public
349
366
  */
350
367
  export interface KmsKeyToGrant {
351
368
  /**
352
- * <p>The AWS KMS CMK (Key Management System Customer Managed Key) used to encrypt S3 objects
353
- * in the shared S3 Bucket. AWS Data exchange will create a KMS grant for each subscriber to
354
- * allow them to access and decrypt their entitled data that is encrypted using this KMS key
355
- * specified.</p>
369
+ * <p>The AWS KMS CMK (Key Management System Customer Managed Key) used to encrypt S3 objects in the shared S3 Bucket. AWS Data exchange will create a KMS grant for each subscriber to allow them to access and decrypt their entitled data that is encrypted using this KMS key specified.</p>
356
370
  * @public
357
371
  */
358
372
  KmsKeyArn: string | undefined;
@@ -378,21 +392,17 @@ export interface S3DataAccessAsset {
378
392
  */
379
393
  Keys?: string[] | undefined;
380
394
  /**
381
- * <p>The automatically-generated bucket-style alias for your Amazon S3 Access Point.
382
- * Customers can access their entitled data using the S3 Access Point alias.</p>
395
+ * <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>
383
396
  * @public
384
397
  */
385
398
  S3AccessPointAlias?: string | undefined;
386
399
  /**
387
- * <p>The ARN for your Amazon S3 Access Point. Customers can also access their entitled data
388
- * using the S3 Access Point ARN.</p>
400
+ * <p>The ARN for your Amazon S3 Access Point. Customers can also access their entitled data using the S3 Access Point ARN.</p>
389
401
  * @public
390
402
  */
391
403
  S3AccessPointArn?: string | undefined;
392
404
  /**
393
- * <p> List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to
394
- * encrypt S3 objects being shared in this S3 Data Access asset. Providers must include all
395
- * AWS KMS keys used to encrypt these shared S3 objects.</p>
405
+ * <p> List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to encrypt S3 objects being shared in this S3 Data Access asset. Providers must include all AWS KMS keys used to encrypt these shared S3 objects.</p>
396
406
  * @public
397
407
  */
398
408
  KmsKeysToGrant?: KmsKeyToGrant[] | undefined;
@@ -440,14 +450,7 @@ export interface AssetDetails {
440
450
  LakeFormationDataPermissionAsset?: LakeFormationDataPermissionAsset | undefined;
441
451
  }
442
452
  /**
443
- * <p>An asset in AWS Data Exchange is a piece of data (Amazon S3 object) or a means of
444
- * fulfilling data (Amazon Redshift datashare or Amazon API Gateway API, AWS Lake Formation
445
- * data permission, or Amazon S3 data access). The asset can be a structured data file, an
446
- * image file, or some other data file that can be stored as an Amazon S3 object, an Amazon
447
- * API Gateway API, or an Amazon Redshift datashare, an AWS Lake Formation data permission, or
448
- * an Amazon S3 data access. When you create an import job for your files, API Gateway APIs,
449
- * Amazon Redshift datashares, AWS Lake Formation data permission, or Amazon S3 data access,
450
- * you create an asset in AWS Data Exchange.</p>
453
+ * <p>An asset in AWS Data Exchange is a piece of data (Amazon S3 object) or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API, AWS Lake Formation data permission, or Amazon S3 data access). The asset can be a structured data file, an image file, or some other data file that can be stored as an Amazon S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare, an AWS Lake Formation data permission, or an Amazon S3 data access. When you create an import job for your files, API Gateway APIs, Amazon Redshift datashares, AWS Lake Formation data permission, or Amazon S3 data access, you create an asset in AWS Data Exchange.</p>
451
454
  * @public
452
455
  */
453
456
  export interface AssetEntry {
@@ -482,13 +485,7 @@ export interface AssetEntry {
482
485
  */
483
486
  Id: string | undefined;
484
487
  /**
485
- * <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used
486
- * as the asset name. When exporting to Amazon S3, the asset name is used as default target
487
- * Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as
488
- * the asset name. When importing from Amazon Redshift, the datashare name is used as the
489
- * asset name. When importing from AWS Lake Formation, the static values of "Database(s)
490
- * included in LF-tag policy" or "Table(s) included in LF-tag policy" are used as the asset
491
- * name.</p>
488
+ * <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. When importing from AWS Lake Formation, the static values of "Database(s) included in LF-tag policy" or "Table(s) included in LF-tag policy" are used as the asset name.</p>
492
489
  * @public
493
490
  */
494
491
  Name: string | undefined;
@@ -498,9 +495,7 @@ export interface AssetEntry {
498
495
  */
499
496
  RevisionId: string | undefined;
500
497
  /**
501
- * <p>The asset ID of the owned asset corresponding to the entitled asset being viewed. This
502
- * parameter is returned when an asset owner is viewing the entitled copy of its owned
503
- * asset.</p>
498
+ * <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>
504
499
  * @public
505
500
  */
506
501
  SourceId?: string | undefined;
@@ -676,10 +671,7 @@ export interface CreateDataSetRequest {
676
671
  */
677
672
  Name: string | undefined;
678
673
  /**
679
- * <p>A data set tag is an optional label that you can assign to a data set when you create
680
- * it. Each tag consists of a key and an optional value, both of which you define. When you
681
- * use tagging, you can also use tag-based access control in IAM policies to control access to
682
- * these data sets and revisions.</p>
674
+ * <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>
683
675
  * @public
684
676
  */
685
677
  Tags?: Record<string, string> | undefined;
@@ -735,21 +727,17 @@ export interface CreateDataSetResponse {
735
727
  */
736
728
  Name?: string | undefined;
737
729
  /**
738
- * <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED
739
- * to the account (for subscribers).</p>
730
+ * <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).</p>
740
731
  * @public
741
732
  */
742
733
  Origin?: Origin | undefined;
743
734
  /**
744
- * <p>If the origin of this data set is ENTITLED, includes the details for the product on AWS
745
- * Marketplace.</p>
735
+ * <p>If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.</p>
746
736
  * @public
747
737
  */
748
738
  OriginDetails?: OriginDetails | undefined;
749
739
  /**
750
- * <p>The data set ID of the owned data set corresponding to the entitled data set being
751
- * viewed. This parameter is returned when a data set owner is viewing the entitled copy of
752
- * its owned data set.</p>
740
+ * <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>
753
741
  * @public
754
742
  */
755
743
  SourceId?: string | undefined;
@@ -867,8 +855,7 @@ export interface S3DataAccessAssetSourceEntry {
867
855
  */
868
856
  Keys?: string[] | undefined;
869
857
  /**
870
- * <p>List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to
871
- * encrypt S3 objects being shared in this S3 Data Access asset.</p>
858
+ * <p>List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to encrypt S3 objects being shared in this S3 Data Access asset.</p>
872
859
  * @public
873
860
  */
874
861
  KmsKeysToGrant?: KmsKeyToGrant[] | undefined;
@@ -884,8 +871,7 @@ export interface CreateS3DataAccessFromS3BucketRequestDetails {
884
871
  */
885
872
  AssetSource: S3DataAccessAssetSourceEntry | undefined;
886
873
  /**
887
- * <p>The unique identifier for the data set associated with the creation of this Amazon S3
888
- * data access.</p>
874
+ * <p>The unique identifier for the data set associated with the creation of this Amazon S3 data access.</p>
889
875
  * @public
890
876
  */
891
877
  DataSetId: string | undefined;
@@ -953,8 +939,7 @@ export interface RevisionDestinationEntry {
953
939
  */
954
940
  Bucket: string | undefined;
955
941
  /**
956
- * <p>A string representing the pattern for generated names of the individual assets in the
957
- * 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>
942
+ * <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>
958
943
  * @public
959
944
  */
960
945
  KeyPattern?: string | undefined;
@@ -1011,8 +996,7 @@ export interface ImportAssetFromApiGatewayApiRequestDetails {
1011
996
  */
1012
997
  ApiName: string | undefined;
1013
998
  /**
1014
- * <p>The Base64-encoded MD5 hash of the OpenAPI 3.0 JSON API specification file. It is used
1015
- * to ensure the integrity of the file.</p>
999
+ * <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>
1016
1000
  * @public
1017
1001
  */
1018
1002
  ApiSpecificationMd5Hash: string | undefined;
@@ -1043,8 +1027,7 @@ export interface ImportAssetFromApiGatewayApiRequestDetails {
1043
1027
  */
1044
1028
  export interface ImportAssetFromSignedUrlRequestDetails {
1045
1029
  /**
1046
- * <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used
1047
- * as the asset name.</p>
1030
+ * <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name.</p>
1048
1031
  * @public
1049
1032
  */
1050
1033
  AssetName: string | undefined;
@@ -1054,8 +1037,7 @@ export interface ImportAssetFromSignedUrlRequestDetails {
1054
1037
  */
1055
1038
  DataSetId: string | undefined;
1056
1039
  /**
1057
- * <p>The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at
1058
- * that location.</p>
1040
+ * <p>The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.</p>
1059
1041
  * @public
1060
1042
  */
1061
1043
  Md5Hash: string | undefined;
@@ -1118,8 +1100,7 @@ export interface ImportAssetsFromLakeFormationTagPolicyRequestDetails {
1118
1100
  */
1119
1101
  Table?: TableLFTagPolicyAndPermissions | undefined;
1120
1102
  /**
1121
- * <p>The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke
1122
- * permissions of subscribers to AWS Lake Formation data permissions.</p>
1103
+ * <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>
1123
1104
  * @public
1124
1105
  */
1125
1106
  RoleArn: string | undefined;
@@ -1242,6 +1223,11 @@ export interface RequestDetails {
1242
1223
  * @public
1243
1224
  */
1244
1225
  export interface CreateJobRequest {
1226
+ /**
1227
+ * <p>The configuration for the asset, including tags to be applied to assets created by the job.</p>
1228
+ * @public
1229
+ */
1230
+ AssetConfiguration?: AssetConfiguration | undefined;
1245
1231
  /**
1246
1232
  * <p>The details for the CreateJob request.</p>
1247
1233
  * @public
@@ -1254,8 +1240,7 @@ export interface CreateJobRequest {
1254
1240
  Type: Type | undefined;
1255
1241
  }
1256
1242
  /**
1257
- * <p>Details about the response of the operation to create an S3 data access from an S3
1258
- * bucket.</p>
1243
+ * <p>Details about the response of the operation to create an S3 data access from an S3 bucket.</p>
1259
1244
  * @public
1260
1245
  */
1261
1246
  export interface CreateS3DataAccessFromS3BucketResponseDetails {
@@ -1384,8 +1369,7 @@ export interface ImportAssetFromApiGatewayApiResponseDetails {
1384
1369
  */
1385
1370
  ApiName: string | undefined;
1386
1371
  /**
1387
- * <p>The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API
1388
- * at that location.</p>
1372
+ * <p>The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location.</p>
1389
1373
  * @public
1390
1374
  */
1391
1375
  ApiSpecificationMd5Hash: string | undefined;
@@ -1421,8 +1405,7 @@ export interface ImportAssetFromApiGatewayApiResponseDetails {
1421
1405
  Stage: string | undefined;
1422
1406
  }
1423
1407
  /**
1424
- * <p>The details in the response for an import request, including the signed URL and other
1425
- * information.</p>
1408
+ * <p>The details in the response for an import request, including the signed URL and other information.</p>
1426
1409
  * @public
1427
1410
  */
1428
1411
  export interface ImportAssetFromSignedUrlResponseDetails {
@@ -1437,8 +1420,7 @@ export interface ImportAssetFromSignedUrlResponseDetails {
1437
1420
  */
1438
1421
  DataSetId: string | undefined;
1439
1422
  /**
1440
- * <p>The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at
1441
- * that location.</p>
1423
+ * <p>The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.</p>
1442
1424
  * @public
1443
1425
  */
1444
1426
  Md5Hash?: string | undefined;
@@ -1479,8 +1461,7 @@ export interface ImportAssetsFromLakeFormationTagPolicyResponseDetails {
1479
1461
  */
1480
1462
  Table?: TableLFTagPolicyAndPermissions | undefined;
1481
1463
  /**
1482
- * <p>The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke
1483
- * permissions to AWS Lake Formation data permissions.</p>
1464
+ * <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>
1484
1465
  * @public
1485
1466
  */
1486
1467
  RoleArn: string | undefined;
@@ -1665,6 +1646,11 @@ export interface CreateJobResponse {
1665
1646
  * @public
1666
1647
  */
1667
1648
  Arn?: string | undefined;
1649
+ /**
1650
+ * <p>The configuration for the asset, including tags applied to assets created by the job.</p>
1651
+ * @public
1652
+ */
1653
+ AssetConfiguration?: AssetConfiguration | undefined;
1668
1654
  /**
1669
1655
  * <p>The date and time that the job was created, in ISO 8601 format.</p>
1670
1656
  * @public
@@ -1716,10 +1702,7 @@ export interface CreateRevisionRequest {
1716
1702
  */
1717
1703
  DataSetId: string | undefined;
1718
1704
  /**
1719
- * <p>A revision tag is an optional label that you can assign to a revision when you create
1720
- * it. Each tag consists of a key and an optional value, both of which you define. When you
1721
- * use tagging, you can also use tag-based access control in IAM policies to control access to
1722
- * these data sets and revisions.</p>
1705
+ * <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>
1723
1706
  * @public
1724
1707
  */
1725
1708
  Tags?: Record<string, string> | undefined;
@@ -1749,12 +1732,7 @@ export interface CreateRevisionResponse {
1749
1732
  */
1750
1733
  DataSetId?: string | undefined;
1751
1734
  /**
1752
- * <p>To publish a revision to a data set in a product, the revision must first be finalized.
1753
- * Finalizing a revision tells AWS Data Exchange that your changes to the assets in the
1754
- * revision are complete. After it's in this read-only state, you can publish the revision to
1755
- * your products. Finalized revisions can be published through the AWS Data Exchange console
1756
- * or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API
1757
- * action. When using the API, revisions are uniquely identified by their ARN.</p>
1735
+ * <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>
1758
1736
  * @public
1759
1737
  */
1760
1738
  Finalized?: boolean | undefined;
@@ -1764,9 +1742,7 @@ export interface CreateRevisionResponse {
1764
1742
  */
1765
1743
  Id?: string | undefined;
1766
1744
  /**
1767
- * <p>The revision ID of the owned revision corresponding to the entitled revision being
1768
- * viewed. This parameter is returned when a revision owner is viewing the entitled copy of
1769
- * its owned revision.</p>
1745
+ * <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>
1770
1746
  * @public
1771
1747
  */
1772
1748
  SourceId?: string | undefined;
@@ -1781,8 +1757,7 @@ export interface CreateRevisionResponse {
1781
1757
  */
1782
1758
  UpdatedAt?: Date | undefined;
1783
1759
  /**
1784
- * <p>A required comment to inform subscribers of the reason their access to the revision was
1785
- * revoked.</p>
1760
+ * <p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>
1786
1761
  * @public
1787
1762
  */
1788
1763
  RevocationComment?: string | undefined;
@@ -1917,13 +1892,7 @@ export interface GetAssetResponse {
1917
1892
  */
1918
1893
  Id?: string | undefined;
1919
1894
  /**
1920
- * <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used
1921
- * as the asset name. When exporting to Amazon S3, the asset name is used as default target
1922
- * Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as
1923
- * the asset name. When importing from Amazon Redshift, the datashare name is used as the
1924
- * asset name. When importing from AWS Lake Formation, the static values of "Database(s)
1925
- * included in the LF-tag policy" or "Table(s) included in the LF-tag policy" are used as the
1926
- * asset name.</p>
1895
+ * <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. When importing from AWS Lake Formation, the static values of "Database(s) included in the LF-tag policy" or "Table(s) included in the LF-tag policy" are used as the asset name.</p>
1927
1896
  * @public
1928
1897
  */
1929
1898
  Name?: string | undefined;
@@ -1933,12 +1902,15 @@ export interface GetAssetResponse {
1933
1902
  */
1934
1903
  RevisionId?: string | undefined;
1935
1904
  /**
1936
- * <p>The asset ID of the owned asset corresponding to the entitled asset being viewed. This
1937
- * parameter is returned when an asset owner is viewing the entitled copy of its owned
1938
- * asset.</p>
1905
+ * <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>
1939
1906
  * @public
1940
1907
  */
1941
1908
  SourceId?: string | undefined;
1909
+ /**
1910
+ * <p>The tags for the asset.</p>
1911
+ * @public
1912
+ */
1913
+ Tags?: Record<string, string> | undefined;
1942
1914
  /**
1943
1915
  * <p>The date and time that the asset was last updated, in ISO 8601 format.</p>
1944
1916
  * @public
@@ -2080,21 +2052,17 @@ export interface GetDataSetResponse {
2080
2052
  */
2081
2053
  Name?: string | undefined;
2082
2054
  /**
2083
- * <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED
2084
- * to the account (for subscribers).</p>
2055
+ * <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).</p>
2085
2056
  * @public
2086
2057
  */
2087
2058
  Origin?: Origin | undefined;
2088
2059
  /**
2089
- * <p>If the origin of this data set is ENTITLED, includes the details for the product on AWS
2090
- * Marketplace.</p>
2060
+ * <p>If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.</p>
2091
2061
  * @public
2092
2062
  */
2093
2063
  OriginDetails?: OriginDetails | undefined;
2094
2064
  /**
2095
- * <p>The data set ID of the owned data set corresponding to the entitled data set being
2096
- * viewed. This parameter is returned when a data set owner is viewing the entitled copy of
2097
- * its owned data set.</p>
2065
+ * <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>
2098
2066
  * @public
2099
2067
  */
2100
2068
  SourceId?: string | undefined;
@@ -2178,6 +2146,11 @@ export interface GetJobResponse {
2178
2146
  * @public
2179
2147
  */
2180
2148
  Arn?: string | undefined;
2149
+ /**
2150
+ * <p>The configuration for the asset, including tags applied to assets created by the job.</p>
2151
+ * @public
2152
+ */
2153
+ AssetConfiguration?: AssetConfiguration | undefined;
2181
2154
  /**
2182
2155
  * <p>The date and time that the job was created, in ISO 8601 format.</p>
2183
2156
  * @public
@@ -2334,12 +2307,7 @@ export interface GetRevisionResponse {
2334
2307
  */
2335
2308
  DataSetId?: string | undefined;
2336
2309
  /**
2337
- * <p>To publish a revision to a data set in a product, the revision must first be finalized.
2338
- * Finalizing a revision tells AWS Data Exchange that your changes to the assets in the
2339
- * revision are complete. After it's in this read-only state, you can publish the revision to
2340
- * your products. Finalized revisions can be published through the AWS Data Exchange console
2341
- * or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API
2342
- * action. When using the API, revisions are uniquely identified by their ARN.</p>
2310
+ * <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>
2343
2311
  * @public
2344
2312
  */
2345
2313
  Finalized?: boolean | undefined;
@@ -2349,9 +2317,7 @@ export interface GetRevisionResponse {
2349
2317
  */
2350
2318
  Id?: string | undefined;
2351
2319
  /**
2352
- * <p>The revision ID of the owned revision corresponding to the entitled revision being
2353
- * viewed. This parameter is returned when a revision owner is viewing the entitled copy of
2354
- * its owned revision.</p>
2320
+ * <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>
2355
2321
  * @public
2356
2322
  */
2357
2323
  SourceId?: string | undefined;
@@ -2366,8 +2332,7 @@ export interface GetRevisionResponse {
2366
2332
  */
2367
2333
  UpdatedAt?: Date | undefined;
2368
2334
  /**
2369
- * <p>A required comment to inform subscribers of the reason their access to the revision was
2370
- * revoked.</p>
2335
+ * <p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>
2371
2336
  * @public
2372
2337
  */
2373
2338
  RevocationComment?: string | undefined;
@@ -2392,8 +2357,7 @@ export interface ListDataGrantsRequest {
2392
2357
  */
2393
2358
  MaxResults?: number | undefined;
2394
2359
  /**
2395
- * <p>The pagination token used to retrieve the next page of results for this
2396
- * operation.</p>
2360
+ * <p>The pagination token used to retrieve the next page of results for this operation.</p>
2397
2361
  * @public
2398
2362
  */
2399
2363
  NextToken?: string | undefined;
@@ -2474,8 +2438,7 @@ export interface ListDataGrantsResponse {
2474
2438
  */
2475
2439
  DataGrantSummaries?: DataGrantSummaryEntry[] | undefined;
2476
2440
  /**
2477
- * <p>The pagination token used to retrieve the next page of results for this
2478
- * operation.</p>
2441
+ * <p>The pagination token used to retrieve the next page of results for this operation.</p>
2479
2442
  * @public
2480
2443
  */
2481
2444
  NextToken?: string | undefined;
@@ -2495,8 +2458,7 @@ export interface ListDataSetRevisionsRequest {
2495
2458
  */
2496
2459
  MaxResults?: number | undefined;
2497
2460
  /**
2498
- * <p>The token value retrieved from a previous call to access the next page of
2499
- * results.</p>
2461
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
2500
2462
  * @public
2501
2463
  */
2502
2464
  NextToken?: string | undefined;
@@ -2527,12 +2489,7 @@ export interface RevisionEntry {
2527
2489
  */
2528
2490
  DataSetId: string | undefined;
2529
2491
  /**
2530
- * <p>To publish a revision to a data set in a product, the revision must first be finalized.
2531
- * Finalizing a revision tells AWS Data Exchange that your changes to the assets in the
2532
- * revision are complete. After it's in this read-only state, you can publish the revision to
2533
- * your products. Finalized revisions can be published through the AWS Data Exchange console
2534
- * or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API
2535
- * action. When using the API, revisions are uniquely identified by their ARN.</p>
2492
+ * <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>
2536
2493
  * @public
2537
2494
  */
2538
2495
  Finalized?: boolean | undefined;
@@ -2542,9 +2499,7 @@ export interface RevisionEntry {
2542
2499
  */
2543
2500
  Id: string | undefined;
2544
2501
  /**
2545
- * <p>The revision ID of the owned revision corresponding to the entitled revision being
2546
- * viewed. This parameter is returned when a revision owner is viewing the entitled copy of
2547
- * its owned revision.</p>
2502
+ * <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>
2548
2503
  * @public
2549
2504
  */
2550
2505
  SourceId?: string | undefined;
@@ -2554,8 +2509,7 @@ export interface RevisionEntry {
2554
2509
  */
2555
2510
  UpdatedAt: Date | undefined;
2556
2511
  /**
2557
- * <p>A required comment to inform subscribers of the reason their access to the revision was
2558
- * revoked.</p>
2512
+ * <p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>
2559
2513
  * @public
2560
2514
  */
2561
2515
  RevocationComment?: string | undefined;
@@ -2575,8 +2529,7 @@ export interface RevisionEntry {
2575
2529
  */
2576
2530
  export interface ListDataSetRevisionsResponse {
2577
2531
  /**
2578
- * <p>The token value retrieved from a previous call to access the next page of
2579
- * results.</p>
2532
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
2580
2533
  * @public
2581
2534
  */
2582
2535
  NextToken?: string | undefined;
@@ -2596,14 +2549,12 @@ export interface ListDataSetsRequest {
2596
2549
  */
2597
2550
  MaxResults?: number | undefined;
2598
2551
  /**
2599
- * <p>The token value retrieved from a previous call to access the next page of
2600
- * results.</p>
2552
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
2601
2553
  * @public
2602
2554
  */
2603
2555
  NextToken?: string | undefined;
2604
2556
  /**
2605
- * <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED
2606
- * to the account (for subscribers).</p>
2557
+ * <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).</p>
2607
2558
  * @public
2608
2559
  */
2609
2560
  Origin?: string | undefined;
@@ -2644,21 +2595,17 @@ export interface DataSetEntry {
2644
2595
  */
2645
2596
  Name: string | undefined;
2646
2597
  /**
2647
- * <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED
2648
- * to the account (for subscribers).</p>
2598
+ * <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).</p>
2649
2599
  * @public
2650
2600
  */
2651
2601
  Origin: Origin | undefined;
2652
2602
  /**
2653
- * <p>If the origin of this data set is ENTITLED, includes the details for the product on AWS
2654
- * Marketplace.</p>
2603
+ * <p>If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.</p>
2655
2604
  * @public
2656
2605
  */
2657
2606
  OriginDetails?: OriginDetails | undefined;
2658
2607
  /**
2659
- * <p>The data set ID of the owned data set corresponding to the entitled data set being
2660
- * viewed. This parameter is returned when a data set owner is viewing the entitled copy of
2661
- * its owned data set.</p>
2608
+ * <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>
2662
2609
  * @public
2663
2610
  */
2664
2611
  SourceId?: string | undefined;
@@ -2678,8 +2625,7 @@ export interface ListDataSetsResponse {
2678
2625
  */
2679
2626
  DataSets?: DataSetEntry[] | undefined;
2680
2627
  /**
2681
- * <p>The token value retrieved from a previous call to access the next page of
2682
- * results.</p>
2628
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
2683
2629
  * @public
2684
2630
  */
2685
2631
  NextToken?: string | undefined;
@@ -2699,15 +2645,13 @@ export interface ListEventActionsRequest {
2699
2645
  */
2700
2646
  MaxResults?: number | undefined;
2701
2647
  /**
2702
- * <p>The token value retrieved from a previous call to access the next page of
2703
- * results.</p>
2648
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
2704
2649
  * @public
2705
2650
  */
2706
2651
  NextToken?: string | undefined;
2707
2652
  }
2708
2653
  /**
2709
- * <p>An event action is an object that defines the relationship between a specific event and
2710
- * an automated action that will be taken on behalf of the customer.</p>
2654
+ * <p>An event action is an object that defines the relationship between a specific event and an automated action that will be taken on behalf of the customer.</p>
2711
2655
  * @public
2712
2656
  */
2713
2657
  export interface EventActionEntry {
@@ -2752,8 +2696,7 @@ export interface ListEventActionsResponse {
2752
2696
  */
2753
2697
  EventActions?: EventActionEntry[] | undefined;
2754
2698
  /**
2755
- * <p>The token value retrieved from a previous call to access the next page of
2756
- * results.</p>
2699
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
2757
2700
  * @public
2758
2701
  */
2759
2702
  NextToken?: string | undefined;
@@ -2773,8 +2716,7 @@ export interface ListJobsRequest {
2773
2716
  */
2774
2717
  MaxResults?: number | undefined;
2775
2718
  /**
2776
- * <p>The token value retrieved from a previous call to access the next page of
2777
- * results.</p>
2719
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
2778
2720
  * @public
2779
2721
  */
2780
2722
  NextToken?: string | undefined;
@@ -2785,10 +2727,7 @@ export interface ListJobsRequest {
2785
2727
  RevisionId?: string | undefined;
2786
2728
  }
2787
2729
  /**
2788
- * <p>AWS Data Exchange Jobs are asynchronous import or export operations used to create or
2789
- * copy assets. A data set owner can both import and export as they see fit. Someone with an
2790
- * entitlement to a data set can only export. Jobs are deleted 90 days after they are
2791
- * created.</p>
2730
+ * <p>AWS Data Exchange Jobs are asynchronous import or export operations used to create or copy assets. A data set owner can both import and export as they see fit. Someone with an entitlement to a data set can only export. Jobs are deleted 90 days after they are created.</p>
2792
2731
  * @public
2793
2732
  */
2794
2733
  export interface JobEntry {
@@ -2797,14 +2736,18 @@ export interface JobEntry {
2797
2736
  * @public
2798
2737
  */
2799
2738
  Arn: string | undefined;
2739
+ /**
2740
+ * <p>The configuration for the asset, including tags applied to assets created by the job.</p>
2741
+ * @public
2742
+ */
2743
+ AssetConfiguration?: AssetConfiguration | undefined;
2800
2744
  /**
2801
2745
  * <p>The date and time that the job was created, in ISO 8601 format.</p>
2802
2746
  * @public
2803
2747
  */
2804
2748
  CreatedAt: Date | undefined;
2805
2749
  /**
2806
- * <p>Details of the operation to be performed by the job, such as export destination details
2807
- * or import source details.</p>
2750
+ * <p>Details of the operation to be performed by the job, such as export destination details or import source details.</p>
2808
2751
  * @public
2809
2752
  */
2810
2753
  Details: ResponseDetails | undefined;
@@ -2844,8 +2787,7 @@ export interface ListJobsResponse {
2844
2787
  */
2845
2788
  Jobs?: JobEntry[] | undefined;
2846
2789
  /**
2847
- * <p>The token value retrieved from a previous call to access the next page of
2848
- * results.</p>
2790
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
2849
2791
  * @public
2850
2792
  */
2851
2793
  NextToken?: string | undefined;
@@ -2860,8 +2802,7 @@ export interface ListReceivedDataGrantsRequest {
2860
2802
  */
2861
2803
  MaxResults?: number | undefined;
2862
2804
  /**
2863
- * <p>The pagination token used to retrieve the next page of results for this
2864
- * operation.</p>
2805
+ * <p>The pagination token used to retrieve the next page of results for this operation.</p>
2865
2806
  * @public
2866
2807
  */
2867
2808
  NextToken?: string | undefined;
@@ -2942,8 +2883,7 @@ export interface ListReceivedDataGrantsResponse {
2942
2883
  */
2943
2884
  DataGrantSummaries?: ReceivedDataGrantSummariesEntry[] | undefined;
2944
2885
  /**
2945
- * <p>The pagination token used to retrieve the next page of results for this
2946
- * operation.</p>
2886
+ * <p>The pagination token used to retrieve the next page of results for this operation.</p>
2947
2887
  * @public
2948
2888
  */
2949
2889
  NextToken?: string | undefined;
@@ -2963,8 +2903,7 @@ export interface ListRevisionAssetsRequest {
2963
2903
  */
2964
2904
  MaxResults?: number | undefined;
2965
2905
  /**
2966
- * <p>The token value retrieved from a previous call to access the next page of
2967
- * results.</p>
2906
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
2968
2907
  * @public
2969
2908
  */
2970
2909
  NextToken?: string | undefined;
@@ -2984,8 +2923,7 @@ export interface ListRevisionAssetsResponse {
2984
2923
  */
2985
2924
  Assets?: AssetEntry[] | undefined;
2986
2925
  /**
2987
- * <p>The token value retrieved from a previous call to access the next page of
2988
- * results.</p>
2926
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
2989
2927
  * @public
2990
2928
  */
2991
2929
  NextToken?: string | undefined;
@@ -3025,8 +2963,7 @@ export interface RevokeRevisionRequest {
3025
2963
  */
3026
2964
  RevisionId: string | undefined;
3027
2965
  /**
3028
- * <p>A required comment to inform subscribers of the reason their access to the revision was
3029
- * revoked.</p>
2966
+ * <p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>
3030
2967
  * @public
3031
2968
  */
3032
2969
  RevocationComment: string | undefined;
@@ -3056,12 +2993,7 @@ export interface RevokeRevisionResponse {
3056
2993
  */
3057
2994
  DataSetId?: string | undefined;
3058
2995
  /**
3059
- * <p>To publish a revision to a data set in a product, the revision must first be finalized.
3060
- * Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision
3061
- * are complete. After it's in this read-only state, you can publish the revision to your
3062
- * products. Finalized revisions can be published through the AWS Data Exchange console or the
3063
- * AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action.
3064
- * When using the API, revisions are uniquely identified by their ARN.</p>
2996
+ * <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>
3065
2997
  * @public
3066
2998
  */
3067
2999
  Finalized?: boolean | undefined;
@@ -3071,9 +3003,7 @@ export interface RevokeRevisionResponse {
3071
3003
  */
3072
3004
  Id?: string | undefined;
3073
3005
  /**
3074
- * <p>The revision ID of the owned revision corresponding to the entitled revision being
3075
- * viewed. This parameter is returned when a revision owner is viewing the entitled copy of
3076
- * its owned revision.</p>
3006
+ * <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>
3077
3007
  * @public
3078
3008
  */
3079
3009
  SourceId?: string | undefined;
@@ -3083,8 +3013,7 @@ export interface RevokeRevisionResponse {
3083
3013
  */
3084
3014
  UpdatedAt?: Date | undefined;
3085
3015
  /**
3086
- * <p>A required comment to inform subscribers of the reason their access to the revision was
3087
- * revoked.</p>
3016
+ * <p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>
3088
3017
  * @public
3089
3018
  */
3090
3019
  RevocationComment?: string | undefined;
@@ -3109,8 +3038,7 @@ export interface SendApiAssetRequest {
3109
3038
  */
3110
3039
  Body?: string | undefined;
3111
3040
  /**
3112
- * <p>Attach query string parameters to the end of the URI (for example,
3113
- * /v1/examplePath?exampleParam=exampleValue).</p>
3041
+ * <p>Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue).</p>
3114
3042
  * @public
3115
3043
  */
3116
3044
  QueryStringParameters?: Record<string, string> | undefined;
@@ -3125,22 +3053,17 @@ export interface SendApiAssetRequest {
3125
3053
  */
3126
3054
  DataSetId: string | undefined;
3127
3055
  /**
3128
- * <p>Any header value prefixed with x-amzn-dataexchange-header- will have that stripped
3129
- * before sending the Asset API request. Use this when you want to override a header that AWS
3130
- * Data Exchange uses. Alternatively, you can use the header without a prefix to the HTTP
3131
- * request.</p>
3056
+ * <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>
3132
3057
  * @public
3133
3058
  */
3134
3059
  RequestHeaders?: Record<string, string> | undefined;
3135
3060
  /**
3136
- * <p>HTTP method value for the API request. Alternatively, you can use the appropriate verb
3137
- * in your request.</p>
3061
+ * <p>HTTP method value for the API request. Alternatively, you can use the appropriate verb in your request.</p>
3138
3062
  * @public
3139
3063
  */
3140
3064
  Method?: string | undefined;
3141
3065
  /**
3142
- * <p>URI path value for the API request. Alternatively, you can set the URI path directly by
3143
- * invoking /v1/\{pathValue\}.</p>
3066
+ * <p>URI path value for the API request. Alternatively, you can set the URI path directly by invoking /v1/\{pathValue\}.</p>
3144
3067
  * @public
3145
3068
  */
3146
3069
  Path?: string | undefined;
@@ -3171,9 +3094,7 @@ export interface SendApiAssetResponse {
3171
3094
  */
3172
3095
  export interface DataUpdateRequestDetails {
3173
3096
  /**
3174
- * <p>A
3175
- * datetime in the past when the data was updated. This typically means that the underlying
3176
- * resource supporting the data set was updated.</p>
3097
+ * <p>A datetime in the past when the data was updated. This typically means that the underlying resource supporting the data set was updated.</p>
3177
3098
  * @public
3178
3099
  */
3179
3100
  DataUpdatedAt?: Date | undefined;
@@ -3184,37 +3105,28 @@ export interface DataUpdateRequestDetails {
3184
3105
  */
3185
3106
  export interface DeprecationRequestDetails {
3186
3107
  /**
3187
- * <p>A
3188
- * datetime in the future when the data set will be deprecated.</p>
3108
+ * <p>A datetime in the future when the data set will be deprecated.</p>
3189
3109
  * @public
3190
3110
  */
3191
3111
  DeprecationAt: Date | undefined;
3192
3112
  }
3193
3113
  /**
3194
- * <p>Object encompassing information about a schema change to a single, particular field, a
3195
- * notification can have up to 100 of these.</p>
3114
+ * <p>Object encompassing information about a schema change to a single, particular field, a notification can have up to 100 of these.</p>
3196
3115
  * @public
3197
3116
  */
3198
3117
  export interface SchemaChangeDetails {
3199
3118
  /**
3200
- * <p>Name
3201
- * of the changing
3202
- * field. This value
3203
- * can be up to 255 characters long.</p>
3119
+ * <p>Name of the changing field. This value can be up to 255 characters long.</p>
3204
3120
  * @public
3205
3121
  */
3206
3122
  Name: string | undefined;
3207
3123
  /**
3208
- * <p>Is
3209
- * the field being added, removed, or modified?</p>
3124
+ * <p>Is the field being added, removed, or modified?</p>
3210
3125
  * @public
3211
3126
  */
3212
3127
  Type: SchemaChangeType | undefined;
3213
3128
  /**
3214
- * <p>Description
3215
- * of what's changing about this
3216
- * field. This value
3217
- * can be up to 512 characters long.</p>
3129
+ * <p>Description of what's changing about this field. This value can be up to 512 characters long.</p>
3218
3130
  * @public
3219
3131
  */
3220
3132
  Description?: string | undefined;
@@ -3225,16 +3137,12 @@ export interface SchemaChangeDetails {
3225
3137
  */
3226
3138
  export interface SchemaChangeRequestDetails {
3227
3139
  /**
3228
- * <p>List
3229
- * of schema changes happening in the scope of this
3230
- * notification. This
3231
- * can have up to 100 entries.</p>
3140
+ * <p>List of schema changes happening in the scope of this notification. This can have up to 100 entries.</p>
3232
3141
  * @public
3233
3142
  */
3234
3143
  Changes?: SchemaChangeDetails[] | undefined;
3235
3144
  /**
3236
- * <p>A
3237
- * date in the future when the schema change is taking effect.</p>
3145
+ * <p>A date in the future when the schema change is taking effect.</p>
3238
3146
  * @public
3239
3147
  */
3240
3148
  SchemaChangeAt: Date | undefined;
@@ -3245,20 +3153,17 @@ export interface SchemaChangeRequestDetails {
3245
3153
  */
3246
3154
  export interface NotificationDetails {
3247
3155
  /**
3248
- * <p>Extra
3249
- * details specific to a data update type notification.</p>
3156
+ * <p>Extra details specific to a data update type notification.</p>
3250
3157
  * @public
3251
3158
  */
3252
3159
  DataUpdate?: DataUpdateRequestDetails | undefined;
3253
3160
  /**
3254
- * <p>Extra
3255
- * details specific to a deprecation type notification.</p>
3161
+ * <p>Extra details specific to a deprecation type notification.</p>
3256
3162
  * @public
3257
3163
  */
3258
3164
  Deprecation?: DeprecationRequestDetails | undefined;
3259
3165
  /**
3260
- * <p>Extra
3261
- * details specific to a schema change type notification.</p>
3166
+ * <p>Extra details specific to a schema change type notification.</p>
3262
3167
  * @public
3263
3168
  */
3264
3169
  SchemaChange?: SchemaChangeRequestDetails | undefined;
@@ -3269,14 +3174,12 @@ export interface NotificationDetails {
3269
3174
  */
3270
3175
  export interface LakeFormationTagPolicyDetails {
3271
3176
  /**
3272
- * <p>The
3273
- * underlying Glue database that the notification is referring to.</p>
3177
+ * <p>The underlying Glue database that the notification is referring to.</p>
3274
3178
  * @public
3275
3179
  */
3276
3180
  Database?: string | undefined;
3277
3181
  /**
3278
- * <p>The
3279
- * underlying Glue table that the notification is referring to.</p>
3182
+ * <p>The underlying Glue table that the notification is referring to.</p>
3280
3183
  * @public
3281
3184
  */
3282
3185
  Table?: string | undefined;
@@ -3287,40 +3190,32 @@ export interface LakeFormationTagPolicyDetails {
3287
3190
  */
3288
3191
  export interface RedshiftDataShareDetails {
3289
3192
  /**
3290
- * <p>The
3291
- * ARN of the underlying Redshift data share that is being affected by this
3292
- * notification.</p>
3193
+ * <p>The ARN of the underlying Redshift data share that is being affected by this notification.</p>
3293
3194
  * @public
3294
3195
  */
3295
3196
  Arn: string | undefined;
3296
3197
  /**
3297
- * <p>The
3298
- * database name in the Redshift data share that is being affected by this
3299
- * notification.</p>
3198
+ * <p>The database name in the Redshift data share that is being affected by this notification.</p>
3300
3199
  * @public
3301
3200
  */
3302
3201
  Database: string | undefined;
3303
3202
  /**
3304
- * <p>A
3305
- * function name in the Redshift database that is being affected by this notification.</p>
3203
+ * <p>A function name in the Redshift database that is being affected by this notification.</p>
3306
3204
  * @public
3307
3205
  */
3308
3206
  Function?: string | undefined;
3309
3207
  /**
3310
- * <p>A
3311
- * table name in the Redshift database that is being affected by this notification.</p>
3208
+ * <p>A table name in the Redshift database that is being affected by this notification.</p>
3312
3209
  * @public
3313
3210
  */
3314
3211
  Table?: string | undefined;
3315
3212
  /**
3316
- * <p>A
3317
- * schema name in the Redshift database that is being affected by this notification.</p>
3213
+ * <p>A schema name in the Redshift database that is being affected by this notification.</p>
3318
3214
  * @public
3319
3215
  */
3320
3216
  Schema?: string | undefined;
3321
3217
  /**
3322
- * <p>A
3323
- * view name in the Redshift database that is being affected by this notification.</p>
3218
+ * <p>A view name in the Redshift database that is being affected by this notification.</p>
3324
3219
  * @public
3325
3220
  */
3326
3221
  View?: string | undefined;
@@ -3331,18 +3226,12 @@ export interface RedshiftDataShareDetails {
3331
3226
  */
3332
3227
  export interface S3DataAccessDetails {
3333
3228
  /**
3334
- * <p>A
3335
- * list of the key prefixes affected by this
3336
- * notification. This
3337
- * can have up to 50 entries.</p>
3229
+ * <p>A list of the key prefixes affected by this notification. This can have up to 50 entries.</p>
3338
3230
  * @public
3339
3231
  */
3340
3232
  KeyPrefixes?: string[] | undefined;
3341
3233
  /**
3342
- * <p>A
3343
- * list of the keys affected by this
3344
- * notification. This
3345
- * can have up to 50 entries.</p>
3234
+ * <p>A list of the keys affected by this notification. This can have up to 50 entries.</p>
3346
3235
  * @public
3347
3236
  */
3348
3237
  Keys?: string[] | undefined;
@@ -3353,20 +3242,17 @@ export interface S3DataAccessDetails {
3353
3242
  */
3354
3243
  export interface ScopeDetails {
3355
3244
  /**
3356
- * <p>Underlying
3357
- * LF resources that will be affected by this notification.</p>
3245
+ * <p>Underlying LF resources that will be affected by this notification.</p>
3358
3246
  * @public
3359
3247
  */
3360
3248
  LakeFormationTagPolicies?: LakeFormationTagPolicyDetails[] | undefined;
3361
3249
  /**
3362
- * <p>Underlying
3363
- * Redshift resources that will be affected by this notification.</p>
3250
+ * <p>Underlying Redshift resources that will be affected by this notification.</p>
3364
3251
  * @public
3365
3252
  */
3366
3253
  RedshiftDataShares?: RedshiftDataShareDetails[] | undefined;
3367
3254
  /**
3368
- * <p>Underlying
3369
- * S3 resources that will be affected by this notification.</p>
3255
+ * <p>Underlying S3 resources that will be affected by this notification.</p>
3370
3256
  * @public
3371
3257
  */
3372
3258
  S3DataAccesses?: S3DataAccessDetails[] | undefined;
@@ -3376,41 +3262,32 @@ export interface ScopeDetails {
3376
3262
  */
3377
3263
  export interface SendDataSetNotificationRequest {
3378
3264
  /**
3379
- * <p>Affected
3380
- * scope of this notification such as the underlying resources affected by the notification
3381
- * event.</p>
3265
+ * <p>Affected scope of this notification such as the underlying resources affected by the notification event.</p>
3382
3266
  * @public
3383
3267
  */
3384
3268
  Scope?: ScopeDetails | undefined;
3385
3269
  /**
3386
- * <p>Idempotency
3387
- * key for the notification, this key allows us to deduplicate notifications that are sent in
3388
- * quick succession erroneously.</p>
3270
+ * <p>Idempotency key for the notification, this key allows us to deduplicate notifications that are sent in quick succession erroneously.</p>
3389
3271
  * @public
3390
3272
  */
3391
3273
  ClientToken?: string | undefined;
3392
3274
  /**
3393
- * <p>Free-form
3394
- * text field for providers to add information about their notifications.</p>
3275
+ * <p>Free-form text field for providers to add information about their notifications.</p>
3395
3276
  * @public
3396
3277
  */
3397
3278
  Comment?: string | undefined;
3398
3279
  /**
3399
- * <p>Affected
3400
- * data set of the notification.</p>
3280
+ * <p>Affected data set of the notification.</p>
3401
3281
  * @public
3402
3282
  */
3403
3283
  DataSetId: string | undefined;
3404
3284
  /**
3405
- * <p>Extra
3406
- * details specific to this notification type.</p>
3285
+ * <p>Extra details specific to this notification type.</p>
3407
3286
  * @public
3408
3287
  */
3409
3288
  Details?: NotificationDetails | undefined;
3410
3289
  /**
3411
- * <p>The
3412
- * type of the notification. Describing the kind of event the notification is alerting you
3413
- * to.</p>
3290
+ * <p>The type of the notification. Describing the kind of event the notification is alerting you to.</p>
3414
3291
  * @public
3415
3292
  */
3416
3293
  Type: NotificationType | undefined;
@@ -3480,13 +3357,7 @@ export interface UpdateAssetRequest {
3480
3357
  */
3481
3358
  DataSetId: string | undefined;
3482
3359
  /**
3483
- * <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used
3484
- * as the asset name. When exporting to Amazon S3, the asset name is used as default target
3485
- * Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as
3486
- * the asset name. When importing from Amazon Redshift, the datashare name is used as the
3487
- * asset name. When importing from AWS Lake Formation, the static values of "Database(s)
3488
- * included in the LF-tag policy" or "Table(s) included in LF-tag policy" are used as the
3489
- * name.</p>
3360
+ * <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. When importing from AWS Lake Formation, the static values of "Database(s) included in the LF-tag policy" or "Table(s) included in LF-tag policy" are used as the name.</p>
3490
3361
  * @public
3491
3362
  */
3492
3363
  Name: string | undefined;
@@ -3531,13 +3402,7 @@ export interface UpdateAssetResponse {
3531
3402
  */
3532
3403
  Id?: string | undefined;
3533
3404
  /**
3534
- * <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used
3535
- * as the asset name. When exporting to Amazon S3, the asset name is used as default target
3536
- * Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as
3537
- * the asset name. When importing from Amazon Redshift, the datashare name is used as the
3538
- * asset name. When importing from AWS Lake Formation, the static values of "Database(s)
3539
- * included in the LF-tag policy"- or "Table(s) included in LF-tag policy" are used as the
3540
- * asset name.</p>
3405
+ * <p>The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. When importing from AWS Lake Formation, the static values of "Database(s) included in the LF-tag policy"- or "Table(s) included in LF-tag policy" are used as the asset name.</p>
3541
3406
  * @public
3542
3407
  */
3543
3408
  Name?: string | undefined;
@@ -3547,9 +3412,7 @@ export interface UpdateAssetResponse {
3547
3412
  */
3548
3413
  RevisionId?: string | undefined;
3549
3414
  /**
3550
- * <p>The asset ID of the owned asset corresponding to the entitled asset being viewed. This
3551
- * parameter is returned when an asset owner is viewing the entitled copy of its owned
3552
- * asset.</p>
3415
+ * <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>
3553
3416
  * @public
3554
3417
  */
3555
3418
  SourceId?: string | undefined;
@@ -3614,21 +3477,17 @@ export interface UpdateDataSetResponse {
3614
3477
  */
3615
3478
  Name?: string | undefined;
3616
3479
  /**
3617
- * <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED
3618
- * to the account (for subscribers).</p>
3480
+ * <p>A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).</p>
3619
3481
  * @public
3620
3482
  */
3621
3483
  Origin?: Origin | undefined;
3622
3484
  /**
3623
- * <p>If the origin of this data set is ENTITLED, includes the details for the product on AWS
3624
- * Marketplace.</p>
3485
+ * <p>If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.</p>
3625
3486
  * @public
3626
3487
  */
3627
3488
  OriginDetails?: OriginDetails | undefined;
3628
3489
  /**
3629
- * <p>The data set ID of the owned data set corresponding to the entitled data set being
3630
- * viewed. This parameter is returned when a data set owner is viewing the entitled copy of
3631
- * its owned data set.</p>
3490
+ * <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>
3632
3491
  * @public
3633
3492
  */
3634
3493
  SourceId?: string | undefined;
@@ -3703,9 +3562,7 @@ export interface UpdateRevisionRequest {
3703
3562
  */
3704
3563
  DataSetId: string | undefined;
3705
3564
  /**
3706
- * <p>Finalizing a revision tells AWS Data Exchange that your changes to the assets in the
3707
- * revision are complete. After it's in this read-only state, you can publish the revision to
3708
- * your products.</p>
3565
+ * <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>
3709
3566
  * @public
3710
3567
  */
3711
3568
  Finalized?: boolean | undefined;
@@ -3740,12 +3597,7 @@ export interface UpdateRevisionResponse {
3740
3597
  */
3741
3598
  DataSetId?: string | undefined;
3742
3599
  /**
3743
- * <p>To publish a revision to a data set in a product, the revision must first be finalized.
3744
- * Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision
3745
- * are complete. After it's in this read-only state, you can publish the revision to your
3746
- * products. Finalized revisions can be published through the AWS Data Exchange console or the
3747
- * AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action.
3748
- * When using the API, revisions are uniquely identified by their ARN.</p>
3600
+ * <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>
3749
3601
  * @public
3750
3602
  */
3751
3603
  Finalized?: boolean | undefined;
@@ -3755,9 +3607,7 @@ export interface UpdateRevisionResponse {
3755
3607
  */
3756
3608
  Id?: string | undefined;
3757
3609
  /**
3758
- * <p>The revision ID of the owned revision corresponding to the entitled revision being
3759
- * viewed. This parameter is returned when a revision owner is viewing the entitled copy of
3760
- * its owned revision.</p>
3610
+ * <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>
3761
3611
  * @public
3762
3612
  */
3763
3613
  SourceId?: string | undefined;
@@ -3767,8 +3617,7 @@ export interface UpdateRevisionResponse {
3767
3617
  */
3768
3618
  UpdatedAt?: Date | undefined;
3769
3619
  /**
3770
- * <p>A required comment to inform subscribers of the reason their access to the revision was
3771
- * revoked.</p>
3620
+ * <p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>
3772
3621
  * @public
3773
3622
  */
3774
3623
  RevocationComment?: string | undefined;