@aws-sdk/client-datazone 3.933.0 → 3.935.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 (124) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/index.js +837 -648
  3. package/dist-es/DataZone.js +6 -0
  4. package/dist-es/commands/BatchGetAttributesMetadataCommand.js +16 -0
  5. package/dist-es/commands/BatchPutAttributesMetadataCommand.js +16 -0
  6. package/dist-es/commands/UpdateRootDomainUnitOwnerCommand.js +16 -0
  7. package/dist-es/commands/index.js +3 -0
  8. package/dist-es/index.js +2 -1
  9. package/dist-es/models/enums.js +569 -0
  10. package/dist-es/models/errors.js +99 -0
  11. package/dist-es/models/models_0.js +1 -446
  12. package/dist-es/models/models_1.js +1 -174
  13. package/dist-es/models/models_2.js +1 -43
  14. package/dist-es/schemas/schemas_0.js +150 -6
  15. package/dist-types/DataZone.d.ts +21 -0
  16. package/dist-types/DataZoneClient.d.ts +5 -2
  17. package/dist-types/commands/BatchGetAttributesMetadataCommand.d.ts +117 -0
  18. package/dist-types/commands/BatchPutAttributesMetadataCommand.d.ts +122 -0
  19. package/dist-types/commands/CreateProjectCommand.d.ts +1 -2
  20. package/dist-types/commands/CreateProjectMembershipCommand.d.ts +1 -1
  21. package/dist-types/commands/CreateProjectProfileCommand.d.ts +1 -1
  22. package/dist-types/commands/CreateRuleCommand.d.ts +12 -2
  23. package/dist-types/commands/CreateSubscriptionGrantCommand.d.ts +1 -1
  24. package/dist-types/commands/CreateSubscriptionRequestCommand.d.ts +1 -1
  25. package/dist-types/commands/CreateSubscriptionTargetCommand.d.ts +1 -1
  26. package/dist-types/commands/CreateUserProfileCommand.d.ts +1 -1
  27. package/dist-types/commands/DeleteDataProductCommand.d.ts +1 -1
  28. package/dist-types/commands/DeleteRuleCommand.d.ts +1 -1
  29. package/dist-types/commands/GetDataProductCommand.d.ts +1 -1
  30. package/dist-types/commands/GetMetadataGenerationRunCommand.d.ts +1 -1
  31. package/dist-types/commands/GetRuleCommand.d.ts +7 -2
  32. package/dist-types/commands/ListMetadataGenerationRunsCommand.d.ts +1 -1
  33. package/dist-types/commands/ListRulesCommand.d.ts +3 -3
  34. package/dist-types/commands/ListSubscriptionGrantsCommand.d.ts +1 -2
  35. package/dist-types/commands/ListSubscriptionRequestsCommand.d.ts +1 -1
  36. package/dist-types/commands/ListSubscriptionTargetsCommand.d.ts +1 -1
  37. package/dist-types/commands/ListSubscriptionsCommand.d.ts +1 -1
  38. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  39. package/dist-types/commands/ListTimeSeriesDataPointsCommand.d.ts +1 -1
  40. package/dist-types/commands/PostLineageEventCommand.d.ts +1 -1
  41. package/dist-types/commands/PostTimeSeriesDataPointsCommand.d.ts +1 -1
  42. package/dist-types/commands/RejectPredictionsCommand.d.ts +1 -1
  43. package/dist-types/commands/RejectSubscriptionRequestCommand.d.ts +1 -1
  44. package/dist-types/commands/RemoveEntityOwnerCommand.d.ts +1 -1
  45. package/dist-types/commands/RemovePolicyGrantCommand.d.ts +1 -1
  46. package/dist-types/commands/RevokeSubscriptionCommand.d.ts +1 -1
  47. package/dist-types/commands/SearchCommand.d.ts +2 -1
  48. package/dist-types/commands/SearchGroupProfilesCommand.d.ts +1 -1
  49. package/dist-types/commands/SearchListingsCommand.d.ts +2 -1
  50. package/dist-types/commands/SearchTypesCommand.d.ts +2 -1
  51. package/dist-types/commands/SearchUserProfilesCommand.d.ts +1 -1
  52. package/dist-types/commands/StartMetadataGenerationRunCommand.d.ts +1 -1
  53. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  54. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  55. package/dist-types/commands/UpdateAccountPoolCommand.d.ts +1 -1
  56. package/dist-types/commands/UpdateConnectionCommand.d.ts +1 -1
  57. package/dist-types/commands/UpdateEnvironmentCommand.d.ts +1 -1
  58. package/dist-types/commands/UpdateRootDomainUnitOwnerCommand.d.ts +96 -0
  59. package/dist-types/commands/UpdateRuleCommand.d.ts +12 -2
  60. package/dist-types/commands/index.d.ts +3 -0
  61. package/dist-types/index.d.ts +5 -1
  62. package/dist-types/models/enums.d.ts +1297 -0
  63. package/dist-types/models/errors.d.ts +100 -0
  64. package/dist-types/models/models_0.d.ts +1716 -820
  65. package/dist-types/models/models_1.d.ts +5037 -4324
  66. package/dist-types/models/models_2.d.ts +33 -2816
  67. package/dist-types/schemas/schemas_0.d.ts +21 -1
  68. package/dist-types/ts3.4/DataZone.d.ts +51 -0
  69. package/dist-types/ts3.4/DataZoneClient.d.ts +18 -0
  70. package/dist-types/ts3.4/commands/BatchGetAttributesMetadataCommand.d.ts +51 -0
  71. package/dist-types/ts3.4/commands/BatchPutAttributesMetadataCommand.d.ts +51 -0
  72. package/dist-types/ts3.4/commands/CreateProjectCommand.d.ts +1 -2
  73. package/dist-types/ts3.4/commands/CreateProjectMembershipCommand.d.ts +1 -1
  74. package/dist-types/ts3.4/commands/CreateProjectProfileCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/CreateRuleCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/CreateSubscriptionGrantCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/CreateSubscriptionRequestCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/CreateSubscriptionTargetCommand.d.ts +1 -1
  79. package/dist-types/ts3.4/commands/CreateUserProfileCommand.d.ts +1 -1
  80. package/dist-types/ts3.4/commands/DeleteDataProductCommand.d.ts +1 -1
  81. package/dist-types/ts3.4/commands/DeleteRuleCommand.d.ts +1 -1
  82. package/dist-types/ts3.4/commands/GetDataProductCommand.d.ts +1 -1
  83. package/dist-types/ts3.4/commands/GetMetadataGenerationRunCommand.d.ts +1 -1
  84. package/dist-types/ts3.4/commands/GetRuleCommand.d.ts +1 -1
  85. package/dist-types/ts3.4/commands/ListMetadataGenerationRunsCommand.d.ts +1 -1
  86. package/dist-types/ts3.4/commands/ListRulesCommand.d.ts +1 -1
  87. package/dist-types/ts3.4/commands/ListSubscriptionGrantsCommand.d.ts +4 -2
  88. package/dist-types/ts3.4/commands/ListSubscriptionRequestsCommand.d.ts +1 -1
  89. package/dist-types/ts3.4/commands/ListSubscriptionTargetsCommand.d.ts +1 -1
  90. package/dist-types/ts3.4/commands/ListSubscriptionsCommand.d.ts +1 -1
  91. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  92. package/dist-types/ts3.4/commands/ListTimeSeriesDataPointsCommand.d.ts +1 -1
  93. package/dist-types/ts3.4/commands/PostLineageEventCommand.d.ts +1 -1
  94. package/dist-types/ts3.4/commands/PostTimeSeriesDataPointsCommand.d.ts +1 -1
  95. package/dist-types/ts3.4/commands/RejectPredictionsCommand.d.ts +1 -1
  96. package/dist-types/ts3.4/commands/RejectSubscriptionRequestCommand.d.ts +1 -1
  97. package/dist-types/ts3.4/commands/RemoveEntityOwnerCommand.d.ts +1 -1
  98. package/dist-types/ts3.4/commands/RemovePolicyGrantCommand.d.ts +1 -1
  99. package/dist-types/ts3.4/commands/RevokeSubscriptionCommand.d.ts +1 -1
  100. package/dist-types/ts3.4/commands/SearchCommand.d.ts +2 -1
  101. package/dist-types/ts3.4/commands/SearchGroupProfilesCommand.d.ts +1 -1
  102. package/dist-types/ts3.4/commands/SearchListingsCommand.d.ts +2 -1
  103. package/dist-types/ts3.4/commands/SearchTypesCommand.d.ts +2 -1
  104. package/dist-types/ts3.4/commands/SearchUserProfilesCommand.d.ts +1 -1
  105. package/dist-types/ts3.4/commands/StartMetadataGenerationRunCommand.d.ts +1 -1
  106. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  107. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  108. package/dist-types/ts3.4/commands/UpdateAccountPoolCommand.d.ts +1 -1
  109. package/dist-types/ts3.4/commands/UpdateConnectionCommand.d.ts +1 -1
  110. package/dist-types/ts3.4/commands/UpdateEnvironmentCommand.d.ts +1 -1
  111. package/dist-types/ts3.4/commands/UpdateRootDomainUnitOwnerCommand.d.ts +51 -0
  112. package/dist-types/ts3.4/commands/UpdateRuleCommand.d.ts +1 -1
  113. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  114. package/dist-types/ts3.4/index.d.ts +5 -1
  115. package/dist-types/ts3.4/models/enums.d.ts +728 -0
  116. package/dist-types/ts3.4/models/errors.d.ts +58 -0
  117. package/dist-types/ts3.4/models/models_0.d.ts +560 -490
  118. package/dist-types/ts3.4/models/models_1.d.ts +845 -788
  119. package/dist-types/ts3.4/models/models_2.d.ts +31 -810
  120. package/dist-types/ts3.4/schemas/schemas_0.d.ts +21 -1
  121. package/package.json +12 -12
  122. package/dist-es/models/index.js +0 -3
  123. package/dist-types/models/index.d.ts +0 -3
  124. package/dist-types/ts3.4/models/index.d.ts +0 -3
@@ -1,2819 +1,6 @@
1
- import { AccountSource, ActionParameters, AggregationListItem, AggregationOutput, AssetItem, AssetListingItem, AssetTypeItem, AwsLocation, ColumnFilterConfiguration, ConfigurableEnvironmentAction, ConnectionPropertiesOutput, ConnectionPropertiesPatch, ConnectionScope, ConnectionType, CustomParameter, DataZoneEntityType, Deployment, DeploymentProperties, EnvironmentConfigurationUserParameter, EnvironmentParameter, EnvironmentStatus, FilterStatus, FormEntryOutput, FormOutput, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GroupProfileStatus, ManagedPolicyType, MatchRationaleItem, Model, OwnerProperties, PhysicalEndpoint, PolicyGrantPrincipal, ProvisioningProperties, ResolutionStrategy, Resource, RowFilterExpression, SubscribedListing, SubscribedPrincipal, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TermRelations, TimeSeriesDataPointSummaryFormOutput, UserProfileDetails } from "./models_0";
2
- import { DataProductListingItem, DataProductResultItem, EnvironmentConfiguration, EnvironmentDeploymentDetails, FailureCause, GrantedEntity, Import, ProjectDeletionError, ProjectStatus, ResourceTag, ResourceTagParameter, RuleAction, RuleDetail, RuleScope, RuleTarget, RuleTargetType, RuleType, SortKey, SortOrder, Status, SubscribedAsset, SubscriptionGrantOverallStatus, SubscriptionGrantStatus, SubscriptionGrantSummary, SubscriptionTargetForm, TimeSeriesDataPointFormOutput, TimeSeriesEntityType, UserProfileStatus, UserProfileType } from "./models_1";
3
- /**
4
- * @public
5
- */
6
- export interface ListSubscriptionGrantsOutput {
7
- /**
8
- * <p>The results of the <code>ListSubscriptionGrants</code> action. </p>
9
- * @public
10
- */
11
- items: SubscriptionGrantSummary[] | undefined;
12
- /**
13
- * <p>When the number of subscription grants is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of subscription grants, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionGrants</code> to list the next set of subscription grants.</p>
14
- * @public
15
- */
16
- nextToken?: string | undefined;
17
- }
18
- /**
19
- * @public
20
- */
21
- export interface ListSubscriptionRequestsInput {
22
- /**
23
- * <p>The identifier of the Amazon DataZone domain.</p>
24
- * @public
25
- */
26
- domainIdentifier: string | undefined;
27
- /**
28
- * <p>Specifies the status of the subscription requests.</p> <note> <p>This is not a required parameter, but if not specified, by default, Amazon DataZone returns only <code>PENDING</code> subscription requests. </p> </note>
29
- * @public
30
- */
31
- status?: SubscriptionRequestStatus | undefined;
32
- /**
33
- * <p>The identifier of the subscribed listing.</p>
34
- * @public
35
- */
36
- subscribedListingId?: string | undefined;
37
- /**
38
- * <p>The identifier of the project for the subscription requests.</p>
39
- * @public
40
- */
41
- owningProjectId?: string | undefined;
42
- /**
43
- * <p>The identifier of the subscription request approver's project.</p>
44
- * @public
45
- */
46
- approverProjectId?: string | undefined;
47
- /**
48
- * <p>The ID of the owning user.</p>
49
- * @public
50
- */
51
- owningUserId?: string | undefined;
52
- /**
53
- * <p>The ID of the owning group.</p>
54
- * @public
55
- */
56
- owningGroupId?: string | undefined;
57
- /**
58
- * <p>Specifies the way to sort the results of this action.</p>
59
- *
60
- * @deprecated Results are always sorted by updatedAt
61
- * @public
62
- */
63
- sortBy?: SortKey | undefined;
64
- /**
65
- * <p>Specifies the sort order for the results of this action.</p>
66
- * @public
67
- */
68
- sortOrder?: SortOrder | undefined;
69
- /**
70
- * <p>The maximum number of subscription requests to return in a single call to <code>ListSubscriptionRequests</code>. When the number of subscription requests to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListSubscriptionRequests</code> to list the next set of subscription requests.</p>
71
- * @public
72
- */
73
- maxResults?: number | undefined;
74
- /**
75
- * <p>When the number of subscription requests is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of subscription requests, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionRequests</code> to list the next set of subscription requests.</p>
76
- * @public
77
- */
78
- nextToken?: string | undefined;
79
- }
80
- /**
81
- * <p>The summary of the metadata form.</p>
82
- * @public
83
- */
84
- export interface MetadataFormSummary {
85
- /**
86
- * <p>The form name of the metadata form.</p>
87
- * @public
88
- */
89
- formName?: string | undefined;
90
- /**
91
- * <p>The type name of the metadata form.</p>
92
- * @public
93
- */
94
- typeName: string | undefined;
95
- /**
96
- * <p>The type revision of the metadata form.</p>
97
- * @public
98
- */
99
- typeRevision: string | undefined;
100
- }
101
- /**
102
- * <p>The details of the subscription request.</p>
103
- * @public
104
- */
105
- export interface SubscriptionRequestSummary {
106
- /**
107
- * <p>The identifier of the subscription request.</p>
108
- * @public
109
- */
110
- id: string | undefined;
111
- /**
112
- * <p>The Amazon DataZone user who created the subscription request.</p>
113
- * @public
114
- */
115
- createdBy: string | undefined;
116
- /**
117
- * <p>The identifier of the Amazon DataZone user who updated the subscription request.</p>
118
- * @public
119
- */
120
- updatedBy?: string | undefined;
121
- /**
122
- * <p>The identifier of the Amazon DataZone domain in which a subscription request exists.</p>
123
- * @public
124
- */
125
- domainId: string | undefined;
126
- /**
127
- * <p>The status of the subscription request.</p>
128
- * @public
129
- */
130
- status: SubscriptionRequestStatus | undefined;
131
- /**
132
- * <p>The timestamp of when a subscription request was created.</p>
133
- * @public
134
- */
135
- createdAt: Date | undefined;
136
- /**
137
- * <p>The timestamp of when the subscription request was updated.</p>
138
- * @public
139
- */
140
- updatedAt: Date | undefined;
141
- /**
142
- * <p>The reason for the subscription request.</p>
143
- * @public
144
- */
145
- requestReason: string | undefined;
146
- /**
147
- * <p>The principals included in the subscription request. </p>
148
- * @public
149
- */
150
- subscribedPrincipals: SubscribedPrincipal[] | undefined;
151
- /**
152
- * <p>The listings included in the subscription request.</p>
153
- * @public
154
- */
155
- subscribedListings: SubscribedListing[] | undefined;
156
- /**
157
- * <p>The identifier of the subscription request reviewer.</p>
158
- * @public
159
- */
160
- reviewerId?: string | undefined;
161
- /**
162
- * <p>The decision comment of the subscription request.</p>
163
- * @public
164
- */
165
- decisionComment?: string | undefined;
166
- /**
167
- * <p>The ID of the existing subscription.</p>
168
- * @public
169
- */
170
- existingSubscriptionId?: string | undefined;
171
- /**
172
- * <p>The summary of the metadata forms.</p>
173
- * @public
174
- */
175
- metadataFormsSummary?: MetadataFormSummary[] | undefined;
176
- }
177
- /**
178
- * @public
179
- */
180
- export interface ListSubscriptionRequestsOutput {
181
- /**
182
- * <p>The results of the <code>ListSubscriptionRequests</code> action. </p>
183
- * @public
184
- */
185
- items: SubscriptionRequestSummary[] | undefined;
186
- /**
187
- * <p>When the number of subscription requests is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of subscription requests, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionRequests</code> to list the next set of subscription requests.</p>
188
- * @public
189
- */
190
- nextToken?: string | undefined;
191
- }
192
- /**
193
- * @public
194
- */
195
- export interface ListSubscriptionsInput {
196
- /**
197
- * <p>The identifier of the Amazon DataZone domain.</p>
198
- * @public
199
- */
200
- domainIdentifier: string | undefined;
201
- /**
202
- * <p>The identifier of the subscription request for the subscriptions that you want to list.</p>
203
- * @public
204
- */
205
- subscriptionRequestIdentifier?: string | undefined;
206
- /**
207
- * <p>The status of the subscriptions that you want to list.</p> <note> <p>This is not a required parameter, but if not provided, by default, Amazon DataZone returns only <code>APPROVED</code> subscriptions. </p> </note>
208
- * @public
209
- */
210
- status?: SubscriptionStatus | undefined;
211
- /**
212
- * <p>The identifier of the subscribed listing for the subscriptions that you want to list.</p>
213
- * @public
214
- */
215
- subscribedListingId?: string | undefined;
216
- /**
217
- * <p>The identifier of the owning project.</p>
218
- * @public
219
- */
220
- owningProjectId?: string | undefined;
221
- /**
222
- * <p>The ID of the owning user.</p>
223
- * @public
224
- */
225
- owningUserId?: string | undefined;
226
- /**
227
- * <p>The ID of the owning group.</p>
228
- * @public
229
- */
230
- owningGroupId?: string | undefined;
231
- /**
232
- * <p>The identifier of the project for the subscription's approver.</p>
233
- * @public
234
- */
235
- approverProjectId?: string | undefined;
236
- /**
237
- * <p>Specifies the way in which the results of this action are to be sorted.</p>
238
- *
239
- * @deprecated Results are always sorted by updatedAt
240
- * @public
241
- */
242
- sortBy?: SortKey | undefined;
243
- /**
244
- * <p>Specifies the sort order for the results of this action.</p>
245
- * @public
246
- */
247
- sortOrder?: SortOrder | undefined;
248
- /**
249
- * <p>The maximum number of subscriptions to return in a single call to <code>ListSubscriptions</code>. When the number of subscriptions to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListSubscriptions</code> to list the next set of Subscriptions. </p>
250
- * @public
251
- */
252
- maxResults?: number | undefined;
253
- /**
254
- * <p>When the number of subscriptions is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of subscriptions, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptions</code> to list the next set of subscriptions.</p>
255
- * @public
256
- */
257
- nextToken?: string | undefined;
258
- }
259
- /**
260
- * <p>The details of the subscription.</p>
261
- * @public
262
- */
263
- export interface SubscriptionSummary {
264
- /**
265
- * <p>The identifier of the subscription.</p>
266
- * @public
267
- */
268
- id: string | undefined;
269
- /**
270
- * <p>The Amazon DataZone user who created the subscription.</p>
271
- * @public
272
- */
273
- createdBy: string | undefined;
274
- /**
275
- * <p>The Amazon DataZone user who updated the subscription.</p>
276
- * @public
277
- */
278
- updatedBy?: string | undefined;
279
- /**
280
- * <p>The identifier of the Amazon DataZone domain in which a subscription exists.</p>
281
- * @public
282
- */
283
- domainId: string | undefined;
284
- /**
285
- * <p>The status of the subscription.</p>
286
- * @public
287
- */
288
- status: SubscriptionStatus | undefined;
289
- /**
290
- * <p>The timestamp of when the subscription was created.</p>
291
- * @public
292
- */
293
- createdAt: Date | undefined;
294
- /**
295
- * <p>The timestamp of when the subscription was updated.</p>
296
- * @public
297
- */
298
- updatedAt: Date | undefined;
299
- /**
300
- * <p>The principal included in the subscription.</p>
301
- * @public
302
- */
303
- subscribedPrincipal: SubscribedPrincipal | undefined;
304
- /**
305
- * <p>The listing included in the subscription.</p>
306
- * @public
307
- */
308
- subscribedListing: SubscribedListing | undefined;
309
- /**
310
- * <p>The identifier of the subscription request for the subscription.</p>
311
- * @public
312
- */
313
- subscriptionRequestId?: string | undefined;
314
- /**
315
- * <p>The retain permissions included in the subscription.</p>
316
- * @public
317
- */
318
- retainPermissions?: boolean | undefined;
319
- }
320
- /**
321
- * @public
322
- */
323
- export interface ListSubscriptionsOutput {
324
- /**
325
- * <p>The results of the <code>ListSubscriptions</code> action.</p>
326
- * @public
327
- */
328
- items: SubscriptionSummary[] | undefined;
329
- /**
330
- * <p>When the number of subscriptions is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of subscriptions, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptions</code> to list the next set of subscriptions.</p>
331
- * @public
332
- */
333
- nextToken?: string | undefined;
334
- }
335
- /**
336
- * @public
337
- */
338
- export interface ListSubscriptionTargetsInput {
339
- /**
340
- * <p>The identifier of the Amazon DataZone domain where you want to list subscription targets.</p>
341
- * @public
342
- */
343
- domainIdentifier: string | undefined;
344
- /**
345
- * <p>The identifier of the environment where you want to list subscription targets.</p>
346
- * @public
347
- */
348
- environmentIdentifier: string | undefined;
349
- /**
350
- * <p>Specifies the way in which the results of this action are to be sorted.</p>
351
- * @public
352
- */
353
- sortBy?: SortKey | undefined;
354
- /**
355
- * <p>Specifies the sort order for the results of this action.</p>
356
- * @public
357
- */
358
- sortOrder?: SortOrder | undefined;
359
- /**
360
- * <p>The maximum number of subscription targets to return in a single call to <code>ListSubscriptionTargets</code>. When the number of subscription targets to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListSubscriptionTargets</code> to list the next set of subscription targets. </p>
361
- * @public
362
- */
363
- maxResults?: number | undefined;
364
- /**
365
- * <p>When the number of subscription targets is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of subscription targets, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionTargets</code> to list the next set of subscription targets.</p>
366
- * @public
367
- */
368
- nextToken?: string | undefined;
369
- }
370
- /**
371
- * <p>The details of the subscription target.</p>
372
- * @public
373
- */
374
- export interface SubscriptionTargetSummary {
375
- /**
376
- * <p>The identifier of the subscription target.</p>
377
- * @public
378
- */
379
- id: string | undefined;
380
- /**
381
- * <p>The authorized principals included in the subscription target.</p>
382
- * @public
383
- */
384
- authorizedPrincipals: string[] | undefined;
385
- /**
386
- * <p>The identifier of the Amazon DataZone domain in which the subscription target exists.</p>
387
- * @public
388
- */
389
- domainId: string | undefined;
390
- /**
391
- * <p>The identifier of the project specified in the subscription target.</p>
392
- * @public
393
- */
394
- projectId: string | undefined;
395
- /**
396
- * <p>The identifier of the environment of the subscription target.</p>
397
- * @public
398
- */
399
- environmentId: string | undefined;
400
- /**
401
- * <p>The name of the subscription target.</p>
402
- * @public
403
- */
404
- name: string | undefined;
405
- /**
406
- * <p>The type of the subscription target.</p>
407
- * @public
408
- */
409
- type: string | undefined;
410
- /**
411
- * <p>The Amazon DataZone user who created the subscription target.</p>
412
- * @public
413
- */
414
- createdBy: string | undefined;
415
- /**
416
- * <p>The Amazon DataZone user who updated the subscription target.</p>
417
- * @public
418
- */
419
- updatedBy?: string | undefined;
420
- /**
421
- * <p>The timestamp of when the subscription target was created.</p>
422
- * @public
423
- */
424
- createdAt: Date | undefined;
425
- /**
426
- * <p>The timestamp of when the subscription target was updated.</p>
427
- * @public
428
- */
429
- updatedAt?: Date | undefined;
430
- /**
431
- * <p>The manage access role specified in the subscription target.</p>
432
- * @public
433
- */
434
- manageAccessRole?: string | undefined;
435
- /**
436
- * <p>The asset types included in the subscription target.</p>
437
- * @public
438
- */
439
- applicableAssetTypes: string[] | undefined;
440
- /**
441
- * <p>The configuration of the subscription target.</p>
442
- * @public
443
- */
444
- subscriptionTargetConfig: SubscriptionTargetForm[] | undefined;
445
- /**
446
- * <p>The provider of the subscription target.</p>
447
- * @public
448
- */
449
- provider: string | undefined;
450
- }
451
- /**
452
- * @public
453
- */
454
- export interface ListSubscriptionTargetsOutput {
455
- /**
456
- * <p>The results of the <code>ListSubscriptionTargets</code> action.</p>
457
- * @public
458
- */
459
- items: SubscriptionTargetSummary[] | undefined;
460
- /**
461
- * <p>When the number of subscription targets is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of subscription targets, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionTargets</code> to list the next set of subscription targets.</p>
462
- * @public
463
- */
464
- nextToken?: string | undefined;
465
- }
466
- /**
467
- * @public
468
- */
469
- export interface ListTagsForResourceRequest {
470
- /**
471
- * <p>The ARN of the resource whose tags you want to list.</p>
472
- * @public
473
- */
474
- resourceArn: string | undefined;
475
- }
476
- /**
477
- * @public
478
- */
479
- export interface ListTagsForResourceResponse {
480
- /**
481
- * <p>The tags of the specified resource.</p>
482
- * @public
483
- */
484
- tags?: Record<string, string> | undefined;
485
- }
486
- /**
487
- * @public
488
- */
489
- export interface ListTimeSeriesDataPointsInput {
490
- /**
491
- * <p>The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.</p>
492
- * @public
493
- */
494
- domainIdentifier: string | undefined;
495
- /**
496
- * <p>The ID of the asset for which you want to list data points.</p>
497
- * @public
498
- */
499
- entityIdentifier: string | undefined;
500
- /**
501
- * <p>The type of the asset for which you want to list data points.</p>
502
- * @public
503
- */
504
- entityType: TimeSeriesEntityType | undefined;
505
- /**
506
- * <p>The name of the time series data points form.</p>
507
- * @public
508
- */
509
- formName: string | undefined;
510
- /**
511
- * <p>The timestamp at which the data points that you want to list started.</p>
512
- * @public
513
- */
514
- startedAt?: Date | undefined;
515
- /**
516
- * <p>The timestamp at which the data points that you wanted to list ended.</p>
517
- * @public
518
- */
519
- endedAt?: Date | undefined;
520
- /**
521
- * <p>When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.</p>
522
- * @public
523
- */
524
- nextToken?: string | undefined;
525
- /**
526
- * <p>The maximum number of data points to return in a single call to ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.</p>
527
- * @public
528
- */
529
- maxResults?: number | undefined;
530
- }
531
- /**
532
- * @public
533
- */
534
- export interface ListTimeSeriesDataPointsOutput {
535
- /**
536
- * <p>The results of the ListTimeSeriesDataPoints action. </p>
537
- * @public
538
- */
539
- items?: TimeSeriesDataPointSummaryFormOutput[] | undefined;
540
- /**
541
- * <p>When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.</p>
542
- * @public
543
- */
544
- nextToken?: string | undefined;
545
- }
546
- /**
547
- * @public
548
- */
549
- export interface GetMetadataGenerationRunInput {
550
- /**
551
- * <p>The ID of the Amazon DataZone domain the metadata generation run of which you want to get.</p>
552
- * @public
553
- */
554
- domainIdentifier: string | undefined;
555
- /**
556
- * <p>The identifier of the metadata generation run.</p>
557
- * @public
558
- */
559
- identifier: string | undefined;
560
- }
561
- /**
562
- * @public
563
- * @enum
564
- */
565
- export declare const MetadataGenerationRunStatus: {
566
- readonly CANCELED: "CANCELED";
567
- readonly FAILED: "FAILED";
568
- readonly IN_PROGRESS: "IN_PROGRESS";
569
- readonly SUBMITTED: "SUBMITTED";
570
- readonly SUCCEEDED: "SUCCEEDED";
571
- };
572
- /**
573
- * @public
574
- */
575
- export type MetadataGenerationRunStatus = (typeof MetadataGenerationRunStatus)[keyof typeof MetadataGenerationRunStatus];
576
- /**
577
- * @public
578
- * @enum
579
- */
580
- export declare const MetadataGenerationTargetType: {
581
- readonly ASSET: "ASSET";
582
- };
583
- /**
584
- * @public
585
- */
586
- export type MetadataGenerationTargetType = (typeof MetadataGenerationTargetType)[keyof typeof MetadataGenerationTargetType];
587
- /**
588
- * <p>The asset for which metadata was generated.</p>
589
- * @public
590
- */
591
- export interface MetadataGenerationRunTarget {
592
- /**
593
- * <p>The type of the asset for which metadata was generated.</p>
594
- * @public
595
- */
596
- type: MetadataGenerationTargetType | undefined;
597
- /**
598
- * <p>The ID of the metadata generation run's target.</p>
599
- * @public
600
- */
601
- identifier: string | undefined;
602
- /**
603
- * <p>The revision of the asset for which metadata was generated.</p>
604
- * @public
605
- */
606
- revision?: string | undefined;
607
- }
608
- /**
609
- * @public
610
- * @enum
611
- */
612
- export declare const MetadataGenerationRunType: {
613
- readonly BUSINESS_DESCRIPTIONS: "BUSINESS_DESCRIPTIONS";
614
- };
615
- /**
616
- * @public
617
- */
618
- export type MetadataGenerationRunType = (typeof MetadataGenerationRunType)[keyof typeof MetadataGenerationRunType];
619
- /**
620
- * @public
621
- */
622
- export interface GetMetadataGenerationRunOutput {
623
- /**
624
- * <p>The ID of the Amazon DataZone domain the metadata generation run of which you want to get.</p>
625
- * @public
626
- */
627
- domainId: string | undefined;
628
- /**
629
- * <p>The ID of the metadata generation run.</p>
630
- * @public
631
- */
632
- id: string | undefined;
633
- /**
634
- * <p>The asset for which you're generating metadata.</p>
635
- * @public
636
- */
637
- target?: MetadataGenerationRunTarget | undefined;
638
- /**
639
- * <p>The status of the metadata generation run.</p>
640
- * @public
641
- */
642
- status?: MetadataGenerationRunStatus | undefined;
643
- /**
644
- * <p>The type of metadata generation run.</p>
645
- * @public
646
- */
647
- type?: MetadataGenerationRunType | undefined;
648
- /**
649
- * <p>The timestamp of when the metadata generation run was start.</p>
650
- * @public
651
- */
652
- createdAt?: Date | undefined;
653
- /**
654
- * <p>The Amazon DataZone user who started the metadata generation run.</p>
655
- * @public
656
- */
657
- createdBy?: string | undefined;
658
- /**
659
- * <p>The ID of the project that owns the assets for which you're running metadata generation.</p>
660
- * @public
661
- */
662
- owningProjectId: string | undefined;
663
- }
664
- /**
665
- * @public
666
- */
667
- export interface ListMetadataGenerationRunsInput {
668
- /**
669
- * <p>The ID of the Amazon DataZone domain where you want to list metadata generation runs.</p>
670
- * @public
671
- */
672
- domainIdentifier: string | undefined;
673
- /**
674
- * <p>The status of the metadata generation runs.</p>
675
- * @public
676
- */
677
- status?: MetadataGenerationRunStatus | undefined;
678
- /**
679
- * <p>The type of the metadata generation runs.</p>
680
- * @public
681
- */
682
- type?: MetadataGenerationRunType | undefined;
683
- /**
684
- * <p>When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.</p>
685
- * @public
686
- */
687
- nextToken?: string | undefined;
688
- /**
689
- * <p>The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.</p>
690
- * @public
691
- */
692
- maxResults?: number | undefined;
693
- }
694
- /**
695
- * <p>The metadata generation run.</p>
696
- * @public
697
- */
698
- export interface MetadataGenerationRunItem {
699
- /**
700
- * <p>The ID of the Amazon DataZone domain in which the metadata generation run was created.</p>
701
- * @public
702
- */
703
- domainId: string | undefined;
704
- /**
705
- * <p>The ID of the metadata generation run.</p>
706
- * @public
707
- */
708
- id: string | undefined;
709
- /**
710
- * <p>The asset for which metadata was generated.</p>
711
- * @public
712
- */
713
- target?: MetadataGenerationRunTarget | undefined;
714
- /**
715
- * <p>The status of the metadata generation run.</p>
716
- * @public
717
- */
718
- status?: MetadataGenerationRunStatus | undefined;
719
- /**
720
- * <p>The type of the metadata generation run.</p>
721
- * @public
722
- */
723
- type?: MetadataGenerationRunType | undefined;
724
- /**
725
- * <p>The timestamp at which the metadata generation run was created.</p>
726
- * @public
727
- */
728
- createdAt?: Date | undefined;
729
- /**
730
- * <p>The user who created the metadata generation run.</p>
731
- * @public
732
- */
733
- createdBy?: string | undefined;
734
- /**
735
- * <p>The ID of the project that owns the asset for which the metadata generation was ran.</p>
736
- * @public
737
- */
738
- owningProjectId: string | undefined;
739
- }
740
- /**
741
- * @public
742
- */
743
- export interface ListMetadataGenerationRunsOutput {
744
- /**
745
- * <p>The results of the ListMetadataGenerationRuns action.</p>
746
- * @public
747
- */
748
- items?: MetadataGenerationRunItem[] | undefined;
749
- /**
750
- * <p>When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.</p>
751
- * @public
752
- */
753
- nextToken?: string | undefined;
754
- }
755
- /**
756
- * @public
757
- */
758
- export interface StartMetadataGenerationRunInput {
759
- /**
760
- * <p>The ID of the Amazon DataZone domain where you want to start a metadata generation run.</p>
761
- * @public
762
- */
763
- domainIdentifier: string | undefined;
764
- /**
765
- * <p>The type of the metadata generation run.</p>
766
- * @public
767
- */
768
- type: MetadataGenerationRunType | undefined;
769
- /**
770
- * <p>The asset for which you want to start a metadata generation run.</p>
771
- * @public
772
- */
773
- target: MetadataGenerationRunTarget | undefined;
774
- /**
775
- * <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>
776
- * @public
777
- */
778
- clientToken?: string | undefined;
779
- /**
780
- * <p>The ID of the project that owns the asset for which you want to start a metadata generation run.</p>
781
- * @public
782
- */
783
- owningProjectIdentifier: string | undefined;
784
- }
785
- /**
786
- * @public
787
- */
788
- export interface StartMetadataGenerationRunOutput {
789
- /**
790
- * <p>The ID of the Amazon DataZone domain in which the metadata generation run was started.</p>
791
- * @public
792
- */
793
- domainId: string | undefined;
794
- /**
795
- * <p>The ID of the metadata generation run.</p>
796
- * @public
797
- */
798
- id: string | undefined;
799
- /**
800
- * <p>The status of the metadata generation run.</p>
801
- * @public
802
- */
803
- status?: MetadataGenerationRunStatus | undefined;
804
- /**
805
- * <p>The type of the metadata generation run.</p>
806
- * @public
807
- */
808
- type?: MetadataGenerationRunType | undefined;
809
- /**
810
- * <p>The timestamp at which the metadata generation run was started.</p>
811
- * @public
812
- */
813
- createdAt?: Date | undefined;
814
- /**
815
- * <p>The ID of the user who started the metadata generation run.</p>
816
- * @public
817
- */
818
- createdBy?: string | undefined;
819
- /**
820
- * <p>The ID of the project that owns the asset for which the metadata generation run was started.</p>
821
- * @public
822
- */
823
- owningProjectId?: string | undefined;
824
- }
825
- /**
826
- * @public
827
- */
828
- export interface PostLineageEventInput {
829
- /**
830
- * <p>The ID of the domain where you want to post a data lineage event.</p>
831
- * @public
832
- */
833
- domainIdentifier: string | undefined;
834
- /**
835
- * <p>The data lineage event that you want to post. Only open-lineage run event are supported as events. </p>
836
- * @public
837
- */
838
- event: Uint8Array | undefined;
839
- /**
840
- * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
841
- * @public
842
- */
843
- clientToken?: string | undefined;
844
- }
845
- /**
846
- * @public
847
- */
848
- export interface PostLineageEventOutput {
849
- /**
850
- * <p>The ID of the lineage event.</p>
851
- * @public
852
- */
853
- id?: string | undefined;
854
- /**
855
- * <p>The ID of the domain.</p>
856
- * @public
857
- */
858
- domainId?: string | undefined;
859
- }
860
- /**
861
- * <p>The time series data points form.</p>
862
- * @public
863
- */
864
- export interface TimeSeriesDataPointFormInput {
865
- /**
866
- * <p>The name of the time series data points form.</p>
867
- * @public
868
- */
869
- formName: string | undefined;
870
- /**
871
- * <p>The ID of the type of the time series data points form.</p>
872
- * @public
873
- */
874
- typeIdentifier: string | undefined;
875
- /**
876
- * <p>The revision type of the time series data points form.</p>
877
- * @public
878
- */
879
- typeRevision?: string | undefined;
880
- /**
881
- * <p>The timestamp of the time series data points form.</p>
882
- * @public
883
- */
884
- timestamp: Date | undefined;
885
- /**
886
- * <p>The content of the time series data points form.</p>
887
- * @public
888
- */
889
- content?: string | undefined;
890
- }
891
- /**
892
- * @public
893
- */
894
- export interface PostTimeSeriesDataPointsInput {
895
- /**
896
- * <p>The ID of the Amazon DataZone domain in which you want to post time series data points.</p>
897
- * @public
898
- */
899
- domainIdentifier: string | undefined;
900
- /**
901
- * <p>The ID of the asset for which you want to post time series data points.</p>
902
- * @public
903
- */
904
- entityIdentifier: string | undefined;
905
- /**
906
- * <p>The type of the asset for which you want to post data points.</p>
907
- * @public
908
- */
909
- entityType: TimeSeriesEntityType | undefined;
910
- /**
911
- * <p>The forms that contain the data points that you want to post.</p>
912
- * @public
913
- */
914
- forms: TimeSeriesDataPointFormInput[] | undefined;
915
- /**
916
- * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
917
- * @public
918
- */
919
- clientToken?: string | undefined;
920
- }
921
- /**
922
- * @public
923
- */
924
- export interface PostTimeSeriesDataPointsOutput {
925
- /**
926
- * <p>The ID of the Amazon DataZone domain in which you want to post time series data points.</p>
927
- * @public
928
- */
929
- domainId?: string | undefined;
930
- /**
931
- * <p>The ID of the asset for which you want to post time series data points.</p>
932
- * @public
933
- */
934
- entityId?: string | undefined;
935
- /**
936
- * <p>The type of the asset for which you want to post data points.</p>
937
- * @public
938
- */
939
- entityType?: TimeSeriesEntityType | undefined;
940
- /**
941
- * <p>The forms that contain the data points that you have posted.</p>
942
- * @public
943
- */
944
- forms?: TimeSeriesDataPointFormOutput[] | undefined;
945
- }
946
- /**
947
- * <p>The details of the automatically generated business metadata that is rejected.</p>
948
- * @public
949
- */
950
- export interface RejectChoice {
951
- /**
952
- * <p>Specifies the target (for example, a column name) where a prediction can be rejected.</p>
953
- * @public
954
- */
955
- predictionTarget: string | undefined;
956
- /**
957
- * <p>Specifies the the automatically generated business metadata that can be rejected.</p>
958
- * @public
959
- */
960
- predictionChoices?: number[] | undefined;
961
- }
962
- /**
963
- * @public
964
- * @enum
965
- */
966
- export declare const RejectRuleBehavior: {
967
- readonly ALL: "ALL";
968
- readonly NONE: "NONE";
969
- };
970
- /**
971
- * @public
972
- */
973
- export type RejectRuleBehavior = (typeof RejectRuleBehavior)[keyof typeof RejectRuleBehavior];
974
- /**
975
- * <p>Specifies the rule and the threshold under which a prediction can be rejected.</p>
976
- * @public
977
- */
978
- export interface RejectRule {
979
- /**
980
- * <p>Specifies whether you want to reject the top prediction for all targets or none.</p>
981
- * @public
982
- */
983
- rule?: RejectRuleBehavior | undefined;
984
- /**
985
- * <p>The confidence score that specifies the condition at which a prediction can be rejected.</p>
986
- * @public
987
- */
988
- threshold?: number | undefined;
989
- }
990
- /**
991
- * @public
992
- */
993
- export interface RejectPredictionsInput {
994
- /**
995
- * <p>The identifier of the Amazon DataZone domain.</p>
996
- * @public
997
- */
998
- domainIdentifier: string | undefined;
999
- /**
1000
- * <p>The identifier of the prediction.</p>
1001
- * @public
1002
- */
1003
- identifier: string | undefined;
1004
- /**
1005
- * <p>The revision that is to be made to the asset.</p>
1006
- * @public
1007
- */
1008
- revision?: string | undefined;
1009
- /**
1010
- * <p>Specifies the rule (or the conditions) under which a prediction can be rejected.</p>
1011
- * @public
1012
- */
1013
- rejectRule?: RejectRule | undefined;
1014
- /**
1015
- * <p>Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be rejected.</p>
1016
- * @public
1017
- */
1018
- rejectChoices?: RejectChoice[] | undefined;
1019
- /**
1020
- * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
1021
- * @public
1022
- */
1023
- clientToken?: string | undefined;
1024
- }
1025
- /**
1026
- * @public
1027
- */
1028
- export interface RejectPredictionsOutput {
1029
- /**
1030
- * <p>The ID of the Amazon DataZone domain.</p>
1031
- * @public
1032
- */
1033
- domainId: string | undefined;
1034
- /**
1035
- * <p>The ID of the asset.</p>
1036
- * @public
1037
- */
1038
- assetId: string | undefined;
1039
- /**
1040
- * <p>The revision that is to be made to the asset.</p>
1041
- * @public
1042
- */
1043
- assetRevision: string | undefined;
1044
- }
1045
- /**
1046
- * @public
1047
- */
1048
- export interface RejectSubscriptionRequestInput {
1049
- /**
1050
- * <p>The identifier of the Amazon DataZone domain in which the subscription request was rejected.</p>
1051
- * @public
1052
- */
1053
- domainIdentifier: string | undefined;
1054
- /**
1055
- * <p>The identifier of the subscription request that was rejected.</p>
1056
- * @public
1057
- */
1058
- identifier: string | undefined;
1059
- /**
1060
- * <p>The decision comment of the rejected subscription request.</p>
1061
- * @public
1062
- */
1063
- decisionComment?: string | undefined;
1064
- }
1065
- /**
1066
- * @public
1067
- */
1068
- export interface RejectSubscriptionRequestOutput {
1069
- /**
1070
- * <p>The identifier of the subscription request that was rejected.</p>
1071
- * @public
1072
- */
1073
- id: string | undefined;
1074
- /**
1075
- * <p>The timestamp of when the subscription request was rejected.</p>
1076
- * @public
1077
- */
1078
- createdBy: string | undefined;
1079
- /**
1080
- * <p>The Amazon DataZone user who updated the subscription request.</p>
1081
- * @public
1082
- */
1083
- updatedBy?: string | undefined;
1084
- /**
1085
- * <p>The identifier of the Amazon DataZone domain in which the subscription request was rejected.</p>
1086
- * @public
1087
- */
1088
- domainId: string | undefined;
1089
- /**
1090
- * <p>The status of the subscription request.</p>
1091
- * @public
1092
- */
1093
- status: SubscriptionRequestStatus | undefined;
1094
- /**
1095
- * <p>The timestamp of when the subscription request was rejected.</p>
1096
- * @public
1097
- */
1098
- createdAt: Date | undefined;
1099
- /**
1100
- * <p>The timestamp of when the subscription request was updated.</p>
1101
- * @public
1102
- */
1103
- updatedAt: Date | undefined;
1104
- /**
1105
- * <p>The reason for the subscription request.</p>
1106
- * @public
1107
- */
1108
- requestReason: string | undefined;
1109
- /**
1110
- * <p>The subscribed principals of the subscription request.</p>
1111
- * @public
1112
- */
1113
- subscribedPrincipals: SubscribedPrincipal[] | undefined;
1114
- /**
1115
- * <p>The subscribed listings of the subscription request.</p>
1116
- * @public
1117
- */
1118
- subscribedListings: SubscribedListing[] | undefined;
1119
- /**
1120
- * <p>The identifier of the subscription request reviewer.</p>
1121
- * @public
1122
- */
1123
- reviewerId?: string | undefined;
1124
- /**
1125
- * <p>The decision comment of the rejected subscription request.</p>
1126
- * @public
1127
- */
1128
- decisionComment?: string | undefined;
1129
- /**
1130
- * <p>The ID of the existing subscription.</p>
1131
- * @public
1132
- */
1133
- existingSubscriptionId?: string | undefined;
1134
- /**
1135
- * <p>Metadata forms included in the subscription request.</p>
1136
- * @public
1137
- */
1138
- metadataForms?: FormOutput[] | undefined;
1139
- }
1140
- /**
1141
- * @public
1142
- */
1143
- export interface RemoveEntityOwnerInput {
1144
- /**
1145
- * <p>The ID of the domain where you want to remove an owner from an entity.</p>
1146
- * @public
1147
- */
1148
- domainIdentifier: string | undefined;
1149
- /**
1150
- * <p>The type of the entity from which you want to remove an owner.</p>
1151
- * @public
1152
- */
1153
- entityType: DataZoneEntityType | undefined;
1154
- /**
1155
- * <p>The ID of the entity from which you want to remove an owner.</p>
1156
- * @public
1157
- */
1158
- entityIdentifier: string | undefined;
1159
- /**
1160
- * <p>The owner that you want to remove from an entity.</p>
1161
- * @public
1162
- */
1163
- owner: OwnerProperties | undefined;
1164
- /**
1165
- * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
1166
- * @public
1167
- */
1168
- clientToken?: string | undefined;
1169
- }
1170
- /**
1171
- * @public
1172
- */
1173
- export interface RemoveEntityOwnerOutput {
1174
- }
1175
- /**
1176
- * @public
1177
- */
1178
- export interface RemovePolicyGrantInput {
1179
- /**
1180
- * <p>The ID of the domain where you want to remove a policy grant.</p>
1181
- * @public
1182
- */
1183
- domainIdentifier: string | undefined;
1184
- /**
1185
- * <p>The type of the entity from which you want to remove a policy grant.</p>
1186
- * @public
1187
- */
1188
- entityType: TargetEntityType | undefined;
1189
- /**
1190
- * <p>The ID of the entity from which you want to remove a policy grant.</p>
1191
- * @public
1192
- */
1193
- entityIdentifier: string | undefined;
1194
- /**
1195
- * <p>The type of the policy that you want to remove.</p>
1196
- * @public
1197
- */
1198
- policyType: ManagedPolicyType | undefined;
1199
- /**
1200
- * <p>The principal from which you want to remove a policy grant.</p>
1201
- * @public
1202
- */
1203
- principal: PolicyGrantPrincipal | undefined;
1204
- /**
1205
- * <p>The ID of the policy grant that is to be removed from a specified entity.</p>
1206
- * @public
1207
- */
1208
- grantIdentifier?: string | undefined;
1209
- /**
1210
- * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
1211
- * @public
1212
- */
1213
- clientToken?: string | undefined;
1214
- }
1215
- /**
1216
- * @public
1217
- */
1218
- export interface RemovePolicyGrantOutput {
1219
- }
1220
- /**
1221
- * @public
1222
- */
1223
- export interface RevokeSubscriptionInput {
1224
- /**
1225
- * <p>The identifier of the Amazon DataZone domain where you want to revoke a subscription.</p>
1226
- * @public
1227
- */
1228
- domainIdentifier: string | undefined;
1229
- /**
1230
- * <p>The identifier of the revoked subscription.</p>
1231
- * @public
1232
- */
1233
- identifier: string | undefined;
1234
- /**
1235
- * <p>Specifies whether permissions are retained when the subscription is revoked.</p>
1236
- * @public
1237
- */
1238
- retainPermissions?: boolean | undefined;
1239
- }
1240
- /**
1241
- * @public
1242
- */
1243
- export interface RevokeSubscriptionOutput {
1244
- /**
1245
- * <p>The identifier of the revoked subscription.</p>
1246
- * @public
1247
- */
1248
- id: string | undefined;
1249
- /**
1250
- * <p>The identifier of the user who revoked the subscription.</p>
1251
- * @public
1252
- */
1253
- createdBy: string | undefined;
1254
- /**
1255
- * <p>The Amazon DataZone user who revoked the subscription.</p>
1256
- * @public
1257
- */
1258
- updatedBy?: string | undefined;
1259
- /**
1260
- * <p>The identifier of the Amazon DataZone domain where you want to revoke a subscription.</p>
1261
- * @public
1262
- */
1263
- domainId: string | undefined;
1264
- /**
1265
- * <p>The status of the revoked subscription.</p>
1266
- * @public
1267
- */
1268
- status: SubscriptionStatus | undefined;
1269
- /**
1270
- * <p>The timestamp of when the subscription was revoked.</p>
1271
- * @public
1272
- */
1273
- createdAt: Date | undefined;
1274
- /**
1275
- * <p>The timestamp of when the subscription was revoked.</p>
1276
- * @public
1277
- */
1278
- updatedAt: Date | undefined;
1279
- /**
1280
- * <p>The subscribed principal of the revoked subscription.</p>
1281
- * @public
1282
- */
1283
- subscribedPrincipal: SubscribedPrincipal | undefined;
1284
- /**
1285
- * <p>The subscribed listing of the revoked subscription.</p>
1286
- * @public
1287
- */
1288
- subscribedListing: SubscribedListing | undefined;
1289
- /**
1290
- * <p>The identifier of the subscription request for the revoked subscription.</p>
1291
- * @public
1292
- */
1293
- subscriptionRequestId?: string | undefined;
1294
- /**
1295
- * <p>Specifies whether permissions are retained when the subscription is revoked.</p>
1296
- * @public
1297
- */
1298
- retainPermissions?: boolean | undefined;
1299
- }
1300
- /**
1301
- * @public
1302
- */
1303
- export interface DeleteRuleInput {
1304
- /**
1305
- * <p>The ID of the domain that where the rule is to be deleted.</p>
1306
- * @public
1307
- */
1308
- domainIdentifier: string | undefined;
1309
- /**
1310
- * <p>The ID of the rule that is to be deleted.</p>
1311
- * @public
1312
- */
1313
- identifier: string | undefined;
1314
- }
1315
- /**
1316
- * @public
1317
- */
1318
- export interface DeleteRuleOutput {
1319
- }
1320
- /**
1321
- * @public
1322
- */
1323
- export interface GetRuleInput {
1324
- /**
1325
- * <p>The ID of the domain where the <code>GetRule</code> action is to be invoked.</p>
1326
- * @public
1327
- */
1328
- domainIdentifier: string | undefined;
1329
- /**
1330
- * <p>The ID of the rule.</p>
1331
- * @public
1332
- */
1333
- identifier: string | undefined;
1334
- /**
1335
- * <p>The revision of the rule.</p>
1336
- * @public
1337
- */
1338
- revision?: string | undefined;
1339
- }
1340
- /**
1341
- * @public
1342
- */
1343
- export interface GetRuleOutput {
1344
- /**
1345
- * <p>The ID of the rule.</p>
1346
- * @public
1347
- */
1348
- identifier: string | undefined;
1349
- /**
1350
- * <p>The revision of the rule.</p>
1351
- * @public
1352
- */
1353
- revision: string | undefined;
1354
- /**
1355
- * <p>The name of the rule.</p>
1356
- * @public
1357
- */
1358
- name: string | undefined;
1359
- /**
1360
- * <p>The type of the rule.</p>
1361
- * @public
1362
- */
1363
- ruleType: RuleType | undefined;
1364
- /**
1365
- * <p>The target of the rule.</p>
1366
- * @public
1367
- */
1368
- target: RuleTarget | undefined;
1369
- /**
1370
- * <p>The action of the rule.</p>
1371
- * @public
1372
- */
1373
- action: RuleAction | undefined;
1374
- /**
1375
- * <p>The scope of the rule.</p>
1376
- * @public
1377
- */
1378
- scope: RuleScope | undefined;
1379
- /**
1380
- * <p>The detail of the rule.</p>
1381
- * @public
1382
- */
1383
- detail: RuleDetail | undefined;
1384
- /**
1385
- * <p>The target type of the rule.</p>
1386
- * @public
1387
- */
1388
- targetType?: RuleTargetType | undefined;
1389
- /**
1390
- * <p>The description of the rule.</p>
1391
- * @public
1392
- */
1393
- description?: string | undefined;
1394
- /**
1395
- * <p>The timestamp at which the rule was created.</p>
1396
- * @public
1397
- */
1398
- createdAt: Date | undefined;
1399
- /**
1400
- * <p>The timestamp at which the rule was last updated.</p>
1401
- * @public
1402
- */
1403
- updatedAt: Date | undefined;
1404
- /**
1405
- * <p>The user who created the rule.</p>
1406
- * @public
1407
- */
1408
- createdBy: string | undefined;
1409
- /**
1410
- * <p>The timestamp at which the rule was last updated.</p>
1411
- * @public
1412
- */
1413
- lastUpdatedBy: string | undefined;
1414
- }
1415
- /**
1416
- * @public
1417
- */
1418
- export interface ListRulesInput {
1419
- /**
1420
- * <p>The ID of the domain in which the rules are to be listed.</p>
1421
- * @public
1422
- */
1423
- domainIdentifier: string | undefined;
1424
- /**
1425
- * <p>The target type of the rule.</p>
1426
- * @public
1427
- */
1428
- targetType: RuleTargetType | undefined;
1429
- /**
1430
- * <p>The target ID of the rule.</p>
1431
- * @public
1432
- */
1433
- targetIdentifier: string | undefined;
1434
- /**
1435
- * <p>The type of the rule.</p>
1436
- * @public
1437
- */
1438
- ruleType?: RuleType | undefined;
1439
- /**
1440
- * <p>The action of the rule.</p>
1441
- * @public
1442
- */
1443
- action?: RuleAction | undefined;
1444
- /**
1445
- * <p>The IDs of projects in which rules are to be listed.</p>
1446
- * @public
1447
- */
1448
- projectIds?: string[] | undefined;
1449
- /**
1450
- * <p>The asset types of the rule.</p>
1451
- * @public
1452
- */
1453
- assetTypes?: string[] | undefined;
1454
- /**
1455
- * <p>The data product of the rule.</p>
1456
- * @public
1457
- */
1458
- dataProduct?: boolean | undefined;
1459
- /**
1460
- * <p>Specifies whether to include cascading rules in the results.</p>
1461
- * @public
1462
- */
1463
- includeCascaded?: boolean | undefined;
1464
- /**
1465
- * <p>The maximum number of rules to return in a single call to <code>ListRules</code>. When the number of rules to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListRules</code> to list the next set of rules.</p>
1466
- * @public
1467
- */
1468
- maxResults?: number | undefined;
1469
- /**
1470
- * <p>When the number of rules is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of rules, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListRules</code> to list the next set of rules.</p>
1471
- * @public
1472
- */
1473
- nextToken?: string | undefined;
1474
- }
1475
- /**
1476
- * <p>The summary of the rule.</p>
1477
- * @public
1478
- */
1479
- export interface RuleSummary {
1480
- /**
1481
- * <p>The ID of the rule.</p>
1482
- * @public
1483
- */
1484
- identifier?: string | undefined;
1485
- /**
1486
- * <p>The revision of the rule.</p>
1487
- * @public
1488
- */
1489
- revision?: string | undefined;
1490
- /**
1491
- * <p>The type of the rule.</p>
1492
- * @public
1493
- */
1494
- ruleType?: RuleType | undefined;
1495
- /**
1496
- * <p>The name of the rule.</p>
1497
- * @public
1498
- */
1499
- name?: string | undefined;
1500
- /**
1501
- * <p>The target type of the rule.</p>
1502
- * @public
1503
- */
1504
- targetType?: RuleTargetType | undefined;
1505
- /**
1506
- * <p>The target of the rule.</p>
1507
- * @public
1508
- */
1509
- target?: RuleTarget | undefined;
1510
- /**
1511
- * <p>The action of the rule.</p>
1512
- * @public
1513
- */
1514
- action?: RuleAction | undefined;
1515
- /**
1516
- * <p>The scope of the rule.</p>
1517
- * @public
1518
- */
1519
- scope?: RuleScope | undefined;
1520
- /**
1521
- * <p>The timestamp at which the rule was last updated.</p>
1522
- * @public
1523
- */
1524
- updatedAt?: Date | undefined;
1525
- /**
1526
- * <p>The timestamp at which the rule was last updated.</p>
1527
- * @public
1528
- */
1529
- lastUpdatedBy?: string | undefined;
1530
- }
1531
- /**
1532
- * @public
1533
- */
1534
- export interface ListRulesOutput {
1535
- /**
1536
- * <p>The results of the <code>ListRules</code> action.</p>
1537
- * @public
1538
- */
1539
- items: RuleSummary[] | undefined;
1540
- /**
1541
- * <p>When the number of rules is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of rules, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListRules</code> to list the next set of rules.</p>
1542
- * @public
1543
- */
1544
- nextToken?: string | undefined;
1545
- }
1546
- /**
1547
- * @public
1548
- */
1549
- export interface UpdateRuleInput {
1550
- /**
1551
- * <p>The ID of the domain in which a rule is to be updated.</p>
1552
- * @public
1553
- */
1554
- domainIdentifier: string | undefined;
1555
- /**
1556
- * <p>The ID of the rule that is to be updated</p>
1557
- * @public
1558
- */
1559
- identifier: string | undefined;
1560
- /**
1561
- * <p>The name of the rule.</p>
1562
- * @public
1563
- */
1564
- name?: string | undefined;
1565
- /**
1566
- * <p>The description of the rule.</p>
1567
- * @public
1568
- */
1569
- description?: string | undefined;
1570
- /**
1571
- * <p>The scrope of the rule.</p>
1572
- * @public
1573
- */
1574
- scope?: RuleScope | undefined;
1575
- /**
1576
- * <p>The detail of the rule.</p>
1577
- * @public
1578
- */
1579
- detail?: RuleDetail | undefined;
1580
- /**
1581
- * <p>Specifies whether to update this rule in the child domain units.</p>
1582
- * @public
1583
- */
1584
- includeChildDomainUnits?: boolean | undefined;
1585
- }
1586
- /**
1587
- * @public
1588
- */
1589
- export interface UpdateRuleOutput {
1590
- /**
1591
- * <p>The ID of the rule.</p>
1592
- * @public
1593
- */
1594
- identifier: string | undefined;
1595
- /**
1596
- * <p>The revision of the rule.</p>
1597
- * @public
1598
- */
1599
- revision: string | undefined;
1600
- /**
1601
- * <p>The name of the rule.</p>
1602
- * @public
1603
- */
1604
- name: string | undefined;
1605
- /**
1606
- * <p>The type of the rule.</p>
1607
- * @public
1608
- */
1609
- ruleType: RuleType | undefined;
1610
- /**
1611
- * <p>The target of the rule.</p>
1612
- * @public
1613
- */
1614
- target: RuleTarget | undefined;
1615
- /**
1616
- * <p>The action of the rule.</p>
1617
- * @public
1618
- */
1619
- action: RuleAction | undefined;
1620
- /**
1621
- * <p>The scope of the rule.</p>
1622
- * @public
1623
- */
1624
- scope: RuleScope | undefined;
1625
- /**
1626
- * <p>The detail of the rule.</p>
1627
- * @public
1628
- */
1629
- detail: RuleDetail | undefined;
1630
- /**
1631
- * <p>The description of the rule.</p>
1632
- * @public
1633
- */
1634
- description?: string | undefined;
1635
- /**
1636
- * <p>The timestamp at which the rule was created.</p>
1637
- * @public
1638
- */
1639
- createdAt: Date | undefined;
1640
- /**
1641
- * <p>The timestamp at which the rule was last updated.</p>
1642
- * @public
1643
- */
1644
- updatedAt: Date | undefined;
1645
- /**
1646
- * <p>The user who created the rule.</p>
1647
- * @public
1648
- */
1649
- createdBy: string | undefined;
1650
- /**
1651
- * <p>The timestamp at which the rule was last updated.</p>
1652
- * @public
1653
- */
1654
- lastUpdatedBy: string | undefined;
1655
- }
1656
- /**
1657
- * @public
1658
- * @enum
1659
- */
1660
- export declare const SearchOutputAdditionalAttribute: {
1661
- readonly FORMS: "FORMS";
1662
- readonly TEXT_MATCH_RATIONALE: "TEXT_MATCH_RATIONALE";
1663
- readonly TIME_SERIES_DATA_POINT_FORMS: "TIME_SERIES_DATA_POINT_FORMS";
1664
- };
1665
- /**
1666
- * @public
1667
- */
1668
- export type SearchOutputAdditionalAttribute = (typeof SearchOutputAdditionalAttribute)[keyof typeof SearchOutputAdditionalAttribute];
1669
- /**
1670
- * <p>A search filter in Amazon DataZone.</p>
1671
- * @public
1672
- */
1673
- export interface Filter {
1674
- /**
1675
- * <p>A search filter attribute in Amazon DataZone.</p>
1676
- * @public
1677
- */
1678
- attribute: string | undefined;
1679
- /**
1680
- * <p>A search filter value in Amazon DataZone.</p>
1681
- * @public
1682
- */
1683
- value: string | undefined;
1684
- }
1685
- /**
1686
- * <p>The details of the search.</p>
1687
- * @public
1688
- */
1689
- export interface SearchInItem {
1690
- /**
1691
- * <p>The search attribute.</p>
1692
- * @public
1693
- */
1694
- attribute: string | undefined;
1695
- }
1696
- /**
1697
- * @public
1698
- * @enum
1699
- */
1700
- export declare const InventorySearchScope: {
1701
- readonly ASSET: "ASSET";
1702
- readonly DATA_PRODUCT: "DATA_PRODUCT";
1703
- readonly GLOSSARY: "GLOSSARY";
1704
- readonly GLOSSARY_TERM: "GLOSSARY_TERM";
1705
- };
1706
- /**
1707
- * @public
1708
- */
1709
- export type InventorySearchScope = (typeof InventorySearchScope)[keyof typeof InventorySearchScope];
1710
- /**
1711
- * <p>The details of the way to sort search results.</p>
1712
- * @public
1713
- */
1714
- export interface SearchSort {
1715
- /**
1716
- * <p>The attribute detail of the way to sort search results.</p>
1717
- * @public
1718
- */
1719
- attribute: string | undefined;
1720
- /**
1721
- * <p>The order detail of the wya to sort search results.</p>
1722
- * @public
1723
- */
1724
- order?: SortOrder | undefined;
1725
- }
1726
- /**
1727
- * <p>The additional attributes of an Amazon DataZone glossary.</p>
1728
- * @public
1729
- */
1730
- export interface GlossaryItemAdditionalAttributes {
1731
- /**
1732
- * <p>List of rationales indicating why this item was matched by search.</p>
1733
- * @public
1734
- */
1735
- matchRationale?: MatchRationaleItem[] | undefined;
1736
- }
1737
- /**
1738
- * <p>The details of a business glossary.</p>
1739
- * @public
1740
- */
1741
- export interface GlossaryItem {
1742
- /**
1743
- * <p>The identifier of the Amazon DataZone domain in which the business glossary exists.</p>
1744
- * @public
1745
- */
1746
- domainId: string | undefined;
1747
- /**
1748
- * <p>The identifier of the glossary.</p>
1749
- * @public
1750
- */
1751
- id: string | undefined;
1752
- /**
1753
- * <p>The name of the glossary.</p>
1754
- * @public
1755
- */
1756
- name: string | undefined;
1757
- /**
1758
- * <p>The identifier of the project that owns the business glosary.</p>
1759
- * @public
1760
- */
1761
- owningProjectId: string | undefined;
1762
- /**
1763
- * <p>The business glossary description.</p>
1764
- * @public
1765
- */
1766
- description?: string | undefined;
1767
- /**
1768
- * <p>The business glossary status.</p>
1769
- * @public
1770
- */
1771
- status: GlossaryStatus | undefined;
1772
- /**
1773
- * <p>The usage restrictions associated with a goverened glossary term.</p>
1774
- * @public
1775
- */
1776
- usageRestrictions?: GlossaryUsageRestriction[] | undefined;
1777
- /**
1778
- * <p>The timestamp of when the glossary was created.</p>
1779
- * @public
1780
- */
1781
- createdAt?: Date | undefined;
1782
- /**
1783
- * <p>The Amazon DataZone user who created the glossary.</p>
1784
- * @public
1785
- */
1786
- createdBy?: string | undefined;
1787
- /**
1788
- * <p>The timestamp of when the business glossary was updated.</p>
1789
- * @public
1790
- */
1791
- updatedAt?: Date | undefined;
1792
- /**
1793
- * <p>The Amazon DataZone user who updated the business glossary.</p>
1794
- * @public
1795
- */
1796
- updatedBy?: string | undefined;
1797
- /**
1798
- * <p>The additional attributes of an Amazon DataZone glossary.</p>
1799
- * @public
1800
- */
1801
- additionalAttributes?: GlossaryItemAdditionalAttributes | undefined;
1802
- }
1803
- /**
1804
- * <p>The additional attributes of an Amazon DataZone glossary term.</p>
1805
- * @public
1806
- */
1807
- export interface GlossaryTermItemAdditionalAttributes {
1808
- /**
1809
- * <p>List of rationales indicating why this item was matched by search.</p>
1810
- * @public
1811
- */
1812
- matchRationale?: MatchRationaleItem[] | undefined;
1813
- }
1814
- /**
1815
- * <p>The details of a business glossary term.</p>
1816
- * @public
1817
- */
1818
- export interface GlossaryTermItem {
1819
- /**
1820
- * <p>The identifier of the Amazon DataZone domain in which the business glossary exists.</p>
1821
- * @public
1822
- */
1823
- domainId: string | undefined;
1824
- /**
1825
- * <p>The identifier of the business glossary to which the term belongs.</p>
1826
- * @public
1827
- */
1828
- glossaryId: string | undefined;
1829
- /**
1830
- * <p>The identifier of the business glossary term.</p>
1831
- * @public
1832
- */
1833
- id: string | undefined;
1834
- /**
1835
- * <p>The name of the business glossary term.</p>
1836
- * @public
1837
- */
1838
- name: string | undefined;
1839
- /**
1840
- * <p>The short description of the business glossary term.</p>
1841
- * @public
1842
- */
1843
- shortDescription?: string | undefined;
1844
- /**
1845
- * <p>The usage restrictions associated with a goverened glossary term.</p>
1846
- * @public
1847
- */
1848
- usageRestrictions?: GlossaryUsageRestriction[] | undefined;
1849
- /**
1850
- * <p>The long description of the business glossary term.</p>
1851
- * @public
1852
- */
1853
- longDescription?: string | undefined;
1854
- /**
1855
- * <p>The relations of the business glossary term.</p>
1856
- * @public
1857
- */
1858
- termRelations?: TermRelations | undefined;
1859
- /**
1860
- * <p>The status of the business glossary term.</p>
1861
- * @public
1862
- */
1863
- status: GlossaryTermStatus | undefined;
1864
- /**
1865
- * <p>The timestamp of when a business glossary term was created.</p>
1866
- * @public
1867
- */
1868
- createdAt?: Date | undefined;
1869
- /**
1870
- * <p>The Amazon DataZone user who created the business glossary.</p>
1871
- * @public
1872
- */
1873
- createdBy?: string | undefined;
1874
- /**
1875
- * <p>The timestamp of when a business glossary term was updated.</p>
1876
- * @public
1877
- */
1878
- updatedAt?: Date | undefined;
1879
- /**
1880
- * <p>The Amazon DataZone user who updated the business glossary term.</p>
1881
- * @public
1882
- */
1883
- updatedBy?: string | undefined;
1884
- /**
1885
- * <p>The additional attributes of an Amazon DataZone glossary term.</p>
1886
- * @public
1887
- */
1888
- additionalAttributes?: GlossaryTermItemAdditionalAttributes | undefined;
1889
- }
1890
- /**
1891
- * <p>The details of the search results.</p>
1892
- * @public
1893
- */
1894
- export type SearchInventoryResultItem = SearchInventoryResultItem.AssetItemMember | SearchInventoryResultItem.DataProductItemMember | SearchInventoryResultItem.GlossaryItemMember | SearchInventoryResultItem.GlossaryTermItemMember | SearchInventoryResultItem.$UnknownMember;
1895
- /**
1896
- * @public
1897
- */
1898
- export declare namespace SearchInventoryResultItem {
1899
- /**
1900
- * <p>The glossary item included in the search results.</p>
1901
- * @public
1902
- */
1903
- interface GlossaryItemMember {
1904
- glossaryItem: GlossaryItem;
1905
- glossaryTermItem?: never;
1906
- assetItem?: never;
1907
- dataProductItem?: never;
1908
- $unknown?: never;
1909
- }
1910
- /**
1911
- * <p>The glossary term item included in the search results.</p>
1912
- * @public
1913
- */
1914
- interface GlossaryTermItemMember {
1915
- glossaryItem?: never;
1916
- glossaryTermItem: GlossaryTermItem;
1917
- assetItem?: never;
1918
- dataProductItem?: never;
1919
- $unknown?: never;
1920
- }
1921
- /**
1922
- * <p>The asset item included in the search results.</p>
1923
- * @public
1924
- */
1925
- interface AssetItemMember {
1926
- glossaryItem?: never;
1927
- glossaryTermItem?: never;
1928
- assetItem: AssetItem;
1929
- dataProductItem?: never;
1930
- $unknown?: never;
1931
- }
1932
- /**
1933
- * <p>The data product.</p>
1934
- * @public
1935
- */
1936
- interface DataProductItemMember {
1937
- glossaryItem?: never;
1938
- glossaryTermItem?: never;
1939
- assetItem?: never;
1940
- dataProductItem: DataProductResultItem;
1941
- $unknown?: never;
1942
- }
1943
- /**
1944
- * @public
1945
- */
1946
- interface $UnknownMember {
1947
- glossaryItem?: never;
1948
- glossaryTermItem?: never;
1949
- assetItem?: never;
1950
- dataProductItem?: never;
1951
- $unknown: [string, any];
1952
- }
1953
- /**
1954
- * @deprecated unused in schema-serde mode.
1955
- *
1956
- */
1957
- interface Visitor<T> {
1958
- glossaryItem: (value: GlossaryItem) => T;
1959
- glossaryTermItem: (value: GlossaryTermItem) => T;
1960
- assetItem: (value: AssetItem) => T;
1961
- dataProductItem: (value: DataProductResultItem) => T;
1962
- _: (name: string, value: any) => T;
1963
- }
1964
- }
1965
- /**
1966
- * @public
1967
- */
1968
- export interface SearchOutput {
1969
- /**
1970
- * <p>The results of the <code>Search</code> action.</p>
1971
- * @public
1972
- */
1973
- items?: SearchInventoryResultItem[] | undefined;
1974
- /**
1975
- * <p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>Search</code> to list the next set of results.</p>
1976
- * @public
1977
- */
1978
- nextToken?: string | undefined;
1979
- /**
1980
- * <p>Total number of search results.</p>
1981
- * @public
1982
- */
1983
- totalMatchCount?: number | undefined;
1984
- }
1985
- /**
1986
- * @public
1987
- * @enum
1988
- */
1989
- export declare const GroupSearchType: {
1990
- readonly DATAZONE_SSO_GROUP: "DATAZONE_SSO_GROUP";
1991
- readonly SSO_GROUP: "SSO_GROUP";
1992
- };
1993
- /**
1994
- * @public
1995
- */
1996
- export type GroupSearchType = (typeof GroupSearchType)[keyof typeof GroupSearchType];
1997
- /**
1998
- * @public
1999
- */
2000
- export interface SearchGroupProfilesInput {
2001
- /**
2002
- * <p>The identifier of the Amazon DataZone domain in which you want to search group profiles.</p>
2003
- * @public
2004
- */
2005
- domainIdentifier: string | undefined;
2006
- /**
2007
- * <p>The group type for which to search.</p>
2008
- * @public
2009
- */
2010
- groupType: GroupSearchType | undefined;
2011
- /**
2012
- * <p>Specifies the text for which to search.</p>
2013
- * @public
2014
- */
2015
- searchText?: string | undefined;
2016
- /**
2017
- * <p>The maximum number of results to return in a single call to <code>SearchGroupProfiles</code>. When the number of results to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>SearchGroupProfiles</code> to list the next set of results. </p>
2018
- * @public
2019
- */
2020
- maxResults?: number | undefined;
2021
- /**
2022
- * <p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchGroupProfiles</code> to list the next set of results.</p>
2023
- * @public
2024
- */
2025
- nextToken?: string | undefined;
2026
- }
2027
- /**
2028
- * <p>The details of a group profile.</p>
2029
- * @public
2030
- */
2031
- export interface GroupProfileSummary {
2032
- /**
2033
- * <p>The ID of the Amazon DataZone domain of a group profile.</p>
2034
- * @public
2035
- */
2036
- domainId?: string | undefined;
2037
- /**
2038
- * <p>The ID of a group profile.</p>
2039
- * @public
2040
- */
2041
- id?: string | undefined;
2042
- /**
2043
- * <p>The status of a group profile.</p>
2044
- * @public
2045
- */
2046
- status?: GroupProfileStatus | undefined;
2047
- /**
2048
- * <p>The group name of a group profile.</p>
2049
- * @public
2050
- */
2051
- groupName?: string | undefined;
2052
- }
2053
- /**
2054
- * @public
2055
- */
2056
- export interface SearchGroupProfilesOutput {
2057
- /**
2058
- * <p>The results of the <code>SearchGroupProfiles</code> action.</p>
2059
- * @public
2060
- */
2061
- items?: GroupProfileSummary[] | undefined;
2062
- /**
2063
- * <p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchGroupProfiles</code> to list the next set of results.</p>
2064
- * @public
2065
- */
2066
- nextToken?: string | undefined;
2067
- }
2068
- /**
2069
- * <p>The details of the results of the <code>SearchListings</code> action.</p>
2070
- * @public
2071
- */
2072
- export type SearchResultItem = SearchResultItem.AssetListingMember | SearchResultItem.DataProductListingMember | SearchResultItem.$UnknownMember;
2073
- /**
2074
- * @public
2075
- */
2076
- export declare namespace SearchResultItem {
2077
- /**
2078
- * <p>The asset listing included in the results of the <code>SearchListings</code> action.</p>
2079
- * @public
2080
- */
2081
- interface AssetListingMember {
2082
- assetListing: AssetListingItem;
2083
- dataProductListing?: never;
2084
- $unknown?: never;
2085
- }
2086
- /**
2087
- * <p>The data product listing.</p>
2088
- * @public
2089
- */
2090
- interface DataProductListingMember {
2091
- assetListing?: never;
2092
- dataProductListing: DataProductListingItem;
2093
- $unknown?: never;
2094
- }
2095
- /**
2096
- * @public
2097
- */
2098
- interface $UnknownMember {
2099
- assetListing?: never;
2100
- dataProductListing?: never;
2101
- $unknown: [string, any];
2102
- }
2103
- /**
2104
- * @deprecated unused in schema-serde mode.
2105
- *
2106
- */
2107
- interface Visitor<T> {
2108
- assetListing: (value: AssetListingItem) => T;
2109
- dataProductListing: (value: DataProductListingItem) => T;
2110
- _: (name: string, value: any) => T;
2111
- }
2112
- }
2113
- /**
2114
- * @public
2115
- */
2116
- export interface SearchListingsOutput {
2117
- /**
2118
- * <p>The results of the <code>SearchListings</code> action.</p>
2119
- * @public
2120
- */
2121
- items?: SearchResultItem[] | undefined;
2122
- /**
2123
- * <p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchListings</code> to list the next set of results.</p>
2124
- * @public
2125
- */
2126
- nextToken?: string | undefined;
2127
- /**
2128
- * <p>Total number of search results.</p>
2129
- * @public
2130
- */
2131
- totalMatchCount?: number | undefined;
2132
- /**
2133
- * <p>Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.</p>
2134
- * @public
2135
- */
2136
- aggregates?: AggregationOutput[] | undefined;
2137
- }
2138
- /**
2139
- * @public
2140
- * @enum
2141
- */
2142
- export declare const TypesSearchScope: {
2143
- readonly ASSET_TYPE: "ASSET_TYPE";
2144
- readonly FORM_TYPE: "FORM_TYPE";
2145
- readonly LINEAGE_NODE_TYPE: "LINEAGE_NODE_TYPE";
2146
- };
2147
- /**
2148
- * @public
2149
- */
2150
- export type TypesSearchScope = (typeof TypesSearchScope)[keyof typeof TypesSearchScope];
2151
- /**
2152
- * <p>The details of the metadata form type.</p>
2153
- * @public
2154
- */
2155
- export interface FormTypeData {
2156
- /**
2157
- * <p>The identifier of the Amazon DataZone domain in which the form type exists.</p>
2158
- * @public
2159
- */
2160
- domainId: string | undefined;
2161
- /**
2162
- * <p>The name of the form type.</p>
2163
- * @public
2164
- */
2165
- name: string | undefined;
2166
- /**
2167
- * <p>The revision of the form type.</p>
2168
- * @public
2169
- */
2170
- revision: string | undefined;
2171
- /**
2172
- * <p>The model of the form type.</p>
2173
- * @public
2174
- */
2175
- model?: Model | undefined;
2176
- /**
2177
- * <p>The status of the form type.</p>
2178
- * @public
2179
- */
2180
- status?: FormTypeStatus | undefined;
2181
- /**
2182
- * <p>The identifier of the project that owns the form type.</p>
2183
- * @public
2184
- */
2185
- owningProjectId?: string | undefined;
2186
- /**
2187
- * <p>The identifier of the Amazon DataZone domain in which the form type was originally created.</p>
2188
- * @public
2189
- */
2190
- originDomainId?: string | undefined;
2191
- /**
2192
- * <p>The identifier of the project in which the form type was originally created.</p>
2193
- * @public
2194
- */
2195
- originProjectId?: string | undefined;
2196
- /**
2197
- * <p>The timestamp of when the metadata form type was created.</p>
2198
- * @public
2199
- */
2200
- createdAt?: Date | undefined;
2201
- /**
2202
- * <p>The Amazon DataZone user who created teh metadata form type.</p>
2203
- * @public
2204
- */
2205
- createdBy?: string | undefined;
2206
- /**
2207
- * <p>The description of the metadata form type.</p>
2208
- * @public
2209
- */
2210
- description?: string | undefined;
2211
- /**
2212
- * <p>The imports specified in the form type.</p>
2213
- * @public
2214
- */
2215
- imports?: Import[] | undefined;
2216
- }
2217
- /**
2218
- * <p>The details of a data lineage node type.</p>
2219
- * @public
2220
- */
2221
- export interface LineageNodeTypeItem {
2222
- /**
2223
- * <p>The ID of the domain where the data lineage node type lives.</p>
2224
- * @public
2225
- */
2226
- domainId: string | undefined;
2227
- /**
2228
- * <p>The name of the data lineage node type.</p>
2229
- * @public
2230
- */
2231
- name?: string | undefined;
2232
- /**
2233
- * <p>The description of the data lineage node type.</p>
2234
- * @public
2235
- */
2236
- description?: string | undefined;
2237
- /**
2238
- * <p>The timestamp at which the data lineage node type was created.</p>
2239
- * @public
2240
- */
2241
- createdAt?: Date | undefined;
2242
- /**
2243
- * <p>The user who created the data lineage node type.</p>
2244
- * @public
2245
- */
2246
- createdBy?: string | undefined;
2247
- /**
2248
- * <p>The timestamp at which the data lineage node type was updated.</p>
2249
- * @public
2250
- */
2251
- updatedAt?: Date | undefined;
2252
- /**
2253
- * <p>The user who updated the data lineage node type.</p>
2254
- * @public
2255
- */
2256
- updatedBy?: string | undefined;
2257
- /**
2258
- * <p>The revision of the data lineage node type.</p>
2259
- * @public
2260
- */
2261
- revision: string | undefined;
2262
- /**
2263
- * <p>The forms output of the data lineage node type.</p>
2264
- * @public
2265
- */
2266
- formsOutput: Record<string, FormEntryOutput> | undefined;
2267
- }
2268
- /**
2269
- * <p>The details of the results of the <code>SearchTypes</code> action.</p>
2270
- * @public
2271
- */
2272
- export type SearchTypesResultItem = SearchTypesResultItem.AssetTypeItemMember | SearchTypesResultItem.FormTypeItemMember | SearchTypesResultItem.LineageNodeTypeItemMember | SearchTypesResultItem.$UnknownMember;
2273
- /**
2274
- * @public
2275
- */
2276
- export declare namespace SearchTypesResultItem {
2277
- /**
2278
- * <p>The asset type included in the results of the <code>SearchTypes</code> action.</p>
2279
- * @public
2280
- */
2281
- interface AssetTypeItemMember {
2282
- assetTypeItem: AssetTypeItem;
2283
- formTypeItem?: never;
2284
- lineageNodeTypeItem?: never;
2285
- $unknown?: never;
2286
- }
2287
- /**
2288
- * <p>The form type included in the results of the <code>SearchTypes</code> action.</p>
2289
- * @public
2290
- */
2291
- interface FormTypeItemMember {
2292
- assetTypeItem?: never;
2293
- formTypeItem: FormTypeData;
2294
- lineageNodeTypeItem?: never;
2295
- $unknown?: never;
2296
- }
2297
- /**
2298
- * <p>The details of a data lineage node type.</p>
2299
- * @public
2300
- */
2301
- interface LineageNodeTypeItemMember {
2302
- assetTypeItem?: never;
2303
- formTypeItem?: never;
2304
- lineageNodeTypeItem: LineageNodeTypeItem;
2305
- $unknown?: never;
2306
- }
2307
- /**
2308
- * @public
2309
- */
2310
- interface $UnknownMember {
2311
- assetTypeItem?: never;
2312
- formTypeItem?: never;
2313
- lineageNodeTypeItem?: never;
2314
- $unknown: [string, any];
2315
- }
2316
- /**
2317
- * @deprecated unused in schema-serde mode.
2318
- *
2319
- */
2320
- interface Visitor<T> {
2321
- assetTypeItem: (value: AssetTypeItem) => T;
2322
- formTypeItem: (value: FormTypeData) => T;
2323
- lineageNodeTypeItem: (value: LineageNodeTypeItem) => T;
2324
- _: (name: string, value: any) => T;
2325
- }
2326
- }
2327
- /**
2328
- * @public
2329
- */
2330
- export interface SearchTypesOutput {
2331
- /**
2332
- * <p>The results of the <code>SearchTypes</code> action.</p>
2333
- * @public
2334
- */
2335
- items?: SearchTypesResultItem[] | undefined;
2336
- /**
2337
- * <p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchTypes</code> to list the next set of results.</p>
2338
- * @public
2339
- */
2340
- nextToken?: string | undefined;
2341
- /**
2342
- * <p>Total number of search results.</p>
2343
- * @public
2344
- */
2345
- totalMatchCount?: number | undefined;
2346
- }
2347
- /**
2348
- * @public
2349
- * @enum
2350
- */
2351
- export declare const UserSearchType: {
2352
- readonly DATAZONE_IAM_USER: "DATAZONE_IAM_USER";
2353
- readonly DATAZONE_SSO_USER: "DATAZONE_SSO_USER";
2354
- readonly DATAZONE_USER: "DATAZONE_USER";
2355
- readonly SSO_USER: "SSO_USER";
2356
- };
2357
- /**
2358
- * @public
2359
- */
2360
- export type UserSearchType = (typeof UserSearchType)[keyof typeof UserSearchType];
2361
- /**
2362
- * @public
2363
- */
2364
- export interface SearchUserProfilesInput {
2365
- /**
2366
- * <p>The identifier of the Amazon DataZone domain in which you want to search user profiles.</p>
2367
- * @public
2368
- */
2369
- domainIdentifier: string | undefined;
2370
- /**
2371
- * <p>Specifies the user type for the <code>SearchUserProfiles</code> action.</p>
2372
- * @public
2373
- */
2374
- userType: UserSearchType | undefined;
2375
- /**
2376
- * <p>Specifies the text for which to search.</p>
2377
- * @public
2378
- */
2379
- searchText?: string | undefined;
2380
- /**
2381
- * <p>The maximum number of results to return in a single call to <code>SearchUserProfiles</code>. When the number of results to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results. </p>
2382
- * @public
2383
- */
2384
- maxResults?: number | undefined;
2385
- /**
2386
- * <p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results.</p>
2387
- * @public
2388
- */
2389
- nextToken?: string | undefined;
2390
- }
2391
- /**
2392
- * <p>The details of the user profile.</p>
2393
- * @public
2394
- */
2395
- export interface UserProfileSummary {
2396
- /**
2397
- * <p>The ID of the Amazon DataZone domain of the user profile.</p>
2398
- * @public
2399
- */
2400
- domainId?: string | undefined;
2401
- /**
2402
- * <p>The ID of the user profile.</p>
2403
- * @public
2404
- */
2405
- id?: string | undefined;
2406
- /**
2407
- * <p>The type of the user profile.</p>
2408
- * @public
2409
- */
2410
- type?: UserProfileType | undefined;
2411
- /**
2412
- * <p>The status of the user profile.</p>
2413
- * @public
2414
- */
2415
- status?: UserProfileStatus | undefined;
2416
- /**
2417
- * <p>The details of the user profile.</p>
2418
- * @public
2419
- */
2420
- details?: UserProfileDetails | undefined;
2421
- }
2422
- /**
2423
- * @public
2424
- */
2425
- export interface SearchUserProfilesOutput {
2426
- /**
2427
- * <p>The results of the <code>SearchUserProfiles</code> action.</p>
2428
- * @public
2429
- */
2430
- items?: UserProfileSummary[] | undefined;
2431
- /**
2432
- * <p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results.</p>
2433
- * @public
2434
- */
2435
- nextToken?: string | undefined;
2436
- }
2437
- /**
2438
- * @public
2439
- */
2440
- export interface TagResourceRequest {
2441
- /**
2442
- * <p>The ARN of the resource to be tagged in Amazon DataZone.</p>
2443
- * @public
2444
- */
2445
- resourceArn: string | undefined;
2446
- /**
2447
- * <p>Specifies the tags for the <code>TagResource</code> action.</p>
2448
- * @public
2449
- */
2450
- tags: Record<string, string> | undefined;
2451
- }
2452
- /**
2453
- * @public
2454
- */
2455
- export interface TagResourceResponse {
2456
- }
2457
- /**
2458
- * @public
2459
- */
2460
- export interface UntagResourceRequest {
2461
- /**
2462
- * <p>The ARN of the resource to be untagged in Amazon DataZone.</p>
2463
- * @public
2464
- */
2465
- resourceArn: string | undefined;
2466
- /**
2467
- * <p>Specifies the tag keys for the <code>UntagResource</code> action.</p>
2468
- * @public
2469
- */
2470
- tagKeys: string[] | undefined;
2471
- }
2472
- /**
2473
- * @public
2474
- */
2475
- export interface UntagResourceResponse {
2476
- }
2477
- /**
2478
- * @public
2479
- */
2480
- export interface UpdateAccountPoolInput {
2481
- /**
2482
- * <p>The domain ID where the account pool that is to be updated lives.</p>
2483
- * @public
2484
- */
2485
- domainIdentifier: string | undefined;
2486
- /**
2487
- * <p>The ID of the account pool that is to be updated.</p>
2488
- * @public
2489
- */
2490
- identifier: string | undefined;
2491
- /**
2492
- * <p>The name of the account pool that is to be updated.</p>
2493
- * @public
2494
- */
2495
- name?: string | undefined;
2496
- /**
2497
- * <p>The description of the account pool that is to be udpated.</p>
2498
- * @public
2499
- */
2500
- description?: string | undefined;
2501
- /**
2502
- * <p>The mechanism used to resolve the account selection from the account pool.</p>
2503
- * @public
2504
- */
2505
- resolutionStrategy?: ResolutionStrategy | undefined;
2506
- /**
2507
- * <p>The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler. </p>
2508
- * @public
2509
- */
2510
- accountSource?: AccountSource | undefined;
2511
- }
2512
- /**
2513
- * @public
2514
- */
2515
- export interface UpdateAccountPoolOutput {
2516
- /**
2517
- * <p>The domain ID where the account pool that is to be updated lives.</p>
2518
- * @public
2519
- */
2520
- domainId?: string | undefined;
2521
- /**
2522
- * <p>The name of the account pool that is to be updated.</p>
2523
- * @public
2524
- */
2525
- name?: string | undefined;
2526
- /**
2527
- * <p>The ID of the account pool that is to be updated.</p>
2528
- * @public
2529
- */
2530
- id?: string | undefined;
2531
- /**
2532
- * <p>The description of the account pool that is to be udpated.</p>
2533
- * @public
2534
- */
2535
- description?: string | undefined;
2536
- /**
2537
- * <p>The mechanism used to resolve the account selection from the account pool.</p>
2538
- * @public
2539
- */
2540
- resolutionStrategy?: ResolutionStrategy | undefined;
2541
- /**
2542
- * <p>The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler. </p>
2543
- * @public
2544
- */
2545
- accountSource: AccountSource | undefined;
2546
- /**
2547
- * <p>The user who created the account pool.</p>
2548
- * @public
2549
- */
2550
- createdBy: string | undefined;
2551
- /**
2552
- * <p>The timestamp at which the account pool was created.</p>
2553
- * @public
2554
- */
2555
- createdAt?: Date | undefined;
2556
- /**
2557
- * <p>The timestamp at which the account pool was last updated.</p>
2558
- * @public
2559
- */
2560
- lastUpdatedAt?: Date | undefined;
2561
- /**
2562
- * <p>The user who last updated the account pool.</p>
2563
- * @public
2564
- */
2565
- updatedBy?: string | undefined;
2566
- /**
2567
- * <p>The domain ID in which the account pool that is to be updated lives.</p>
2568
- * @public
2569
- */
2570
- domainUnitId?: string | undefined;
2571
- }
2572
- /**
2573
- * @public
2574
- */
2575
- export interface UpdateConnectionInput {
2576
- /**
2577
- * <p>The ID of the domain where a connection is to be updated.</p>
2578
- * @public
2579
- */
2580
- domainIdentifier: string | undefined;
2581
- /**
2582
- * <p>The ID of the connection to be updated.</p>
2583
- * @public
2584
- */
2585
- identifier: string | undefined;
2586
- /**
2587
- * <p>The description of a connection.</p>
2588
- * @public
2589
- */
2590
- description?: string | undefined;
2591
- /**
2592
- * <p>The location where a connection is to be updated.</p>
2593
- * @public
2594
- */
2595
- awsLocation?: AwsLocation | undefined;
2596
- /**
2597
- * <p>The connection props.</p>
2598
- * @public
2599
- */
2600
- props?: ConnectionPropertiesPatch | undefined;
2601
- }
2602
- /**
2603
- * @public
2604
- */
2605
- export interface UpdateConnectionOutput {
2606
- /**
2607
- * <p>The ID of the connection.</p>
2608
- * @public
2609
- */
2610
- connectionId: string | undefined;
2611
- /**
2612
- * <p>The connection description.</p>
2613
- * @public
2614
- */
2615
- description?: string | undefined;
2616
- /**
2617
- * <p>The ID of the domain where a connection is to be updated.</p>
2618
- * @public
2619
- */
2620
- domainId: string | undefined;
2621
- /**
2622
- * <p>The ID of the domain unit where a connection is to be updated.</p>
2623
- * @public
2624
- */
2625
- domainUnitId: string | undefined;
2626
- /**
2627
- * <p>The ID of the environment where a connection is to be updated.</p>
2628
- * @public
2629
- */
2630
- environmentId?: string | undefined;
2631
- /**
2632
- * <p>The name of the connection.</p>
2633
- * @public
2634
- */
2635
- name: string | undefined;
2636
- /**
2637
- * <p>The physical endpoints of the connection.</p>
2638
- * @public
2639
- */
2640
- physicalEndpoints: PhysicalEndpoint[] | undefined;
2641
- /**
2642
- * <p>The project ID of the connection.</p>
2643
- * @public
2644
- */
2645
- projectId?: string | undefined;
2646
- /**
2647
- * <p>The connection props.</p>
2648
- * @public
2649
- */
2650
- props?: ConnectionPropertiesOutput | undefined;
2651
- /**
2652
- * <p>The connection type.</p>
2653
- * @public
2654
- */
2655
- type: ConnectionType | undefined;
2656
- /**
2657
- * <p>The scope of the connection.</p>
2658
- * @public
2659
- */
2660
- scope?: ConnectionScope | undefined;
2661
- }
2662
- /**
2663
- * @public
2664
- */
2665
- export interface UpdateEnvironmentInput {
2666
- /**
2667
- * <p>The identifier of the domain in which the environment is to be updated.</p>
2668
- * @public
2669
- */
2670
- domainIdentifier: string | undefined;
2671
- /**
2672
- * <p>The identifier of the environment that is to be updated.</p>
2673
- * @public
2674
- */
2675
- identifier: string | undefined;
2676
- /**
2677
- * <p>The name to be updated as part of the <code>UpdateEnvironment</code> action.</p>
2678
- * @public
2679
- */
2680
- name?: string | undefined;
2681
- /**
2682
- * <p>The description to be updated as part of the <code>UpdateEnvironment</code> action.</p>
2683
- * @public
2684
- */
2685
- description?: string | undefined;
2686
- /**
2687
- * <p>The glossary terms to be updated as part of the <code>UpdateEnvironment</code> action.</p>
2688
- * @public
2689
- */
2690
- glossaryTerms?: string[] | undefined;
2691
- /**
2692
- * <p>The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: <code>latest</code>.</p>
2693
- * @public
2694
- */
2695
- blueprintVersion?: string | undefined;
2696
- /**
2697
- * <p>The user parameters of the environment.</p>
2698
- * @public
2699
- */
2700
- userParameters?: EnvironmentParameter[] | undefined;
2701
- }
2702
- /**
2703
- * @public
2704
- */
2705
- export interface UpdateEnvironmentOutput {
2706
- /**
2707
- * <p>The project identifier of the environment.</p>
2708
- * @public
2709
- */
2710
- projectId: string | undefined;
2711
- /**
2712
- * <p>The identifier of the environment that is to be updated.</p>
2713
- * @public
2714
- */
2715
- id?: string | undefined;
2716
- /**
2717
- * <p>The identifier of the domain in which the environment is to be updated.</p>
2718
- * @public
2719
- */
2720
- domainId: string | undefined;
2721
- /**
2722
- * <p>The Amazon DataZone user who created the environment.</p>
2723
- * @public
2724
- */
2725
- createdBy: string | undefined;
2726
- /**
2727
- * <p>The timestamp of when the environment was created.</p>
2728
- * @public
2729
- */
2730
- createdAt?: Date | undefined;
2731
- /**
2732
- * <p>The timestamp of when the environment was updated.</p>
2733
- * @public
2734
- */
2735
- updatedAt?: Date | undefined;
2736
- /**
2737
- * <p>The name to be updated as part of the <code>UpdateEnvironment</code> action.</p>
2738
- * @public
2739
- */
2740
- name: string | undefined;
2741
- /**
2742
- * <p>The description to be updated as part of the <code>UpdateEnvironment</code> action.</p>
2743
- * @public
2744
- */
2745
- description?: string | undefined;
2746
- /**
2747
- * <p>The profile identifier of the environment.</p>
2748
- * @public
2749
- */
2750
- environmentProfileId?: string | undefined;
2751
- /**
2752
- * <p>The identifier of the Amazon Web Services account in which the environment is to be updated.</p>
2753
- * @public
2754
- */
2755
- awsAccountId?: string | undefined;
2756
- /**
2757
- * <p>The Amazon Web Services Region in which the environment is updated.</p>
2758
- * @public
2759
- */
2760
- awsAccountRegion?: string | undefined;
2761
- /**
2762
- * <p>The provider identifier of the environment.</p>
2763
- * @public
2764
- */
2765
- provider: string | undefined;
2766
- /**
2767
- * <p>The provisioned resources to be updated as part of the <code>UpdateEnvironment</code> action.</p>
2768
- * @public
2769
- */
2770
- provisionedResources?: Resource[] | undefined;
2771
- /**
2772
- * <p>The status to be updated as part of the <code>UpdateEnvironment</code> action.</p>
2773
- * @public
2774
- */
2775
- status?: EnvironmentStatus | undefined;
2776
- /**
2777
- * <p>The environment actions to be updated as part of the <code>UpdateEnvironment</code> action.</p>
2778
- * @public
2779
- */
2780
- environmentActions?: ConfigurableEnvironmentAction[] | undefined;
2781
- /**
2782
- * <p>The glossary terms to be updated as part of the <code>UpdateEnvironment</code> action.</p>
2783
- * @public
2784
- */
2785
- glossaryTerms?: string[] | undefined;
2786
- /**
2787
- * <p>The user parameters to be updated as part of the <code>UpdateEnvironment</code> action.</p>
2788
- * @public
2789
- */
2790
- userParameters?: CustomParameter[] | undefined;
2791
- /**
2792
- * <p>The last deployment of the environment.</p>
2793
- * @public
2794
- */
2795
- lastDeployment?: Deployment | undefined;
2796
- /**
2797
- * <p>The provisioning properties to be updated as part of the <code>UpdateEnvironment</code> action.</p>
2798
- * @public
2799
- */
2800
- provisioningProperties?: ProvisioningProperties | undefined;
2801
- /**
2802
- * <p>The deployment properties to be updated as part of the <code>UpdateEnvironment</code> action.</p>
2803
- * @public
2804
- */
2805
- deploymentProperties?: DeploymentProperties | undefined;
2806
- /**
2807
- * <p>The blueprint identifier of the environment.</p>
2808
- * @public
2809
- */
2810
- environmentBlueprintId?: string | undefined;
2811
- /**
2812
- * <p>The configuration ID of the environment.</p>
2813
- * @public
2814
- */
2815
- environmentConfigurationId?: string | undefined;
2816
- }
1
+ import { FilterStatus, GroupProfileStatus, InventorySearchScope, ProjectStatus, SearchOutputAdditionalAttribute, Status, SubscriptionGrantOverallStatus, SubscriptionGrantStatus, SubscriptionRequestStatus, TypesSearchScope, UserProfileStatus, UserProfileType } from "./enums";
2
+ import { ActionParameters, AggregationListItem, ColumnFilterConfiguration, CustomParameter, DeploymentProperties, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, EnvironmentParameter, FailureCause, FormOutput, GrantedEntity, ProjectDeletionError, ProvisioningProperties, ResourceTag, ResourceTagParameter, RowFilterExpression, SubscribedAsset, SubscribedListing, SubscribedPrincipal, SubscriptionTargetForm, UserProfileDetails } from "./models_0";
3
+ import { Filter, SearchInItem, SearchSort } from "./models_1";
2817
4
  /**
2818
5
  * @public
2819
6
  */
@@ -3379,6 +566,36 @@ export interface UpdateProjectProfileOutput {
3379
566
  */
3380
567
  domainUnitId?: string | undefined;
3381
568
  }
569
+ /**
570
+ * @public
571
+ */
572
+ export interface UpdateRootDomainUnitOwnerInput {
573
+ /**
574
+ * <p>The ID of the domain where the root domain unit owner is to be updated.</p>
575
+ * @public
576
+ */
577
+ domainIdentifier: string | undefined;
578
+ /**
579
+ * <p>The current owner of the root domain unit.</p>
580
+ * @public
581
+ */
582
+ currentOwner: string | undefined;
583
+ /**
584
+ * <p>The new owner of the root domain unit.</p>
585
+ * @public
586
+ */
587
+ newOwner: string | undefined;
588
+ /**
589
+ * <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>
590
+ * @public
591
+ */
592
+ clientToken?: string | undefined;
593
+ }
594
+ /**
595
+ * @public
596
+ */
597
+ export interface UpdateRootDomainUnitOwnerOutput {
598
+ }
3382
599
  /**
3383
600
  * @public
3384
601
  */