@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.
Files changed (64) hide show
  1. package/README.md +40 -0
  2. package/dist-cjs/index.js +478 -45
  3. package/dist-es/DataZone.js +10 -0
  4. package/dist-es/commands/CreateRuleCommand.js +23 -0
  5. package/dist-es/commands/DeleteRuleCommand.js +22 -0
  6. package/dist-es/commands/GetDomainUnitCommand.js +1 -1
  7. package/dist-es/commands/GetRuleCommand.js +23 -0
  8. package/dist-es/commands/ListDomainsCommand.js +1 -1
  9. package/dist-es/commands/ListRulesCommand.js +23 -0
  10. package/dist-es/commands/UpdateDomainUnitCommand.js +1 -1
  11. package/dist-es/commands/UpdateRuleCommand.js +23 -0
  12. package/dist-es/commands/index.js +5 -0
  13. package/dist-es/models/models_0.js +50 -30
  14. package/dist-es/models/models_1.js +65 -0
  15. package/dist-es/pagination/ListRulesPaginator.js +4 -0
  16. package/dist-es/pagination/index.js +1 -0
  17. package/dist-es/protocols/Aws_restJson1.js +227 -0
  18. package/dist-types/DataZone.d.ts +35 -0
  19. package/dist-types/DataZoneClient.d.ts +7 -2
  20. package/dist-types/commands/AcceptSubscriptionRequestCommand.d.ts +9 -0
  21. package/dist-types/commands/CreateRuleCommand.d.ts +174 -0
  22. package/dist-types/commands/CreateSubscriptionRequestCommand.d.ts +17 -0
  23. package/dist-types/commands/DeleteDomainUnitCommand.d.ts +1 -1
  24. package/dist-types/commands/DeleteEnvironmentBlueprintConfigurationCommand.d.ts +1 -2
  25. package/dist-types/commands/DeleteRuleCommand.d.ts +97 -0
  26. package/dist-types/commands/GetDomainUnitCommand.d.ts +1 -1
  27. package/dist-types/commands/GetRuleCommand.d.ts +138 -0
  28. package/dist-types/commands/GetSubscriptionRequestDetailsCommand.d.ts +9 -0
  29. package/dist-types/commands/ListDomainUnitsForParentCommand.d.ts +1 -1
  30. package/dist-types/commands/ListDomainsCommand.d.ts +2 -1
  31. package/dist-types/commands/ListRulesCommand.d.ts +142 -0
  32. package/dist-types/commands/ListSubscriptionRequestsCommand.d.ts +8 -0
  33. package/dist-types/commands/RejectSubscriptionRequestCommand.d.ts +9 -0
  34. package/dist-types/commands/UpdateDomainCommand.d.ts +1 -1
  35. package/dist-types/commands/UpdateDomainUnitCommand.d.ts +1 -1
  36. package/dist-types/commands/UpdateRuleCommand.d.ts +170 -0
  37. package/dist-types/commands/UpdateSubscriptionRequestCommand.d.ts +9 -0
  38. package/dist-types/commands/index.d.ts +5 -0
  39. package/dist-types/models/models_0.d.ts +741 -824
  40. package/dist-types/models/models_1.d.ts +3458 -2583
  41. package/dist-types/pagination/ListRulesPaginator.d.ts +7 -0
  42. package/dist-types/pagination/index.d.ts +1 -0
  43. package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
  44. package/dist-types/ts3.4/DataZone.d.ts +85 -0
  45. package/dist-types/ts3.4/DataZoneClient.d.ts +30 -0
  46. package/dist-types/ts3.4/commands/CreateRuleCommand.d.ts +47 -0
  47. package/dist-types/ts3.4/commands/DeleteDomainUnitCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/DeleteEnvironmentBlueprintConfigurationCommand.d.ts +4 -2
  49. package/dist-types/ts3.4/commands/DeleteRuleCommand.d.ts +47 -0
  50. package/dist-types/ts3.4/commands/GetDomainUnitCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/GetRuleCommand.d.ts +41 -0
  52. package/dist-types/ts3.4/commands/ListDomainUnitsForParentCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/ListDomainsCommand.d.ts +2 -1
  54. package/dist-types/ts3.4/commands/ListRulesCommand.d.ts +47 -0
  55. package/dist-types/ts3.4/commands/UpdateDomainCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/UpdateDomainUnitCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/UpdateRuleCommand.d.ts +47 -0
  58. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  59. package/dist-types/ts3.4/models/models_0.d.ts +120 -111
  60. package/dist-types/ts3.4/models/models_1.d.ts +221 -0
  61. package/dist-types/ts3.4/pagination/ListRulesPaginator.d.ts +11 -0
  62. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  63. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
  64. package/package.json +1 -1
@@ -0,0 +1,174 @@
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 { CreateRuleInput, CreateRuleOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CreateRuleCommand}.
14
+ */
15
+ export interface CreateRuleCommandInput extends CreateRuleInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateRuleCommand}.
21
+ */
22
+ export interface CreateRuleCommandOutput extends CreateRuleOutput, __MetadataBearer {
23
+ }
24
+ declare const CreateRuleCommand_base: {
25
+ new (input: CreateRuleCommandInput): import("@smithy/smithy-client").CommandImpl<CreateRuleCommandInput, CreateRuleCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateRuleCommandInput): import("@smithy/smithy-client").CommandImpl<CreateRuleCommandInput, CreateRuleCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates 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, CreateRuleCommand } from "@aws-sdk/client-datazone"; // ES Modules import
41
+ * // const { DataZoneClient, CreateRuleCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
42
+ * const client = new DataZoneClient(config);
43
+ * const input = { // CreateRuleInput
44
+ * domainIdentifier: "STRING_VALUE", // required
45
+ * name: "STRING_VALUE", // required
46
+ * target: { // RuleTarget Union: only one key present
47
+ * domainUnitTarget: { // DomainUnitTarget
48
+ * domainUnitId: "STRING_VALUE", // required
49
+ * includeChildDomainUnits: true || false,
50
+ * },
51
+ * },
52
+ * action: "CREATE_SUBSCRIPTION_REQUEST", // required
53
+ * scope: { // RuleScope
54
+ * assetType: { // AssetTypesForRule
55
+ * selectionMode: "ALL" || "SPECIFIC", // required
56
+ * specificAssetTypes: [ // RuleAssetTypeList
57
+ * "STRING_VALUE",
58
+ * ],
59
+ * },
60
+ * dataProduct: true || false,
61
+ * project: { // ProjectsForRule
62
+ * selectionMode: "ALL" || "SPECIFIC", // required
63
+ * specificProjects: [ // RuleProjectIdentifierList
64
+ * "STRING_VALUE",
65
+ * ],
66
+ * },
67
+ * },
68
+ * detail: { // RuleDetail Union: only one key present
69
+ * metadataFormEnforcementDetail: { // MetadataFormEnforcementDetail
70
+ * requiredMetadataForms: [ // RequiredMetadataFormList
71
+ * { // MetadataFormReference
72
+ * typeIdentifier: "STRING_VALUE", // required
73
+ * typeRevision: "STRING_VALUE", // required
74
+ * },
75
+ * ],
76
+ * },
77
+ * },
78
+ * description: "STRING_VALUE",
79
+ * clientToken: "STRING_VALUE",
80
+ * };
81
+ * const command = new CreateRuleCommand(input);
82
+ * const response = await client.send(command);
83
+ * // { // CreateRuleOutput
84
+ * // identifier: "STRING_VALUE", // required
85
+ * // name: "STRING_VALUE", // required
86
+ * // ruleType: "METADATA_FORM_ENFORCEMENT", // required
87
+ * // target: { // RuleTarget Union: only one key present
88
+ * // domainUnitTarget: { // DomainUnitTarget
89
+ * // domainUnitId: "STRING_VALUE", // required
90
+ * // includeChildDomainUnits: true || false,
91
+ * // },
92
+ * // },
93
+ * // action: "CREATE_SUBSCRIPTION_REQUEST", // required
94
+ * // scope: { // RuleScope
95
+ * // assetType: { // AssetTypesForRule
96
+ * // selectionMode: "ALL" || "SPECIFIC", // required
97
+ * // specificAssetTypes: [ // RuleAssetTypeList
98
+ * // "STRING_VALUE",
99
+ * // ],
100
+ * // },
101
+ * // dataProduct: true || false,
102
+ * // project: { // ProjectsForRule
103
+ * // selectionMode: "ALL" || "SPECIFIC", // required
104
+ * // specificProjects: [ // RuleProjectIdentifierList
105
+ * // "STRING_VALUE",
106
+ * // ],
107
+ * // },
108
+ * // },
109
+ * // detail: { // RuleDetail Union: only one key present
110
+ * // metadataFormEnforcementDetail: { // MetadataFormEnforcementDetail
111
+ * // requiredMetadataForms: [ // RequiredMetadataFormList
112
+ * // { // MetadataFormReference
113
+ * // typeIdentifier: "STRING_VALUE", // required
114
+ * // typeRevision: "STRING_VALUE", // required
115
+ * // },
116
+ * // ],
117
+ * // },
118
+ * // },
119
+ * // targetType: "DOMAIN_UNIT",
120
+ * // description: "STRING_VALUE",
121
+ * // createdAt: new Date("TIMESTAMP"), // required
122
+ * // createdBy: "STRING_VALUE", // required
123
+ * // };
124
+ *
125
+ * ```
126
+ *
127
+ * @param CreateRuleCommandInput - {@link CreateRuleCommandInput}
128
+ * @returns {@link CreateRuleCommandOutput}
129
+ * @see {@link CreateRuleCommandInput} for command's `input` shape.
130
+ * @see {@link CreateRuleCommandOutput} for command's `response` shape.
131
+ * @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape.
132
+ *
133
+ * @throws {@link AccessDeniedException} (client fault)
134
+ * <p>You do not have sufficient access to perform this action.</p>
135
+ *
136
+ * @throws {@link ConflictException} (client fault)
137
+ * <p>There is a conflict while performing this action.</p>
138
+ *
139
+ * @throws {@link InternalServerException} (server fault)
140
+ * <p>The request has failed because of an unknown error, exception or failure.</p>
141
+ *
142
+ * @throws {@link ResourceNotFoundException} (client fault)
143
+ * <p>The specified resource cannot be found.</p>
144
+ *
145
+ * @throws {@link ServiceQuotaExceededException} (client fault)
146
+ * <p>The request has exceeded the specified service quota.</p>
147
+ *
148
+ * @throws {@link ThrottlingException} (client fault)
149
+ * <p>The request was denied due to request throttling.</p>
150
+ *
151
+ * @throws {@link ValidationException} (client fault)
152
+ * <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
153
+ *
154
+ * @throws {@link UnauthorizedException} (client fault)
155
+ * <p>You do not have permission to perform this action.</p>
156
+ *
157
+ * @throws {@link DataZoneServiceException}
158
+ * <p>Base exception class for all service exceptions from DataZone service.</p>
159
+ *
160
+ * @public
161
+ */
162
+ export declare class CreateRuleCommand extends CreateRuleCommand_base {
163
+ /** @internal type navigation helper, not in runtime. */
164
+ protected static __types: {
165
+ api: {
166
+ input: CreateRuleInput;
167
+ output: CreateRuleOutput;
168
+ };
169
+ sdk: {
170
+ input: CreateRuleCommandInput;
171
+ output: CreateRuleCommandOutput;
172
+ };
173
+ };
174
+ }
@@ -50,6 +50,14 @@ declare const CreateSubscriptionRequestCommand_base: {
50
50
  * ],
51
51
  * requestReason: "STRING_VALUE", // required
52
52
  * clientToken: "STRING_VALUE",
53
+ * metadataForms: [ // MetadataFormInputs
54
+ * { // FormInput
55
+ * formName: "STRING_VALUE", // required
56
+ * typeIdentifier: "STRING_VALUE",
57
+ * typeRevision: "STRING_VALUE",
58
+ * content: "STRING_VALUE",
59
+ * },
60
+ * ],
53
61
  * };
54
62
  * const command = new CreateSubscriptionRequestCommand(input);
55
63
  * const response = await client.send(command);
@@ -123,6 +131,15 @@ declare const CreateSubscriptionRequestCommand_base: {
123
131
  * // ],
124
132
  * // reviewerId: "STRING_VALUE",
125
133
  * // decisionComment: "STRING_VALUE",
134
+ * // existingSubscriptionId: "STRING_VALUE",
135
+ * // metadataForms: [ // MetadataForms
136
+ * // { // FormOutput
137
+ * // formName: "STRING_VALUE", // required
138
+ * // typeName: "STRING_VALUE",
139
+ * // typeRevision: "STRING_VALUE",
140
+ * // content: "STRING_VALUE",
141
+ * // },
142
+ * // ],
126
143
  * // };
127
144
  *
128
145
  * ```
@@ -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 { DeleteDomainUnitInput, DeleteDomainUnitOutput } from "../models/models_0";
4
+ import { DeleteDomainUnitInput, DeleteDomainUnitOutput } from "../models/models_1";
5
5
  /**
6
6
  * @public
7
7
  */
@@ -1,8 +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 { DeleteEnvironmentBlueprintConfigurationInput } from "../models/models_0";
5
- import { DeleteEnvironmentBlueprintConfigurationOutput } from "../models/models_1";
4
+ import { DeleteEnvironmentBlueprintConfigurationInput, DeleteEnvironmentBlueprintConfigurationOutput } from "../models/models_1";
6
5
  /**
7
6
  * @public
8
7
  */
@@ -0,0 +1,97 @@
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 { DeleteRuleInput, DeleteRuleOutput } from "../models/models_1";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteRuleCommand}.
14
+ */
15
+ export interface DeleteRuleCommandInput extends DeleteRuleInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteRuleCommand}.
21
+ */
22
+ export interface DeleteRuleCommandOutput extends DeleteRuleOutput, __MetadataBearer {
23
+ }
24
+ declare const DeleteRuleCommand_base: {
25
+ new (input: DeleteRuleCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteRuleCommandInput, DeleteRuleCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteRuleCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteRuleCommandInput, DeleteRuleCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes 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, DeleteRuleCommand } from "@aws-sdk/client-datazone"; // ES Modules import
41
+ * // const { DataZoneClient, DeleteRuleCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
42
+ * const client = new DataZoneClient(config);
43
+ * const input = { // DeleteRuleInput
44
+ * domainIdentifier: "STRING_VALUE", // required
45
+ * identifier: "STRING_VALUE", // required
46
+ * };
47
+ * const command = new DeleteRuleCommand(input);
48
+ * const response = await client.send(command);
49
+ * // {};
50
+ *
51
+ * ```
52
+ *
53
+ * @param DeleteRuleCommandInput - {@link DeleteRuleCommandInput}
54
+ * @returns {@link DeleteRuleCommandOutput}
55
+ * @see {@link DeleteRuleCommandInput} for command's `input` shape.
56
+ * @see {@link DeleteRuleCommandOutput} for command's `response` shape.
57
+ * @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape.
58
+ *
59
+ * @throws {@link AccessDeniedException} (client fault)
60
+ * <p>You do not have sufficient access to perform this action.</p>
61
+ *
62
+ * @throws {@link ConflictException} (client fault)
63
+ * <p>There is a conflict while performing this action.</p>
64
+ *
65
+ * @throws {@link InternalServerException} (server fault)
66
+ * <p>The request has failed because of an unknown error, exception or failure.</p>
67
+ *
68
+ * @throws {@link ResourceNotFoundException} (client fault)
69
+ * <p>The specified resource cannot be found.</p>
70
+ *
71
+ * @throws {@link ThrottlingException} (client fault)
72
+ * <p>The request was denied due to request throttling.</p>
73
+ *
74
+ * @throws {@link ValidationException} (client fault)
75
+ * <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
76
+ *
77
+ * @throws {@link UnauthorizedException} (client fault)
78
+ * <p>You do not have permission to perform this action.</p>
79
+ *
80
+ * @throws {@link DataZoneServiceException}
81
+ * <p>Base exception class for all service exceptions from DataZone service.</p>
82
+ *
83
+ * @public
84
+ */
85
+ export declare class DeleteRuleCommand extends DeleteRuleCommand_base {
86
+ /** @internal type navigation helper, not in runtime. */
87
+ protected static __types: {
88
+ api: {
89
+ input: DeleteRuleInput;
90
+ output: {};
91
+ };
92
+ sdk: {
93
+ input: DeleteRuleCommandInput;
94
+ output: DeleteRuleCommandOutput;
95
+ };
96
+ };
97
+ }
@@ -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 { GetDomainUnitInput, GetDomainUnitOutput } from "../models/models_0";
4
+ import { GetDomainUnitInput, GetDomainUnitOutput } from "../models/models_1";
5
5
  /**
6
6
  * @public
7
7
  */
@@ -0,0 +1,138 @@
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 { GetRuleInput, GetRuleOutput } from "../models/models_1";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetRuleCommand}.
14
+ */
15
+ export interface GetRuleCommandInput extends GetRuleInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetRuleCommand}.
21
+ */
22
+ export interface GetRuleCommandOutput extends GetRuleOutput, __MetadataBearer {
23
+ }
24
+ declare const GetRuleCommand_base: {
25
+ new (input: GetRuleCommandInput): import("@smithy/smithy-client").CommandImpl<GetRuleCommandInput, GetRuleCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetRuleCommandInput): import("@smithy/smithy-client").CommandImpl<GetRuleCommandInput, GetRuleCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Gets the details of a rule in Amazon DataZone. A rule is a formal agreement that
31
+ * enforces specific requirements across user workflows (e.g., publishing assets to the
32
+ * catalog, requesting subscriptions, creating projects) within the Amazon DataZone data
33
+ * portal. These rules help maintain consistency, ensure compliance, and uphold governance
34
+ * standards in data management processes. For instance, a metadata enforcement rule can
35
+ * specify the required information for creating a subscription request or publishing a data
36
+ * asset to the catalog, ensuring 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, GetRuleCommand } from "@aws-sdk/client-datazone"; // ES Modules import
41
+ * // const { DataZoneClient, GetRuleCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
42
+ * const client = new DataZoneClient(config);
43
+ * const input = { // GetRuleInput
44
+ * domainIdentifier: "STRING_VALUE", // required
45
+ * identifier: "STRING_VALUE", // required
46
+ * revision: "STRING_VALUE",
47
+ * };
48
+ * const command = new GetRuleCommand(input);
49
+ * const response = await client.send(command);
50
+ * // { // GetRuleOutput
51
+ * // identifier: "STRING_VALUE", // required
52
+ * // revision: "STRING_VALUE", // required
53
+ * // name: "STRING_VALUE", // required
54
+ * // ruleType: "METADATA_FORM_ENFORCEMENT", // required
55
+ * // target: { // RuleTarget Union: only one key present
56
+ * // domainUnitTarget: { // DomainUnitTarget
57
+ * // domainUnitId: "STRING_VALUE", // required
58
+ * // includeChildDomainUnits: true || false,
59
+ * // },
60
+ * // },
61
+ * // action: "CREATE_SUBSCRIPTION_REQUEST", // required
62
+ * // scope: { // RuleScope
63
+ * // assetType: { // AssetTypesForRule
64
+ * // selectionMode: "ALL" || "SPECIFIC", // required
65
+ * // specificAssetTypes: [ // RuleAssetTypeList
66
+ * // "STRING_VALUE",
67
+ * // ],
68
+ * // },
69
+ * // dataProduct: true || false,
70
+ * // project: { // ProjectsForRule
71
+ * // selectionMode: "ALL" || "SPECIFIC", // required
72
+ * // specificProjects: [ // RuleProjectIdentifierList
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // },
76
+ * // },
77
+ * // detail: { // RuleDetail Union: only one key present
78
+ * // metadataFormEnforcementDetail: { // MetadataFormEnforcementDetail
79
+ * // requiredMetadataForms: [ // RequiredMetadataFormList
80
+ * // { // MetadataFormReference
81
+ * // typeIdentifier: "STRING_VALUE", // required
82
+ * // typeRevision: "STRING_VALUE", // required
83
+ * // },
84
+ * // ],
85
+ * // },
86
+ * // },
87
+ * // targetType: "DOMAIN_UNIT",
88
+ * // description: "STRING_VALUE",
89
+ * // createdAt: new Date("TIMESTAMP"), // required
90
+ * // updatedAt: new Date("TIMESTAMP"), // required
91
+ * // createdBy: "STRING_VALUE", // required
92
+ * // lastUpdatedBy: "STRING_VALUE", // required
93
+ * // };
94
+ *
95
+ * ```
96
+ *
97
+ * @param GetRuleCommandInput - {@link GetRuleCommandInput}
98
+ * @returns {@link GetRuleCommandOutput}
99
+ * @see {@link GetRuleCommandInput} for command's `input` shape.
100
+ * @see {@link GetRuleCommandOutput} for command's `response` shape.
101
+ * @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape.
102
+ *
103
+ * @throws {@link AccessDeniedException} (client fault)
104
+ * <p>You do not have sufficient access to perform this action.</p>
105
+ *
106
+ * @throws {@link InternalServerException} (server fault)
107
+ * <p>The request has failed because of an unknown error, exception or failure.</p>
108
+ *
109
+ * @throws {@link ResourceNotFoundException} (client fault)
110
+ * <p>The specified resource cannot be found.</p>
111
+ *
112
+ * @throws {@link ThrottlingException} (client fault)
113
+ * <p>The request was denied due to request throttling.</p>
114
+ *
115
+ * @throws {@link ValidationException} (client fault)
116
+ * <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
117
+ *
118
+ * @throws {@link UnauthorizedException} (client fault)
119
+ * <p>You do not have permission to perform this action.</p>
120
+ *
121
+ * @throws {@link DataZoneServiceException}
122
+ * <p>Base exception class for all service exceptions from DataZone service.</p>
123
+ *
124
+ * @public
125
+ */
126
+ export declare class GetRuleCommand extends GetRuleCommand_base {
127
+ /** @internal type navigation helper, not in runtime. */
128
+ protected static __types: {
129
+ api: {
130
+ input: GetRuleInput;
131
+ output: GetRuleOutput;
132
+ };
133
+ sdk: {
134
+ input: GetRuleCommandInput;
135
+ output: GetRuleCommandOutput;
136
+ };
137
+ };
138
+ }
@@ -110,6 +110,15 @@ declare const GetSubscriptionRequestDetailsCommand_base: {
110
110
  * // ],
111
111
  * // reviewerId: "STRING_VALUE",
112
112
  * // decisionComment: "STRING_VALUE",
113
+ * // existingSubscriptionId: "STRING_VALUE",
114
+ * // metadataForms: [ // MetadataForms
115
+ * // { // FormOutput
116
+ * // formName: "STRING_VALUE", // required
117
+ * // typeName: "STRING_VALUE",
118
+ * // typeRevision: "STRING_VALUE",
119
+ * // content: "STRING_VALUE",
120
+ * // },
121
+ * // ],
113
122
  * // };
114
123
  *
115
124
  * ```
@@ -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 { ListDomainUnitsForParentInput, ListDomainUnitsForParentOutput } from "../models/models_0";
4
+ import { ListDomainUnitsForParentInput, ListDomainUnitsForParentOutput } from "../models/models_1";
5
5
  /**
6
6
  * @public
7
7
  */
@@ -1,7 +1,8 @@
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 { ListDomainsInput, ListDomainsOutput } from "../models/models_0";
4
+ import { ListDomainsInput } from "../models/models_0";
5
+ import { ListDomainsOutput } from "../models/models_1";
5
6
  /**
6
7
  * @public
7
8
  */
@@ -0,0 +1,142 @@
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 { ListRulesInput, ListRulesOutput } from "../models/models_1";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListRulesCommand}.
14
+ */
15
+ export interface ListRulesCommandInput extends ListRulesInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListRulesCommand}.
21
+ */
22
+ export interface ListRulesCommandOutput extends ListRulesOutput, __MetadataBearer {
23
+ }
24
+ declare const ListRulesCommand_base: {
25
+ new (input: ListRulesCommandInput): import("@smithy/smithy-client").CommandImpl<ListRulesCommandInput, ListRulesCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListRulesCommandInput): import("@smithy/smithy-client").CommandImpl<ListRulesCommandInput, ListRulesCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists existing rules. In Amazon DataZone, a rule is a formal agreement that enforces
31
+ * specific requirements across user workflows (e.g., publishing assets to the catalog,
32
+ * requesting subscriptions, creating projects) within the Amazon DataZone data portal. These
33
+ * rules help maintain consistency, ensure compliance, and uphold governance standards in data
34
+ * management processes. For instance, a metadata enforcement rule can specify the required
35
+ * information for creating a subscription request or publishing a data asset to the catalog,
36
+ * ensuring 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, ListRulesCommand } from "@aws-sdk/client-datazone"; // ES Modules import
41
+ * // const { DataZoneClient, ListRulesCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
42
+ * const client = new DataZoneClient(config);
43
+ * const input = { // ListRulesInput
44
+ * domainIdentifier: "STRING_VALUE", // required
45
+ * targetType: "DOMAIN_UNIT", // required
46
+ * targetIdentifier: "STRING_VALUE", // required
47
+ * ruleType: "METADATA_FORM_ENFORCEMENT",
48
+ * action: "CREATE_SUBSCRIPTION_REQUEST",
49
+ * projectIds: [ // ProjectIds
50
+ * "STRING_VALUE",
51
+ * ],
52
+ * assetTypes: [ // AssetTypeIdentifiers
53
+ * "STRING_VALUE",
54
+ * ],
55
+ * dataProduct: true || false,
56
+ * includeCascaded: true || false,
57
+ * maxResults: Number("int"),
58
+ * nextToken: "STRING_VALUE",
59
+ * };
60
+ * const command = new ListRulesCommand(input);
61
+ * const response = await client.send(command);
62
+ * // { // ListRulesOutput
63
+ * // items: [ // RuleSummaries // required
64
+ * // { // RuleSummary
65
+ * // identifier: "STRING_VALUE",
66
+ * // revision: "STRING_VALUE",
67
+ * // ruleType: "METADATA_FORM_ENFORCEMENT",
68
+ * // name: "STRING_VALUE",
69
+ * // targetType: "DOMAIN_UNIT",
70
+ * // target: { // RuleTarget Union: only one key present
71
+ * // domainUnitTarget: { // DomainUnitTarget
72
+ * // domainUnitId: "STRING_VALUE", // required
73
+ * // includeChildDomainUnits: true || false,
74
+ * // },
75
+ * // },
76
+ * // action: "CREATE_SUBSCRIPTION_REQUEST",
77
+ * // scope: { // RuleScope
78
+ * // assetType: { // AssetTypesForRule
79
+ * // selectionMode: "ALL" || "SPECIFIC", // required
80
+ * // specificAssetTypes: [ // RuleAssetTypeList
81
+ * // "STRING_VALUE",
82
+ * // ],
83
+ * // },
84
+ * // dataProduct: true || false,
85
+ * // project: { // ProjectsForRule
86
+ * // selectionMode: "ALL" || "SPECIFIC", // required
87
+ * // specificProjects: [ // RuleProjectIdentifierList
88
+ * // "STRING_VALUE",
89
+ * // ],
90
+ * // },
91
+ * // },
92
+ * // updatedAt: new Date("TIMESTAMP"),
93
+ * // lastUpdatedBy: "STRING_VALUE",
94
+ * // },
95
+ * // ],
96
+ * // nextToken: "STRING_VALUE",
97
+ * // };
98
+ *
99
+ * ```
100
+ *
101
+ * @param ListRulesCommandInput - {@link ListRulesCommandInput}
102
+ * @returns {@link ListRulesCommandOutput}
103
+ * @see {@link ListRulesCommandInput} for command's `input` shape.
104
+ * @see {@link ListRulesCommandOutput} for command's `response` shape.
105
+ * @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape.
106
+ *
107
+ * @throws {@link AccessDeniedException} (client fault)
108
+ * <p>You do not have sufficient access to perform this action.</p>
109
+ *
110
+ * @throws {@link InternalServerException} (server fault)
111
+ * <p>The request has failed because of an unknown error, exception or failure.</p>
112
+ *
113
+ * @throws {@link ResourceNotFoundException} (client fault)
114
+ * <p>The specified resource cannot be found.</p>
115
+ *
116
+ * @throws {@link ThrottlingException} (client fault)
117
+ * <p>The request was denied due to request throttling.</p>
118
+ *
119
+ * @throws {@link ValidationException} (client fault)
120
+ * <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
121
+ *
122
+ * @throws {@link UnauthorizedException} (client fault)
123
+ * <p>You do not have permission to perform this action.</p>
124
+ *
125
+ * @throws {@link DataZoneServiceException}
126
+ * <p>Base exception class for all service exceptions from DataZone service.</p>
127
+ *
128
+ * @public
129
+ */
130
+ export declare class ListRulesCommand extends ListRulesCommand_base {
131
+ /** @internal type navigation helper, not in runtime. */
132
+ protected static __types: {
133
+ api: {
134
+ input: ListRulesInput;
135
+ output: ListRulesOutput;
136
+ };
137
+ sdk: {
138
+ input: ListRulesCommandInput;
139
+ output: ListRulesCommandOutput;
140
+ };
141
+ };
142
+ }
@@ -119,6 +119,14 @@ declare const ListSubscriptionRequestsCommand_base: {
119
119
  * // ],
120
120
  * // reviewerId: "STRING_VALUE",
121
121
  * // decisionComment: "STRING_VALUE",
122
+ * // existingSubscriptionId: "STRING_VALUE",
123
+ * // metadataFormsSummary: [ // MetadataFormsSummary
124
+ * // { // MetadataFormSummary
125
+ * // formName: "STRING_VALUE",
126
+ * // typeName: "STRING_VALUE", // required
127
+ * // typeRevision: "STRING_VALUE", // required
128
+ * // },
129
+ * // ],
122
130
  * // },
123
131
  * // ],
124
132
  * // nextToken: "STRING_VALUE",