@aws-sdk/client-dataexchange 3.1019.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 (41) hide show
  1. package/README.md +1 -18
  2. package/dist-cjs/schemas/schemas_0.js +31 -14
  3. package/dist-es/DataExchange.js +5 -5
  4. package/dist-es/schemas/schemas_0.js +27 -10
  5. package/dist-types/DataExchange.d.ts +38 -55
  6. package/dist-types/DataExchangeClient.d.ts +41 -58
  7. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +1 -1
  8. package/dist-types/commands/AcceptDataGrantCommand.d.ts +1 -2
  9. package/dist-types/commands/CancelJobCommand.d.ts +2 -4
  10. package/dist-types/commands/CreateJobCommand.d.ts +17 -2
  11. package/dist-types/commands/DeleteAssetCommand.d.ts +1 -2
  12. package/dist-types/commands/DeleteDataSetCommand.d.ts +1 -2
  13. package/dist-types/commands/DeleteRevisionCommand.d.ts +1 -2
  14. package/dist-types/commands/GetAssetCommand.d.ts +3 -0
  15. package/dist-types/commands/GetJobCommand.d.ts +8 -0
  16. package/dist-types/commands/ListDataSetRevisionsCommand.d.ts +1 -2
  17. package/dist-types/commands/ListDataSetsCommand.d.ts +1 -2
  18. package/dist-types/commands/ListJobsCommand.d.ts +8 -0
  19. package/dist-types/commands/ListRevisionAssetsCommand.d.ts +1 -2
  20. package/dist-types/commands/RevokeRevisionCommand.d.ts +1 -2
  21. package/dist-types/commands/SendApiAssetCommand.d.ts +1 -2
  22. package/dist-types/commands/SendDataSetNotificationCommand.d.ts +1 -2
  23. package/dist-types/commands/StartJobCommand.d.ts +1 -2
  24. package/dist-types/commands/UpdateAssetCommand.d.ts +1 -2
  25. package/dist-types/commands/UpdateRevisionCommand.d.ts +1 -2
  26. package/dist-types/index.d.ts +2 -19
  27. package/dist-types/models/errors.d.ts +3 -5
  28. package/dist-types/models/models_0.d.ts +170 -321
  29. package/dist-types/pagination/ListDataGrantsPaginator.d.ts +1 -1
  30. package/dist-types/pagination/ListDataSetRevisionsPaginator.d.ts +1 -1
  31. package/dist-types/pagination/ListDataSetsPaginator.d.ts +1 -1
  32. package/dist-types/pagination/ListEventActionsPaginator.d.ts +1 -1
  33. package/dist-types/pagination/ListJobsPaginator.d.ts +1 -1
  34. package/dist-types/pagination/ListReceivedDataGrantsPaginator.d.ts +1 -1
  35. package/dist-types/pagination/ListRevisionAssetsPaginator.d.ts +1 -1
  36. package/dist-types/schemas/schemas_0.d.ts +2 -0
  37. package/dist-types/ts3.4/DataExchangeClient.d.ts +2 -3
  38. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +1 -1
  39. package/dist-types/ts3.4/models/models_0.d.ts +12 -0
  40. package/dist-types/ts3.4/schemas/schemas_0.d.ts +2 -0
  41. package/package.json +14 -14
@@ -37,6 +37,14 @@ declare const CreateJobCommand_base: {
37
37
  * const config = {}; // type is DataExchangeClientConfig
38
38
  * const client = new DataExchangeClient(config);
39
39
  * const input = { // CreateJobRequest
40
+ * AssetConfiguration: { // AssetConfiguration
41
+ * Tags: [ // ListOfTag
42
+ * { // Tag
43
+ * Key: "STRING_VALUE", // required
44
+ * Value: "STRING_VALUE", // required
45
+ * },
46
+ * ],
47
+ * },
40
48
  * Details: { // RequestDetails
41
49
  * ExportAssetToSignedUrl: { // ExportAssetToSignedUrlRequestDetails
42
50
  * AssetId: "STRING_VALUE", // required
@@ -165,6 +173,14 @@ declare const CreateJobCommand_base: {
165
173
  * const response = await client.send(command);
166
174
  * // { // CreateJobResponse
167
175
  * // Arn: "STRING_VALUE",
176
+ * // AssetConfiguration: { // AssetConfiguration
177
+ * // Tags: [ // ListOfTag
178
+ * // { // Tag
179
+ * // Key: "STRING_VALUE", // required
180
+ * // Value: "STRING_VALUE", // required
181
+ * // },
182
+ * // ],
183
+ * // },
168
184
  * // CreatedAt: new Date("TIMESTAMP"),
169
185
  * // Details: { // ResponseDetails
170
186
  * // ExportAssetToSignedUrl: { // ExportAssetToSignedUrlResponseDetails
@@ -334,8 +350,7 @@ declare const CreateJobCommand_base: {
334
350
  * <p>Access to the resource is denied.</p>
335
351
  *
336
352
  * @throws {@link ConflictException} (client fault)
337
- * <p>The request couldn't be completed because it conflicted with the current state of the
338
- * resource.</p>
353
+ * <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
339
354
  *
340
355
  * @throws {@link InternalServerException} (server fault)
341
356
  * <p>An exception occurred with the service.</p>
@@ -57,8 +57,7 @@ declare const DeleteAssetCommand_base: {
57
57
  * <p>Access to the resource is denied.</p>
58
58
  *
59
59
  * @throws {@link ConflictException} (client fault)
60
- * <p>The request couldn't be completed because it conflicted with the current state of the
61
- * resource.</p>
60
+ * <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
62
61
  *
63
62
  * @throws {@link InternalServerException} (server fault)
64
63
  * <p>An exception occurred with the service.</p>
@@ -55,8 +55,7 @@ declare const DeleteDataSetCommand_base: {
55
55
  * <p>Access to the resource is denied.</p>
56
56
  *
57
57
  * @throws {@link ConflictException} (client fault)
58
- * <p>The request couldn't be completed because it conflicted with the current state of the
59
- * resource.</p>
58
+ * <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
60
59
  *
61
60
  * @throws {@link InternalServerException} (server fault)
62
61
  * <p>An exception occurred with the service.</p>
@@ -56,8 +56,7 @@ declare const DeleteRevisionCommand_base: {
56
56
  * <p>Access to the resource is denied.</p>
57
57
  *
58
58
  * @throws {@link ConflictException} (client fault)
59
- * <p>The request couldn't be completed because it conflicted with the current state of the
60
- * resource.</p>
59
+ * <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
61
60
  *
62
61
  * @throws {@link InternalServerException} (server fault)
63
62
  * <p>An exception occurred with the service.</p>
@@ -122,6 +122,9 @@ declare const GetAssetCommand_base: {
122
122
  * // Name: "STRING_VALUE",
123
123
  * // RevisionId: "STRING_VALUE",
124
124
  * // SourceId: "STRING_VALUE",
125
+ * // Tags: { // MapOf__string
126
+ * // "<keys>": "STRING_VALUE",
127
+ * // },
125
128
  * // UpdatedAt: new Date("TIMESTAMP"),
126
129
  * // };
127
130
  *
@@ -43,6 +43,14 @@ declare const GetJobCommand_base: {
43
43
  * const response = await client.send(command);
44
44
  * // { // GetJobResponse
45
45
  * // Arn: "STRING_VALUE",
46
+ * // AssetConfiguration: { // AssetConfiguration
47
+ * // Tags: [ // ListOfTag
48
+ * // { // Tag
49
+ * // Key: "STRING_VALUE", // required
50
+ * // Value: "STRING_VALUE", // required
51
+ * // },
52
+ * // ],
53
+ * // },
46
54
  * // CreatedAt: new Date("TIMESTAMP"),
47
55
  * // Details: { // ResponseDetails
48
56
  * // ExportAssetToSignedUrl: { // ExportAssetToSignedUrlResponseDetails
@@ -27,8 +27,7 @@ declare const ListDataSetRevisionsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>This operation lists a data set's revisions sorted by CreatedAt in descending
31
- * order.</p>
30
+ * <p>This operation lists a data set's revisions sorted by CreatedAt in descending order.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const ListDataSetsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>This operation lists your data sets. When listing by origin OWNED, results are sorted by
31
- * CreatedAt in descending order. When listing by origin ENTITLED, there is no order.</p>
30
+ * <p>This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -48,6 +48,14 @@ declare const ListJobsCommand_base: {
48
48
  * // Jobs: [ // ListOfJobEntry
49
49
  * // { // JobEntry
50
50
  * // Arn: "STRING_VALUE", // required
51
+ * // AssetConfiguration: { // AssetConfiguration
52
+ * // Tags: [ // ListOfTag
53
+ * // { // Tag
54
+ * // Key: "STRING_VALUE", // required
55
+ * // Value: "STRING_VALUE", // required
56
+ * // },
57
+ * // ],
58
+ * // },
51
59
  * // CreatedAt: new Date("TIMESTAMP"), // required
52
60
  * // Details: { // ResponseDetails
53
61
  * // ExportAssetToSignedUrl: { // ExportAssetToSignedUrlResponseDetails
@@ -27,8 +27,7 @@ declare const ListRevisionAssetsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>This operation lists a revision's assets sorted alphabetically in descending
31
- * order.</p>
30
+ * <p>This operation lists a revision's assets sorted alphabetically in descending order.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -69,8 +69,7 @@ declare const RevokeRevisionCommand_base: {
69
69
  * <p>Access to the resource is denied.</p>
70
70
  *
71
71
  * @throws {@link ConflictException} (client fault)
72
- * <p>The request couldn't be completed because it conflicted with the current state of the
73
- * resource.</p>
72
+ * <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
74
73
  *
75
74
  * @throws {@link InternalServerException} (server fault)
76
75
  * <p>An exception occurred with the service.</p>
@@ -27,8 +27,7 @@ declare const SendApiAssetCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>This operation invokes an API Gateway API asset. The request is proxied to the
31
- * provider’s API Gateway API.</p>
30
+ * <p>This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -104,8 +104,7 @@ declare const SendDataSetNotificationCommand_base: {
104
104
  * <p>Access to the resource is denied.</p>
105
105
  *
106
106
  * @throws {@link ConflictException} (client fault)
107
- * <p>The request couldn't be completed because it conflicted with the current state of the
108
- * resource.</p>
107
+ * <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
109
108
  *
110
109
  * @throws {@link InternalServerException} (server fault)
111
110
  * <p>An exception occurred with the service.</p>
@@ -55,8 +55,7 @@ declare const StartJobCommand_base: {
55
55
  * <p>Access to the resource is denied.</p>
56
56
  *
57
57
  * @throws {@link ConflictException} (client fault)
58
- * <p>The request couldn't be completed because it conflicted with the current state of the
59
- * resource.</p>
58
+ * <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
60
59
  *
61
60
  * @throws {@link InternalServerException} (server fault)
62
61
  * <p>An exception occurred with the service.</p>
@@ -138,8 +138,7 @@ declare const UpdateAssetCommand_base: {
138
138
  * <p>Access to the resource is denied.</p>
139
139
  *
140
140
  * @throws {@link ConflictException} (client fault)
141
- * <p>The request couldn't be completed because it conflicted with the current state of the
142
- * resource.</p>
141
+ * <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
143
142
  *
144
143
  * @throws {@link InternalServerException} (server fault)
145
144
  * <p>An exception occurred with the service.</p>
@@ -70,8 +70,7 @@ declare const UpdateRevisionCommand_base: {
70
70
  * <p>Access to the resource is denied.</p>
71
71
  *
72
72
  * @throws {@link ConflictException} (client fault)
73
- * <p>The request couldn't be completed because it conflicted with the current state of the
74
- * resource.</p>
73
+ * <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
75
74
  *
76
75
  * @throws {@link InternalServerException} (server fault)
77
76
  * <p>An exception occurred with the service.</p>
@@ -1,28 +1,11 @@
1
1
  /**
2
- * <p>AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in
3
- * the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access
4
- * file-based data set in the AWS Cloud.</p>
5
- * <p>As a subscriber, you can view and access the data sets that you have an entitlement to
6
- * through a subscription. You can use the APIs to download or copy your entitled data sets to
7
- * Amazon Simple Storage Service (Amazon S3) for use across a variety of AWS analytics and
8
- * machine learning services.</p>
9
- * <p>As a provider, you can create and manage your data sets that you would like to publish
10
- * to a product. Being able to package and provide your data sets into products requires a few
11
- * steps to determine eligibility. For more information, visit the <i>AWS Data Exchange
12
- * User Guide</i>.</p>
13
- * <p>A data set is a collection of data that can be changed or updated over time. Data sets
14
- * can be updated using revisions, which represent a new version or incremental change to a
15
- * data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece
16
- * of data that can be stored as an Amazon S3 object, Redshift datashare, API Gateway API, AWS
17
- * Lake Formation data permission, or Amazon S3 data access. The asset can be a structured
18
- * data file, an image file, or some other data file. Jobs are asynchronous import or export
19
- * operations used to create or copy assets.</p>
2
+ * <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> <p>As a subscriber, you can view and access the data sets that you have an entitlement to through a subscription. You can use the APIs to download or copy your entitled data sets to Amazon Simple Storage Service (Amazon S3) for use across a variety of AWS analytics and machine learning services.</p> <p>As a provider, you can create and manage your data sets that you would like to publish to a product. Being able to package and provide your data sets into products requires a few steps to determine eligibility. For more information, visit the <i>AWS Data Exchange User Guide</i>.</p> <p>A data set is a collection of data that can be changed or updated over time. Data sets can be updated using revisions, which represent a new version or incremental change to a data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data that can be stored as an Amazon S3 object, Redshift datashare, 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. Jobs are asynchronous import or export operations used to create or copy assets.</p>
20
3
  *
21
4
  * @packageDocumentation
22
5
  */
23
6
  export * from "./DataExchangeClient";
24
7
  export * from "./DataExchange";
25
- export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
8
+ export type { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
26
9
  export type { RuntimeExtension } from "./runtimeExtensions";
27
10
  export type { DataExchangeExtensionConfiguration } from "./extensionConfiguration";
28
11
  export * from "./commands";
@@ -1,6 +1,6 @@
1
1
  import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { DataExchangeServiceException as __BaseException } from "./DataExchangeServiceException";
3
- import { ExceptionCause, LimitName, ResourceType } from "./enums";
3
+ import type { ExceptionCause, LimitName, ResourceType } from "./enums";
4
4
  /**
5
5
  * <p>Access to the resource is denied.</p>
6
6
  * @public
@@ -19,16 +19,14 @@ export declare class AccessDeniedException extends __BaseException {
19
19
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
20
20
  }
21
21
  /**
22
- * <p>The request couldn't be completed because it conflicted with the current state of the
23
- * resource.</p>
22
+ * <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
24
23
  * @public
25
24
  */
26
25
  export declare class ConflictException extends __BaseException {
27
26
  readonly name: "ConflictException";
28
27
  readonly $fault: "client";
29
28
  /**
30
- * <p>The request couldn't be completed because it conflicted with the current state of the
31
- * resource.</p>
29
+ * <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
32
30
  * @public
33
31
  */
34
32
  Message: string | undefined;