@aws-sdk/client-datazone 3.940.0 → 3.943.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/dist-cjs/index.js +127 -22
- package/dist-es/DataZone.js +4 -0
- package/dist-es/commands/GetDataExportConfigurationCommand.js +16 -0
- package/dist-es/commands/PutDataExportConfigurationCommand.js +16 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/enums.js +10 -3
- package/dist-es/schemas/schemas_0.js +89 -19
- package/dist-types/DataZone.d.ts +14 -0
- package/dist-types/DataZoneClient.d.ts +4 -2
- package/dist-types/commands/GetDataExportConfigurationCommand.d.ts +100 -0
- package/dist-types/commands/GetMetadataGenerationRunCommand.d.ts +13 -2
- package/dist-types/commands/ListMetadataGenerationRunsCommand.d.ts +8 -4
- package/dist-types/commands/PutDataExportConfigurationCommand.d.ts +102 -0
- package/dist-types/commands/StartMetadataGenerationRunCommand.d.ts +10 -4
- package/dist-types/commands/UpdateAccountPoolCommand.d.ts +1 -1
- package/dist-types/commands/UpdateConnectionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/enums.d.ts +26 -11
- package/dist-types/models/models_1.d.ts +158 -343
- package/dist-types/models/models_2.d.ts +342 -2
- package/dist-types/schemas/schemas_0.d.ts +11 -1
- package/dist-types/ts3.4/DataZone.d.ts +34 -0
- package/dist-types/ts3.4/DataZoneClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetDataExportConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutDataExportConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateAccountPoolCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateConnectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateEnvironmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/enums.d.ts +14 -5
- package/dist-types/ts3.4/models/models_1.d.ts +36 -78
- package/dist-types/ts3.4/models/models_2.d.ts +86 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +11 -1
- package/package.json +5 -5
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient";
|
|
4
|
+
import { PutDataExportConfigurationInput, PutDataExportConfigurationOutput } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link PutDataExportConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PutDataExportConfigurationCommandInput extends PutDataExportConfigurationInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PutDataExportConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PutDataExportConfigurationCommandOutput extends PutDataExportConfigurationOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const PutDataExportConfigurationCommand_base: {
|
|
25
|
+
new (input: PutDataExportConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<PutDataExportConfigurationCommandInput, PutDataExportConfigurationCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: PutDataExportConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<PutDataExportConfigurationCommandInput, PutDataExportConfigurationCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates data export configuration details.</p> <p>In the current release, you can enable exporting asset metadata only for one domain per Amazon Web Services account per region. If you disable exporting asset metadata feature for a domain where it's already enabled, you cannot enable this feature for another domain in the same Amazon Web Services account and region.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { DataZoneClient, PutDataExportConfigurationCommand } from "@aws-sdk/client-datazone"; // ES Modules import
|
|
35
|
+
* // const { DataZoneClient, PutDataExportConfigurationCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
|
|
36
|
+
* // import type { DataZoneClientConfig } from "@aws-sdk/client-datazone";
|
|
37
|
+
* const config = {}; // type is DataZoneClientConfig
|
|
38
|
+
* const client = new DataZoneClient(config);
|
|
39
|
+
* const input = { // PutDataExportConfigurationInput
|
|
40
|
+
* domainIdentifier: "STRING_VALUE", // required
|
|
41
|
+
* enableExport: true || false, // required
|
|
42
|
+
* encryptionConfiguration: { // EncryptionConfiguration
|
|
43
|
+
* kmsKeyArn: "STRING_VALUE",
|
|
44
|
+
* sseAlgorithm: "STRING_VALUE",
|
|
45
|
+
* },
|
|
46
|
+
* clientToken: "STRING_VALUE",
|
|
47
|
+
* };
|
|
48
|
+
* const command = new PutDataExportConfigurationCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // {};
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param PutDataExportConfigurationCommandInput - {@link PutDataExportConfigurationCommandInput}
|
|
55
|
+
* @returns {@link PutDataExportConfigurationCommandOutput}
|
|
56
|
+
* @see {@link PutDataExportConfigurationCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link PutDataExportConfigurationCommandOutput} for command's `response` shape.
|
|
58
|
+
* @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
61
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ConflictException} (client fault)
|
|
64
|
+
* <p>There is a conflict while performing this action.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServerException} (server fault)
|
|
67
|
+
* <p>The request has failed because of an unknown error, exception or failure.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
|
+
* <p>The specified resource cannot be found.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
73
|
+
* <p>The request has exceeded the specified service quota.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
76
|
+
* <p>The request was denied due to request throttling.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ValidationException} (client fault)
|
|
79
|
+
* <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
82
|
+
* <p>You do not have permission to perform this action.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link DataZoneServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from DataZone service.</p>
|
|
86
|
+
*
|
|
87
|
+
*
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export declare class PutDataExportConfigurationCommand extends PutDataExportConfigurationCommand_base {
|
|
91
|
+
/** @internal type navigation helper, not in runtime. */
|
|
92
|
+
protected static __types: {
|
|
93
|
+
api: {
|
|
94
|
+
input: PutDataExportConfigurationInput;
|
|
95
|
+
output: {};
|
|
96
|
+
};
|
|
97
|
+
sdk: {
|
|
98
|
+
input: PutDataExportConfigurationCommandInput;
|
|
99
|
+
output: PutDataExportConfigurationCommandOutput;
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
}
|
|
@@ -27,7 +27,7 @@ declare const StartMetadataGenerationRunCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Starts the metadata generation run.</p> <p>Prerequisites:</p> <ul> <li> <p>Asset must be created and belong to the specified domain and project. </p> </li> <li> <p>Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table).</p> </li> <li> <p>Asset must have a structured schema with valid rows and columns.</p> </li> <li> <p>Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES.</p> </li> <li> <p>The user must have permission to run metadata generation in the domain/project.</p> </li> </ul>
|
|
30
|
+
* <p>Starts the metadata generation run.</p> <p>Prerequisites:</p> <ul> <li> <p>Asset must be created and belong to the specified domain and project. </p> </li> <li> <p>Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table).</p> </li> <li> <p>Asset must have a structured schema with valid rows and columns.</p> </li> <li> <p>Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS.</p> </li> <li> <p>The user must have permission to run metadata generation in the domain/project.</p> </li> </ul>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -38,7 +38,10 @@ declare const StartMetadataGenerationRunCommand_base: {
|
|
|
38
38
|
* const client = new DataZoneClient(config);
|
|
39
39
|
* const input = { // StartMetadataGenerationRunInput
|
|
40
40
|
* domainIdentifier: "STRING_VALUE", // required
|
|
41
|
-
* type: "BUSINESS_DESCRIPTIONS"
|
|
41
|
+
* type: "BUSINESS_DESCRIPTIONS" || "BUSINESS_NAMES" || "BUSINESS_GLOSSARY_ASSOCIATIONS",
|
|
42
|
+
* types: [ // MetadataGenerationRunTypes
|
|
43
|
+
* "BUSINESS_DESCRIPTIONS" || "BUSINESS_NAMES" || "BUSINESS_GLOSSARY_ASSOCIATIONS",
|
|
44
|
+
* ],
|
|
42
45
|
* target: { // MetadataGenerationRunTarget
|
|
43
46
|
* type: "ASSET", // required
|
|
44
47
|
* identifier: "STRING_VALUE", // required
|
|
@@ -52,8 +55,11 @@ declare const StartMetadataGenerationRunCommand_base: {
|
|
|
52
55
|
* // { // StartMetadataGenerationRunOutput
|
|
53
56
|
* // domainId: "STRING_VALUE", // required
|
|
54
57
|
* // id: "STRING_VALUE", // required
|
|
55
|
-
* // status: "SUBMITTED" || "IN_PROGRESS" || "CANCELED" || "SUCCEEDED" || "FAILED",
|
|
56
|
-
* // type: "BUSINESS_DESCRIPTIONS",
|
|
58
|
+
* // status: "SUBMITTED" || "IN_PROGRESS" || "CANCELED" || "SUCCEEDED" || "FAILED" || "PARTIALLY_SUCCEEDED",
|
|
59
|
+
* // type: "BUSINESS_DESCRIPTIONS" || "BUSINESS_NAMES" || "BUSINESS_GLOSSARY_ASSOCIATIONS",
|
|
60
|
+
* // types: [ // MetadataGenerationRunTypes
|
|
61
|
+
* // "BUSINESS_DESCRIPTIONS" || "BUSINESS_NAMES" || "BUSINESS_GLOSSARY_ASSOCIATIONS",
|
|
62
|
+
* // ],
|
|
57
63
|
* // createdAt: new Date("TIMESTAMP"),
|
|
58
64
|
* // createdBy: "STRING_VALUE",
|
|
59
65
|
* // owningProjectId: "STRING_VALUE",
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient";
|
|
4
|
-
import { UpdateAccountPoolInput, UpdateAccountPoolOutput } from "../models/
|
|
4
|
+
import { UpdateAccountPoolInput, UpdateAccountPoolOutput } from "../models/models_2";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient";
|
|
4
|
-
import { UpdateConnectionInput, UpdateConnectionOutput } from "../models/
|
|
4
|
+
import { UpdateConnectionInput, UpdateConnectionOutput } from "../models/models_2";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient";
|
|
4
|
-
import { UpdateEnvironmentInput, UpdateEnvironmentOutput } from "../models/
|
|
4
|
+
import { UpdateEnvironmentInput, UpdateEnvironmentOutput } from "../models/models_2";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -69,6 +69,7 @@ export * from "./GetAssetCommand";
|
|
|
69
69
|
export * from "./GetAssetFilterCommand";
|
|
70
70
|
export * from "./GetAssetTypeCommand";
|
|
71
71
|
export * from "./GetConnectionCommand";
|
|
72
|
+
export * from "./GetDataExportConfigurationCommand";
|
|
72
73
|
export * from "./GetDataProductCommand";
|
|
73
74
|
export * from "./GetDataSourceCommand";
|
|
74
75
|
export * from "./GetDataSourceRunCommand";
|
|
@@ -134,6 +135,7 @@ export * from "./ListTagsForResourceCommand";
|
|
|
134
135
|
export * from "./ListTimeSeriesDataPointsCommand";
|
|
135
136
|
export * from "./PostLineageEventCommand";
|
|
136
137
|
export * from "./PostTimeSeriesDataPointsCommand";
|
|
138
|
+
export * from "./PutDataExportConfigurationCommand";
|
|
137
139
|
export * from "./PutEnvironmentBlueprintConfigurationCommand";
|
|
138
140
|
export * from "./RejectPredictionsCommand";
|
|
139
141
|
export * from "./RejectSubscriptionRequestCommand";
|
|
@@ -267,6 +267,18 @@ export declare const ConfigurableActionTypeAuthorization: {
|
|
|
267
267
|
* @public
|
|
268
268
|
*/
|
|
269
269
|
export type ConfigurableActionTypeAuthorization = (typeof ConfigurableActionTypeAuthorization)[keyof typeof ConfigurableActionTypeAuthorization];
|
|
270
|
+
/**
|
|
271
|
+
* @public
|
|
272
|
+
* @enum
|
|
273
|
+
*/
|
|
274
|
+
export declare const ConfigurationStatus: {
|
|
275
|
+
readonly COMPLETED: "COMPLETED";
|
|
276
|
+
readonly FAILED: "FAILED";
|
|
277
|
+
};
|
|
278
|
+
/**
|
|
279
|
+
* @public
|
|
280
|
+
*/
|
|
281
|
+
export type ConfigurationStatus = (typeof ConfigurationStatus)[keyof typeof ConfigurationStatus];
|
|
270
282
|
/**
|
|
271
283
|
* @public
|
|
272
284
|
* @enum
|
|
@@ -1180,6 +1192,19 @@ export declare const SortKey: {
|
|
|
1180
1192
|
* @public
|
|
1181
1193
|
*/
|
|
1182
1194
|
export type SortKey = (typeof SortKey)[keyof typeof SortKey];
|
|
1195
|
+
/**
|
|
1196
|
+
* @public
|
|
1197
|
+
* @enum
|
|
1198
|
+
*/
|
|
1199
|
+
export declare const MetadataGenerationRunType: {
|
|
1200
|
+
readonly BUSINESS_DESCRIPTIONS: "BUSINESS_DESCRIPTIONS";
|
|
1201
|
+
readonly BUSINESS_GLOSSARY_ASSOCIATIONS: "BUSINESS_GLOSSARY_ASSOCIATIONS";
|
|
1202
|
+
readonly BUSINESS_NAMES: "BUSINESS_NAMES";
|
|
1203
|
+
};
|
|
1204
|
+
/**
|
|
1205
|
+
* @public
|
|
1206
|
+
*/
|
|
1207
|
+
export type MetadataGenerationRunType = (typeof MetadataGenerationRunType)[keyof typeof MetadataGenerationRunType];
|
|
1183
1208
|
/**
|
|
1184
1209
|
* @public
|
|
1185
1210
|
* @enum
|
|
@@ -1188,6 +1213,7 @@ export declare const MetadataGenerationRunStatus: {
|
|
|
1188
1213
|
readonly CANCELED: "CANCELED";
|
|
1189
1214
|
readonly FAILED: "FAILED";
|
|
1190
1215
|
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
1216
|
+
readonly PARTIALLY_SUCCEEDED: "PARTIALLY_SUCCEEDED";
|
|
1191
1217
|
readonly SUBMITTED: "SUBMITTED";
|
|
1192
1218
|
readonly SUCCEEDED: "SUCCEEDED";
|
|
1193
1219
|
};
|
|
@@ -1206,17 +1232,6 @@ export declare const MetadataGenerationTargetType: {
|
|
|
1206
1232
|
* @public
|
|
1207
1233
|
*/
|
|
1208
1234
|
export type MetadataGenerationTargetType = (typeof MetadataGenerationTargetType)[keyof typeof MetadataGenerationTargetType];
|
|
1209
|
-
/**
|
|
1210
|
-
* @public
|
|
1211
|
-
* @enum
|
|
1212
|
-
*/
|
|
1213
|
-
export declare const MetadataGenerationRunType: {
|
|
1214
|
-
readonly BUSINESS_DESCRIPTIONS: "BUSINESS_DESCRIPTIONS";
|
|
1215
|
-
};
|
|
1216
|
-
/**
|
|
1217
|
-
* @public
|
|
1218
|
-
*/
|
|
1219
|
-
export type MetadataGenerationRunType = (typeof MetadataGenerationRunType)[keyof typeof MetadataGenerationRunType];
|
|
1220
1235
|
/**
|
|
1221
1236
|
* @public
|
|
1222
1237
|
* @enum
|