@aws-sdk/client-datazone 3.696.0 → 3.697.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 +40 -0
- package/dist-cjs/index.js +478 -45
- package/dist-es/DataZone.js +10 -0
- package/dist-es/commands/CreateRuleCommand.js +23 -0
- package/dist-es/commands/DeleteRuleCommand.js +22 -0
- package/dist-es/commands/GetDomainUnitCommand.js +1 -1
- package/dist-es/commands/GetRuleCommand.js +23 -0
- package/dist-es/commands/ListDomainsCommand.js +1 -1
- package/dist-es/commands/ListRulesCommand.js +23 -0
- package/dist-es/commands/UpdateDomainUnitCommand.js +1 -1
- package/dist-es/commands/UpdateRuleCommand.js +23 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +50 -30
- package/dist-es/models/models_1.js +65 -0
- package/dist-es/pagination/ListRulesPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +227 -0
- package/dist-types/DataZone.d.ts +35 -0
- package/dist-types/DataZoneClient.d.ts +7 -2
- package/dist-types/commands/AcceptSubscriptionRequestCommand.d.ts +9 -0
- package/dist-types/commands/CreateRuleCommand.d.ts +174 -0
- package/dist-types/commands/CreateSubscriptionRequestCommand.d.ts +17 -0
- package/dist-types/commands/DeleteDomainUnitCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEnvironmentBlueprintConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/DeleteRuleCommand.d.ts +97 -0
- package/dist-types/commands/GetDomainUnitCommand.d.ts +1 -1
- package/dist-types/commands/GetRuleCommand.d.ts +138 -0
- package/dist-types/commands/GetSubscriptionRequestDetailsCommand.d.ts +9 -0
- package/dist-types/commands/ListDomainUnitsForParentCommand.d.ts +1 -1
- package/dist-types/commands/ListDomainsCommand.d.ts +2 -1
- package/dist-types/commands/ListRulesCommand.d.ts +142 -0
- package/dist-types/commands/ListSubscriptionRequestsCommand.d.ts +8 -0
- package/dist-types/commands/RejectSubscriptionRequestCommand.d.ts +9 -0
- package/dist-types/commands/UpdateDomainCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDomainUnitCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRuleCommand.d.ts +170 -0
- package/dist-types/commands/UpdateSubscriptionRequestCommand.d.ts +9 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +741 -824
- package/dist-types/models/models_1.d.ts +3458 -2583
- package/dist-types/pagination/ListRulesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/dist-types/ts3.4/DataZone.d.ts +85 -0
- package/dist-types/ts3.4/DataZoneClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateRuleCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteDomainUnitCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteEnvironmentBlueprintConfigurationCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DeleteRuleCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetDomainUnitCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetRuleCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListDomainUnitsForParentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDomainsCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListRulesCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateDomainCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDomainUnitCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRuleCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +120 -111
- package/dist-types/ts3.4/models/models_1.d.ts +221 -0
- package/dist-types/ts3.4/pagination/ListRulesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
- package/package.json +1 -1
|
@@ -111,6 +111,15 @@ declare const RejectSubscriptionRequestCommand_base: {
|
|
|
111
111
|
* // ],
|
|
112
112
|
* // reviewerId: "STRING_VALUE",
|
|
113
113
|
* // decisionComment: "STRING_VALUE",
|
|
114
|
+
* // existingSubscriptionId: "STRING_VALUE",
|
|
115
|
+
* // metadataForms: [ // MetadataForms
|
|
116
|
+
* // { // FormOutput
|
|
117
|
+
* // formName: "STRING_VALUE", // required
|
|
118
|
+
* // typeName: "STRING_VALUE",
|
|
119
|
+
* // typeRevision: "STRING_VALUE",
|
|
120
|
+
* // content: "STRING_VALUE",
|
|
121
|
+
* // },
|
|
122
|
+
* // ],
|
|
114
123
|
* // };
|
|
115
124
|
*
|
|
116
125
|
* ```
|
|
@@ -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 { UpdateDomainInput, UpdateDomainOutput } from "../models/
|
|
4
|
+
import { UpdateDomainInput, UpdateDomainOutput } from "../models/models_1";
|
|
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 { UpdateDomainUnitInput, UpdateDomainUnitOutput } from "../models/
|
|
4
|
+
import { UpdateDomainUnitInput, UpdateDomainUnitOutput } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -0,0 +1,170 @@
|
|
|
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 { UpdateRuleInput, UpdateRuleOutput } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateRuleCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateRuleCommandInput extends UpdateRuleInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateRuleCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateRuleCommandOutput extends UpdateRuleOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateRuleCommand_base: {
|
|
25
|
+
new (input: UpdateRuleCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateRuleCommandInput, UpdateRuleCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateRuleCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateRuleCommandInput, UpdateRuleCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates a rule. In Amazon DataZone, a rule is a formal agreement that enforces specific
|
|
31
|
+
* requirements across user workflows (e.g., publishing assets to the catalog, requesting
|
|
32
|
+
* subscriptions, creating projects) within the Amazon DataZone data portal. These rules help
|
|
33
|
+
* maintain consistency, ensure compliance, and uphold governance standards in data management
|
|
34
|
+
* processes. For instance, a metadata enforcement rule can specify the required information
|
|
35
|
+
* for creating a subscription request or publishing a data asset to the catalog, ensuring
|
|
36
|
+
* alignment with organizational standards.</p>
|
|
37
|
+
* @example
|
|
38
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
39
|
+
* ```javascript
|
|
40
|
+
* import { DataZoneClient, UpdateRuleCommand } from "@aws-sdk/client-datazone"; // ES Modules import
|
|
41
|
+
* // const { DataZoneClient, UpdateRuleCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
|
|
42
|
+
* const client = new DataZoneClient(config);
|
|
43
|
+
* const input = { // UpdateRuleInput
|
|
44
|
+
* domainIdentifier: "STRING_VALUE", // required
|
|
45
|
+
* identifier: "STRING_VALUE", // required
|
|
46
|
+
* name: "STRING_VALUE",
|
|
47
|
+
* description: "STRING_VALUE",
|
|
48
|
+
* scope: { // RuleScope
|
|
49
|
+
* assetType: { // AssetTypesForRule
|
|
50
|
+
* selectionMode: "ALL" || "SPECIFIC", // required
|
|
51
|
+
* specificAssetTypes: [ // RuleAssetTypeList
|
|
52
|
+
* "STRING_VALUE",
|
|
53
|
+
* ],
|
|
54
|
+
* },
|
|
55
|
+
* dataProduct: true || false,
|
|
56
|
+
* project: { // ProjectsForRule
|
|
57
|
+
* selectionMode: "ALL" || "SPECIFIC", // required
|
|
58
|
+
* specificProjects: [ // RuleProjectIdentifierList
|
|
59
|
+
* "STRING_VALUE",
|
|
60
|
+
* ],
|
|
61
|
+
* },
|
|
62
|
+
* },
|
|
63
|
+
* detail: { // RuleDetail Union: only one key present
|
|
64
|
+
* metadataFormEnforcementDetail: { // MetadataFormEnforcementDetail
|
|
65
|
+
* requiredMetadataForms: [ // RequiredMetadataFormList
|
|
66
|
+
* { // MetadataFormReference
|
|
67
|
+
* typeIdentifier: "STRING_VALUE", // required
|
|
68
|
+
* typeRevision: "STRING_VALUE", // required
|
|
69
|
+
* },
|
|
70
|
+
* ],
|
|
71
|
+
* },
|
|
72
|
+
* },
|
|
73
|
+
* includeChildDomainUnits: true || false,
|
|
74
|
+
* };
|
|
75
|
+
* const command = new UpdateRuleCommand(input);
|
|
76
|
+
* const response = await client.send(command);
|
|
77
|
+
* // { // UpdateRuleOutput
|
|
78
|
+
* // identifier: "STRING_VALUE", // required
|
|
79
|
+
* // revision: "STRING_VALUE", // required
|
|
80
|
+
* // name: "STRING_VALUE", // required
|
|
81
|
+
* // ruleType: "METADATA_FORM_ENFORCEMENT", // required
|
|
82
|
+
* // target: { // RuleTarget Union: only one key present
|
|
83
|
+
* // domainUnitTarget: { // DomainUnitTarget
|
|
84
|
+
* // domainUnitId: "STRING_VALUE", // required
|
|
85
|
+
* // includeChildDomainUnits: true || false,
|
|
86
|
+
* // },
|
|
87
|
+
* // },
|
|
88
|
+
* // action: "CREATE_SUBSCRIPTION_REQUEST", // required
|
|
89
|
+
* // scope: { // RuleScope
|
|
90
|
+
* // assetType: { // AssetTypesForRule
|
|
91
|
+
* // selectionMode: "ALL" || "SPECIFIC", // required
|
|
92
|
+
* // specificAssetTypes: [ // RuleAssetTypeList
|
|
93
|
+
* // "STRING_VALUE",
|
|
94
|
+
* // ],
|
|
95
|
+
* // },
|
|
96
|
+
* // dataProduct: true || false,
|
|
97
|
+
* // project: { // ProjectsForRule
|
|
98
|
+
* // selectionMode: "ALL" || "SPECIFIC", // required
|
|
99
|
+
* // specificProjects: [ // RuleProjectIdentifierList
|
|
100
|
+
* // "STRING_VALUE",
|
|
101
|
+
* // ],
|
|
102
|
+
* // },
|
|
103
|
+
* // },
|
|
104
|
+
* // detail: { // RuleDetail Union: only one key present
|
|
105
|
+
* // metadataFormEnforcementDetail: { // MetadataFormEnforcementDetail
|
|
106
|
+
* // requiredMetadataForms: [ // RequiredMetadataFormList
|
|
107
|
+
* // { // MetadataFormReference
|
|
108
|
+
* // typeIdentifier: "STRING_VALUE", // required
|
|
109
|
+
* // typeRevision: "STRING_VALUE", // required
|
|
110
|
+
* // },
|
|
111
|
+
* // ],
|
|
112
|
+
* // },
|
|
113
|
+
* // },
|
|
114
|
+
* // description: "STRING_VALUE",
|
|
115
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
116
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
117
|
+
* // createdBy: "STRING_VALUE", // required
|
|
118
|
+
* // lastUpdatedBy: "STRING_VALUE", // required
|
|
119
|
+
* // };
|
|
120
|
+
*
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* @param UpdateRuleCommandInput - {@link UpdateRuleCommandInput}
|
|
124
|
+
* @returns {@link UpdateRuleCommandOutput}
|
|
125
|
+
* @see {@link UpdateRuleCommandInput} for command's `input` shape.
|
|
126
|
+
* @see {@link UpdateRuleCommandOutput} for command's `response` shape.
|
|
127
|
+
* @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape.
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
130
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link ConflictException} (client fault)
|
|
133
|
+
* <p>There is a conflict while performing this action.</p>
|
|
134
|
+
*
|
|
135
|
+
* @throws {@link InternalServerException} (server fault)
|
|
136
|
+
* <p>The request has failed because of an unknown error, exception or failure.</p>
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
139
|
+
* <p>The specified resource cannot be found.</p>
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
142
|
+
* <p>The request has exceeded the specified service quota.</p>
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
145
|
+
* <p>The request was denied due to request throttling.</p>
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link ValidationException} (client fault)
|
|
148
|
+
* <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
|
|
149
|
+
*
|
|
150
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
151
|
+
* <p>You do not have permission to perform this action.</p>
|
|
152
|
+
*
|
|
153
|
+
* @throws {@link DataZoneServiceException}
|
|
154
|
+
* <p>Base exception class for all service exceptions from DataZone service.</p>
|
|
155
|
+
*
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
export declare class UpdateRuleCommand extends UpdateRuleCommand_base {
|
|
159
|
+
/** @internal type navigation helper, not in runtime. */
|
|
160
|
+
protected static __types: {
|
|
161
|
+
api: {
|
|
162
|
+
input: UpdateRuleInput;
|
|
163
|
+
output: UpdateRuleOutput;
|
|
164
|
+
};
|
|
165
|
+
sdk: {
|
|
166
|
+
input: UpdateRuleCommandInput;
|
|
167
|
+
output: UpdateRuleCommandOutput;
|
|
168
|
+
};
|
|
169
|
+
};
|
|
170
|
+
}
|
|
@@ -111,6 +111,15 @@ declare const UpdateSubscriptionRequestCommand_base: {
|
|
|
111
111
|
* // ],
|
|
112
112
|
* // reviewerId: "STRING_VALUE",
|
|
113
113
|
* // decisionComment: "STRING_VALUE",
|
|
114
|
+
* // existingSubscriptionId: "STRING_VALUE",
|
|
115
|
+
* // metadataForms: [ // MetadataForms
|
|
116
|
+
* // { // FormOutput
|
|
117
|
+
* // formName: "STRING_VALUE", // required
|
|
118
|
+
* // typeName: "STRING_VALUE",
|
|
119
|
+
* // typeRevision: "STRING_VALUE",
|
|
120
|
+
* // content: "STRING_VALUE",
|
|
121
|
+
* // },
|
|
122
|
+
* // ],
|
|
114
123
|
* // };
|
|
115
124
|
*
|
|
116
125
|
* ```
|
|
@@ -24,6 +24,7 @@ export * from "./CreateGroupProfileCommand";
|
|
|
24
24
|
export * from "./CreateListingChangeSetCommand";
|
|
25
25
|
export * from "./CreateProjectCommand";
|
|
26
26
|
export * from "./CreateProjectMembershipCommand";
|
|
27
|
+
export * from "./CreateRuleCommand";
|
|
27
28
|
export * from "./CreateSubscriptionGrantCommand";
|
|
28
29
|
export * from "./CreateSubscriptionRequestCommand";
|
|
29
30
|
export * from "./CreateSubscriptionTargetCommand";
|
|
@@ -45,6 +46,7 @@ export * from "./DeleteGlossaryTermCommand";
|
|
|
45
46
|
export * from "./DeleteListingCommand";
|
|
46
47
|
export * from "./DeleteProjectCommand";
|
|
47
48
|
export * from "./DeleteProjectMembershipCommand";
|
|
49
|
+
export * from "./DeleteRuleCommand";
|
|
48
50
|
export * from "./DeleteSubscriptionGrantCommand";
|
|
49
51
|
export * from "./DeleteSubscriptionRequestCommand";
|
|
50
52
|
export * from "./DeleteSubscriptionTargetCommand";
|
|
@@ -73,6 +75,7 @@ export * from "./GetLineageNodeCommand";
|
|
|
73
75
|
export * from "./GetListingCommand";
|
|
74
76
|
export * from "./GetMetadataGenerationRunCommand";
|
|
75
77
|
export * from "./GetProjectCommand";
|
|
78
|
+
export * from "./GetRuleCommand";
|
|
76
79
|
export * from "./GetSubscriptionCommand";
|
|
77
80
|
export * from "./GetSubscriptionGrantCommand";
|
|
78
81
|
export * from "./GetSubscriptionRequestDetailsCommand";
|
|
@@ -99,6 +102,7 @@ export * from "./ListNotificationsCommand";
|
|
|
99
102
|
export * from "./ListPolicyGrantsCommand";
|
|
100
103
|
export * from "./ListProjectMembershipsCommand";
|
|
101
104
|
export * from "./ListProjectsCommand";
|
|
105
|
+
export * from "./ListRulesCommand";
|
|
102
106
|
export * from "./ListSubscriptionGrantsCommand";
|
|
103
107
|
export * from "./ListSubscriptionRequestsCommand";
|
|
104
108
|
export * from "./ListSubscriptionTargetsCommand";
|
|
@@ -133,6 +137,7 @@ export * from "./UpdateGlossaryCommand";
|
|
|
133
137
|
export * from "./UpdateGlossaryTermCommand";
|
|
134
138
|
export * from "./UpdateGroupProfileCommand";
|
|
135
139
|
export * from "./UpdateProjectCommand";
|
|
140
|
+
export * from "./UpdateRuleCommand";
|
|
136
141
|
export * from "./UpdateSubscriptionGrantStatusCommand";
|
|
137
142
|
export * from "./UpdateSubscriptionRequestCommand";
|
|
138
143
|
export * from "./UpdateSubscriptionTargetCommand";
|