You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat(client-dataexchange): This release adds Data Grant support, through which customers can programmatically create data grants to share with other AWS accounts and accept data grants from other AWS accounts.
Copy file name to clipboardExpand all lines: clients/client-dataexchange/README.md
+71-13
Original file line number
Diff line number
Diff line change
@@ -6,21 +6,23 @@
6
6
7
7
AWS SDK for JavaScript DataExchange Client for Node.js, Browser and React Native.
8
8
9
-
<p>AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.</p>
10
-
<p>As a subscriber, you can view and access the data sets that you have an entitlement to through
11
-
a subscription. You can use the APIs to download or copy your entitled data sets to Amazon
12
-
Simple Storage Service (Amazon S3) for use across a variety of AWS analytics and machine
13
-
learning services.</p>
14
-
<p>As a provider, you can create and manage your data sets that you would like to publish to a
15
-
product. Being able to package and provide your data sets into products requires a few
9
+
<p>AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in
10
+
the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access
11
+
file-based data set in the AWS Cloud.</p>
12
+
<p>As a subscriber, you can view and access the data sets that you have an entitlement to
13
+
through a subscription. You can use the APIs to download or copy your entitled data sets to
14
+
Amazon Simple Storage Service (Amazon S3) for use across a variety of AWS analytics and
15
+
machine learning services.</p>
16
+
<p>As a provider, you can create and manage your data sets that you would like to publish
17
+
to a product. Being able to package and provide your data sets into products requires a few
16
18
steps to determine eligibility. For more information, visit the <i>AWS Data Exchange
17
19
User Guide</i>.</p>
18
-
<p>A data set is a collection of data that can be changed or updated over time. Data sets can be
19
-
updated using revisions, which represent a new version or incremental change to a data set.
20
-
A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data
21
-
that can be stored as an Amazon S3 object, Redshift datashare, API Gateway API, AWS Lake
22
-
Formation data permission, or Amazon S3 data access. The asset can be a structured data
23
-
file, an image file, or some other data file. Jobs are asynchronous import or export
20
+
<p>A data set is a collection of data that can be changed or updated over time. Data sets
21
+
can be updated using revisions, which represent a new version or incremental change to a
22
+
data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece
23
+
of data that can be stored as an Amazon S3 object, Redshift datashare, API Gateway API, AWS
24
+
Lake Formation data permission, or Amazon S3 data access. The asset can be a structured
25
+
data file, an image file, or some other data file. Jobs are asynchronous import or export
24
26
operations used to create or copy assets.</p>
25
27
26
28
## Installing
@@ -218,13 +220,29 @@ see LICENSE for more information.
218
220
219
221
## Client Commands (Operations List)
220
222
223
+
<details>
224
+
<summary>
225
+
AcceptDataGrant
226
+
</summary>
227
+
228
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/AcceptDataGrantCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/AcceptDataGrantCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/AcceptDataGrantCommandOutput/)
229
+
230
+
</details>
221
231
<details>
222
232
<summary>
223
233
CancelJob
224
234
</summary>
225
235
226
236
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/CancelJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/CancelJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/CancelJobCommandOutput/)
227
237
238
+
</details>
239
+
<details>
240
+
<summary>
241
+
CreateDataGrant
242
+
</summary>
243
+
244
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/CreateDataGrantCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/CreateDataGrantCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/CreateDataGrantCommandOutput/)
245
+
228
246
</details>
229
247
<details>
230
248
<summary>
@@ -265,6 +283,14 @@ DeleteAsset
265
283
266
284
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/DeleteAssetCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/DeleteAssetCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/DeleteAssetCommandOutput/)
267
285
286
+
</details>
287
+
<details>
288
+
<summary>
289
+
DeleteDataGrant
290
+
</summary>
291
+
292
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/DeleteDataGrantCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/DeleteDataGrantCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/DeleteDataGrantCommandOutput/)
293
+
268
294
</details>
269
295
<details>
270
296
<summary>
@@ -297,6 +323,14 @@ GetAsset
297
323
298
324
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/GetAssetCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/GetAssetCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/GetAssetCommandOutput/)
299
325
326
+
</details>
327
+
<details>
328
+
<summary>
329
+
GetDataGrant
330
+
</summary>
331
+
332
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/GetDataGrantCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/GetDataGrantCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/GetDataGrantCommandOutput/)
333
+
300
334
</details>
301
335
<details>
302
336
<summary>
@@ -321,6 +355,14 @@ GetJob
321
355
322
356
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/GetJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/GetJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/GetJobCommandOutput/)
323
357
358
+
</details>
359
+
<details>
360
+
<summary>
361
+
GetReceivedDataGrant
362
+
</summary>
363
+
364
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/GetReceivedDataGrantCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/GetReceivedDataGrantCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/GetReceivedDataGrantCommandOutput/)
365
+
324
366
</details>
325
367
<details>
326
368
<summary>
@@ -329,6 +371,14 @@ GetRevision
329
371
330
372
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/GetRevisionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/GetRevisionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/GetRevisionCommandOutput/)
331
373
374
+
</details>
375
+
<details>
376
+
<summary>
377
+
ListDataGrants
378
+
</summary>
379
+
380
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/ListDataGrantsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/ListDataGrantsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/ListDataGrantsCommandOutput/)
381
+
332
382
</details>
333
383
<details>
334
384
<summary>
@@ -361,6 +411,14 @@ ListJobs
361
411
362
412
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/ListJobsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/ListJobsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/ListJobsCommandOutput/)
363
413
414
+
</details>
415
+
<details>
416
+
<summary>
417
+
ListReceivedDataGrants
418
+
</summary>
419
+
420
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dataexchange/command/ListReceivedDataGrantsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/ListReceivedDataGrantsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dataexchange/Interface/ListReceivedDataGrantsCommandOutput/)
0 commit comments