@aws-sdk/client-datazone 3.1154.0 → 3.1155.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 (60) hide show
  1. package/README.md +35 -0
  2. package/dist-cjs/index.js +205 -58
  3. package/dist-es/DataZone.js +12 -0
  4. package/dist-es/commands/CreateDesignationCommand.js +4 -0
  5. package/dist-es/commands/DeleteDesignationCommand.js +4 -0
  6. package/dist-es/commands/GetDesignationCommand.js +4 -0
  7. package/dist-es/commands/ListDesignationsCommand.js +4 -0
  8. package/dist-es/commands/UpdateDesignationCommand.js +4 -0
  9. package/dist-es/commands/index.js +5 -0
  10. package/dist-es/models/enums.js +6 -0
  11. package/dist-es/pagination/ListDesignationsPaginator.js +4 -0
  12. package/dist-es/pagination/index.js +1 -0
  13. package/dist-es/schemas/schemas_0.js +152 -57
  14. package/dist-types/DataZone.d.ts +42 -0
  15. package/dist-types/DataZoneClient.d.ts +9 -3
  16. package/dist-types/commands/AddPolicyGrantCommand.d.ts +2 -1
  17. package/dist-types/commands/CreateDesignationCommand.d.ts +109 -0
  18. package/dist-types/commands/CreateProjectCommand.d.ts +2 -1
  19. package/dist-types/commands/CreateProjectMembershipCommand.d.ts +2 -1
  20. package/dist-types/commands/CreateProjectProfileCommand.d.ts +2 -1
  21. package/dist-types/commands/DeleteDesignationCommand.d.ts +92 -0
  22. package/dist-types/commands/GetDesignationCommand.d.ts +99 -0
  23. package/dist-types/commands/GetNotebookCommand.d.ts +1 -1
  24. package/dist-types/commands/GetNotebookExportCommand.d.ts +1 -2
  25. package/dist-types/commands/ListDesignationsCommand.d.ts +105 -0
  26. package/dist-types/commands/ListNotebooksCommand.d.ts +1 -1
  27. package/dist-types/commands/ListPolicyGrantsCommand.d.ts +2 -1
  28. package/dist-types/commands/ListProjectMembershipsCommand.d.ts +2 -1
  29. package/dist-types/commands/RemovePolicyGrantCommand.d.ts +2 -1
  30. package/dist-types/commands/UpdateDesignationCommand.d.ts +106 -0
  31. package/dist-types/commands/UpdateNotebookCommand.d.ts +1 -1
  32. package/dist-types/commands/index.d.ts +5 -0
  33. package/dist-types/models/enums.d.ts +20 -0
  34. package/dist-types/models/models_0.d.ts +107 -82
  35. package/dist-types/models/models_1.d.ts +269 -444
  36. package/dist-types/models/models_2.d.ts +541 -4
  37. package/dist-types/pagination/ListDesignationsPaginator.d.ts +7 -0
  38. package/dist-types/pagination/index.d.ts +1 -0
  39. package/dist-types/schemas/schemas_0.d.ts +16 -0
  40. package/dist-types/ts3.4/DataZone.d.ts +92 -0
  41. package/dist-types/ts3.4/DataZoneClient.d.ts +30 -0
  42. package/dist-types/ts3.4/commands/CreateDesignationCommand.d.ts +38 -0
  43. package/dist-types/ts3.4/commands/CreateProjectProfileCommand.d.ts +2 -1
  44. package/dist-types/ts3.4/commands/DeleteDesignationCommand.d.ts +38 -0
  45. package/dist-types/ts3.4/commands/GetDesignationCommand.d.ts +38 -0
  46. package/dist-types/ts3.4/commands/GetNotebookCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/GetNotebookExportCommand.d.ts +1 -2
  48. package/dist-types/ts3.4/commands/ListDesignationsCommand.d.ts +38 -0
  49. package/dist-types/ts3.4/commands/ListNotebooksCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/UpdateDesignationCommand.d.ts +38 -0
  51. package/dist-types/ts3.4/commands/UpdateNotebookCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  53. package/dist-types/ts3.4/models/enums.d.ts +7 -0
  54. package/dist-types/ts3.4/models/models_0.d.ts +23 -18
  55. package/dist-types/ts3.4/models/models_1.d.ts +61 -104
  56. package/dist-types/ts3.4/models/models_2.d.ts +120 -1
  57. package/dist-types/ts3.4/pagination/ListDesignationsPaginator.d.ts +11 -0
  58. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  59. package/dist-types/ts3.4/schemas/schemas_0.d.ts +16 -0
  60. package/package.json +5 -5
@@ -1,6 +1,448 @@
1
- import type { BlueprintCategory, ConnectionScope, ConnectionType, DataZoneEntityType, EnvironmentStatus, FileFormat, FilterOperator, FilterStatus, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GraphEntityType, GroupProfileStatus, GroupSearchType, InventorySearchScope, ManagedPolicyType, NetworkAccessType, NotebookExportStatus, NotebookRunStatus, NotebookStatus, NotebookType, NotifyOnState, ProjectStatus, RejectRuleBehavior, RelationDirection, RelationType, ResolutionStrategy, RuleAction, RuleTargetType, RuleType, SearchOutputAdditionalAttribute, SortOrder, Status, SubscriptionGrantCreationMode, SubscriptionGrantOverallStatus, SubscriptionGrantStatus, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TimeSeriesEntityType, TriggerSourceType, TypesSearchScope, UserProfileStatus, UserProfileType, UserSearchType } from "./enums";
2
- import type { AccountSource, ActionParameters, AdditionalAttributes, AggregationListItem, AggregationOutput, AssetItem, AssetListingItem, AssetTypeItem, AwsLocation, CellInformation, ColumnFilterConfiguration, ComputeConfig, ConfigurableEnvironmentAction, Configuration, ConnectionPropertiesOutput, ConnectionPropertiesPatch, CustomParameter, Deployment, DeploymentProperties, EnvironmentConfig, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, EnvironmentParameter, FormEntryOutput, FormOutput, GitMetadata, MatchRationaleItem, Model, OwnerProperties, PhysicalEndpoint, PolicyGrantPrincipal, ProjectDeletionError, ProvisioningProperties, Resource, ResourceTag, ResourceTagParameter, RowFilterExpression, SubscribedListing, SubscribedPrincipal, TermRelations, UserProfileDetails } from "./models_0";
3
- import type { DataProductListingItem, DataProductResultItem, EncryptionConfiguration, FailureCause, GrantedEntity, Import, NotebookExportError, RuleDetail, RuleScope, RuleTarget, SubscribedAsset, SubscriptionTargetForm, TimeSeriesDataPointFormOutput } from "./models_1";
1
+ import type { BlueprintCategory, ConnectionScope, ConnectionType, DataZoneEntityType, DesignationType, EnvironmentStatus, FileFormat, FilterOperator, FilterStatus, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GraphEntityType, GroupProfileStatus, GroupSearchType, InventorySearchScope, ManagedPolicyType, NetworkAccessType, NotebookExportStatus, NotebookRunStatus, NotebookStatus, NotebookType, NotifyOnState, ProjectStatus, RejectRuleBehavior, RelationDirection, RelationType, ResolutionStrategy, RuleAction, RuleTargetType, RuleType, SearchOutputAdditionalAttribute, SortKey, SortOrder, Status, SubscriptionGrantCreationMode, SubscriptionGrantOverallStatus, SubscriptionGrantStatus, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TimeSeriesEntityType, TriggerSourceType, TypesSearchScope, UserProfileStatus, UserProfileType, UserSearchType } from "./enums";
2
+ import type { AccountSource, ActionParameters, AdditionalAttributes, AggregationListItem, AggregationOutput, AssetItem, AssetListingItem, AssetTypeItem, AwsLocation, CellInformation, ColumnFilterConfiguration, ComputeConfig, ConfigurableEnvironmentAction, Configuration, ConnectionPropertiesOutput, ConnectionPropertiesPatch, CustomParameter, Deployment, DeploymentProperties, EnvironmentConfig, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, EnvironmentParameter, FormEntryOutput, FormOutput, GitMetadata, MatchRationaleItem, Model, NotebookError, OwnerProperties, PhysicalEndpoint, PolicyGrantPrincipal, ProjectDeletionError, ProvisioningProperties, Resource, ResourceTag, ResourceTagParameter, RowFilterExpression, SubscribedListing, SubscribedPrincipal, TermRelations, UserProfileDetails } from "./models_0";
3
+ import type { DataProductListingItem, DataProductResultItem, EncryptionConfiguration, FailureCause, GrantedEntity, Import, RuleDetail, RuleScope, RuleTarget, SubscribedAsset, SubscriptionTargetForm, TimeSeriesDataPointFormOutput } from "./models_1";
4
+ /**
5
+ * @public
6
+ */
7
+ export interface GetNotebookInput {
8
+ /**
9
+ * <p>The identifier of the Amazon SageMaker Unified Studio domain in which the notebook exists.</p>
10
+ * @public
11
+ */
12
+ domainIdentifier: string | undefined;
13
+ /**
14
+ * <p>The identifier of the notebook.</p>
15
+ * @public
16
+ */
17
+ identifier: string | undefined;
18
+ }
19
+ /**
20
+ * @public
21
+ */
22
+ export interface GetNotebookOutput {
23
+ /**
24
+ * <p>The identifier of the notebook.</p>
25
+ * @public
26
+ */
27
+ id: string | undefined;
28
+ /**
29
+ * <p>The name of the notebook.</p>
30
+ * @public
31
+ */
32
+ name: string | undefined;
33
+ /**
34
+ * <p>The identifier of the project that owns the notebook.</p>
35
+ * @public
36
+ */
37
+ owningProjectId: string | undefined;
38
+ /**
39
+ * <p>The identifier of the Amazon SageMaker Unified Studio domain.</p>
40
+ * @public
41
+ */
42
+ domainId: string | undefined;
43
+ /**
44
+ * <p>The ordered list of cells in the notebook.</p>
45
+ * @public
46
+ */
47
+ cellOrder: CellInformation[] | undefined;
48
+ /**
49
+ * <p>The status of the notebook.</p>
50
+ * @public
51
+ */
52
+ status: NotebookStatus | undefined;
53
+ /**
54
+ * <p>The type of the notebook.</p>
55
+ * @public
56
+ */
57
+ type?: NotebookType | undefined;
58
+ /**
59
+ * <p>The description of the notebook.</p>
60
+ * @public
61
+ */
62
+ description?: string | undefined;
63
+ /**
64
+ * <p>The timestamp of when the notebook was created.</p>
65
+ * @public
66
+ */
67
+ createdAt?: Date | undefined;
68
+ /**
69
+ * <p>The identifier of the user who created the notebook.</p>
70
+ * @public
71
+ */
72
+ createdBy?: string | undefined;
73
+ /**
74
+ * <p>The timestamp of when the notebook was last updated.</p>
75
+ * @public
76
+ */
77
+ updatedAt?: Date | undefined;
78
+ /**
79
+ * <p>The identifier of the user who last updated the notebook.</p>
80
+ * @public
81
+ */
82
+ updatedBy?: string | undefined;
83
+ /**
84
+ * <p>The identifier of the user who locked the notebook.</p>
85
+ * @public
86
+ */
87
+ lockedBy?: string | undefined;
88
+ /**
89
+ * <p>The timestamp of when the notebook was locked.</p>
90
+ * @public
91
+ */
92
+ lockedAt?: Date | undefined;
93
+ /**
94
+ * <p>The timestamp of when the notebook lock expires.</p>
95
+ * @public
96
+ */
97
+ lockExpiresAt?: Date | undefined;
98
+ /**
99
+ * <p>The identifier of the compute associated with the notebook.</p>
100
+ * @public
101
+ */
102
+ computeId?: string | undefined;
103
+ /**
104
+ * <p>The metadata of the notebook.</p>
105
+ * @public
106
+ */
107
+ metadata?: Record<string, string> | undefined;
108
+ /**
109
+ * <p>The sensitive parameters of the notebook.</p>
110
+ * @public
111
+ */
112
+ parameters?: Record<string, string> | undefined;
113
+ /**
114
+ * <p>The environment configuration of the notebook.</p>
115
+ * @public
116
+ */
117
+ environmentConfiguration?: EnvironmentConfig | undefined;
118
+ /**
119
+ * <p>The error details if the notebook is in a failed state.</p>
120
+ * @public
121
+ */
122
+ error?: NotebookError | undefined;
123
+ /**
124
+ * <p>The Git metadata associated with the notebook.</p>
125
+ * @public
126
+ */
127
+ gitMetadata?: GitMetadata | undefined;
128
+ }
129
+ /**
130
+ * @public
131
+ */
132
+ export interface ListNotebooksInput {
133
+ /**
134
+ * <p>The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.</p>
135
+ * @public
136
+ */
137
+ domainIdentifier: string | undefined;
138
+ /**
139
+ * <p>The identifier of the project that owns the notebooks.</p>
140
+ * @public
141
+ */
142
+ owningProjectIdentifier: string | undefined;
143
+ /**
144
+ * <p>The maximum number of notebooks to return in a single call. When the number of notebooks exceeds the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value.</p>
145
+ * @public
146
+ */
147
+ maxResults?: number | undefined;
148
+ /**
149
+ * <p>The sort order for the results.</p>
150
+ * @public
151
+ */
152
+ sortOrder?: SortOrder | undefined;
153
+ /**
154
+ * <p>The field to sort the results by.</p>
155
+ * @public
156
+ */
157
+ sortBy?: SortKey | undefined;
158
+ /**
159
+ * <p>The status to filter notebooks by.</p>
160
+ * @public
161
+ */
162
+ status?: NotebookStatus | undefined;
163
+ /**
164
+ * <p>The type to filter notebooks by.</p>
165
+ * @public
166
+ */
167
+ type?: NotebookType | undefined;
168
+ /**
169
+ * <p>When the number of notebooks 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 notebooks, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebooks</code> to list the next set of notebooks.</p>
170
+ * @public
171
+ */
172
+ nextToken?: string | undefined;
173
+ }
174
+ /**
175
+ * <p>The summary of a notebook in Amazon SageMaker Unified Studio.</p>
176
+ * @public
177
+ */
178
+ export interface NotebookSummary {
179
+ /**
180
+ * <p>The identifier of the notebook.</p>
181
+ * @public
182
+ */
183
+ id: string | undefined;
184
+ /**
185
+ * <p>The name of the notebook.</p>
186
+ * @public
187
+ */
188
+ name: string | undefined;
189
+ /**
190
+ * <p>The identifier of the project that owns the notebook.</p>
191
+ * @public
192
+ */
193
+ owningProjectId: string | undefined;
194
+ /**
195
+ * <p>The identifier of the Amazon SageMaker Unified Studio domain.</p>
196
+ * @public
197
+ */
198
+ domainId: string | undefined;
199
+ /**
200
+ * <p>The status of the notebook.</p>
201
+ * @public
202
+ */
203
+ status: NotebookStatus | undefined;
204
+ /**
205
+ * <p>The type of the notebook.</p>
206
+ * @public
207
+ */
208
+ type?: NotebookType | undefined;
209
+ /**
210
+ * <p>The description of the notebook.</p>
211
+ * @public
212
+ */
213
+ description?: string | undefined;
214
+ /**
215
+ * <p>The timestamp of when the notebook was created.</p>
216
+ * @public
217
+ */
218
+ createdAt?: Date | undefined;
219
+ /**
220
+ * <p>The identifier of the user who created the notebook.</p>
221
+ * @public
222
+ */
223
+ createdBy?: string | undefined;
224
+ /**
225
+ * <p>The timestamp of when the notebook was last updated.</p>
226
+ * @public
227
+ */
228
+ updatedAt?: Date | undefined;
229
+ /**
230
+ * <p>The identifier of the user who last updated the notebook.</p>
231
+ * @public
232
+ */
233
+ updatedBy?: string | undefined;
234
+ }
235
+ /**
236
+ * @public
237
+ */
238
+ export interface ListNotebooksOutput {
239
+ /**
240
+ * <p>The results of the <code>ListNotebooks</code> action.</p>
241
+ * @public
242
+ */
243
+ items?: NotebookSummary[] | undefined;
244
+ /**
245
+ * <p>When the number of notebooks 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 notebooks, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebooks</code> to list the next set of notebooks.</p>
246
+ * @public
247
+ */
248
+ nextToken?: string | undefined;
249
+ }
250
+ /**
251
+ * @public
252
+ */
253
+ export interface UpdateNotebookInput {
254
+ /**
255
+ * <p>The identifier of the Amazon SageMaker Unified Studio domain in which the notebook exists.</p>
256
+ * @public
257
+ */
258
+ domainIdentifier: string | undefined;
259
+ /**
260
+ * <p>The identifier of the notebook to update.</p>
261
+ * @public
262
+ */
263
+ identifier: string | undefined;
264
+ /**
265
+ * <p>The updated description of the notebook.</p>
266
+ * @public
267
+ */
268
+ description?: string | undefined;
269
+ /**
270
+ * <p>The updated status of the notebook.</p>
271
+ * @public
272
+ */
273
+ status?: NotebookStatus | undefined;
274
+ /**
275
+ * <p>The updated name of the notebook.</p>
276
+ * @public
277
+ */
278
+ name?: string | undefined;
279
+ /**
280
+ * <p>The updated ordered list of cells in the notebook.</p>
281
+ * @public
282
+ */
283
+ cellOrder?: CellInformation[] | undefined;
284
+ /**
285
+ * <p>The updated type of the notebook.</p>
286
+ * @public
287
+ */
288
+ type?: NotebookType | undefined;
289
+ /**
290
+ * <p>The updated metadata for the notebook, specified as key-value pairs.</p>
291
+ * @public
292
+ */
293
+ metadata?: Record<string, string> | undefined;
294
+ /**
295
+ * <p>The updated sensitive parameters for the notebook, specified as key-value pairs.</p>
296
+ * @public
297
+ */
298
+ parameters?: Record<string, string> | undefined;
299
+ /**
300
+ * <p>The updated environment configuration for the notebook.</p>
301
+ * @public
302
+ */
303
+ environmentConfiguration?: EnvironmentConfig | undefined;
304
+ /**
305
+ * <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>
306
+ * @public
307
+ */
308
+ clientToken?: string | undefined;
309
+ }
310
+ /**
311
+ * @public
312
+ */
313
+ export interface UpdateNotebookOutput {
314
+ /**
315
+ * <p>The identifier of the notebook.</p>
316
+ * @public
317
+ */
318
+ id: string | undefined;
319
+ /**
320
+ * <p>The name of the notebook.</p>
321
+ * @public
322
+ */
323
+ name: string | undefined;
324
+ /**
325
+ * <p>The identifier of the project that owns the notebook.</p>
326
+ * @public
327
+ */
328
+ owningProjectId: string | undefined;
329
+ /**
330
+ * <p>The identifier of the Amazon SageMaker Unified Studio domain.</p>
331
+ * @public
332
+ */
333
+ domainId: string | undefined;
334
+ /**
335
+ * <p>The ordered list of cells in the notebook.</p>
336
+ * @public
337
+ */
338
+ cellOrder: CellInformation[] | undefined;
339
+ /**
340
+ * <p>The status of the notebook.</p>
341
+ * @public
342
+ */
343
+ status: NotebookStatus | undefined;
344
+ /**
345
+ * <p>The type of the notebook.</p>
346
+ * @public
347
+ */
348
+ type?: NotebookType | undefined;
349
+ /**
350
+ * <p>The description of the notebook.</p>
351
+ * @public
352
+ */
353
+ description?: string | undefined;
354
+ /**
355
+ * <p>The timestamp of when the notebook was created.</p>
356
+ * @public
357
+ */
358
+ createdAt?: Date | undefined;
359
+ /**
360
+ * <p>The identifier of the user who created the notebook.</p>
361
+ * @public
362
+ */
363
+ createdBy?: string | undefined;
364
+ /**
365
+ * <p>The timestamp of when the notebook was last updated.</p>
366
+ * @public
367
+ */
368
+ updatedAt?: Date | undefined;
369
+ /**
370
+ * <p>The identifier of the user who last updated the notebook.</p>
371
+ * @public
372
+ */
373
+ updatedBy?: string | undefined;
374
+ /**
375
+ * <p>The identifier of the user who locked the notebook.</p>
376
+ * @public
377
+ */
378
+ lockedBy?: string | undefined;
379
+ /**
380
+ * <p>The timestamp of when the notebook was locked.</p>
381
+ * @public
382
+ */
383
+ lockedAt?: Date | undefined;
384
+ /**
385
+ * <p>The timestamp of when the notebook lock expires.</p>
386
+ * @public
387
+ */
388
+ lockExpiresAt?: Date | undefined;
389
+ /**
390
+ * <p>The identifier of the compute associated with the notebook.</p>
391
+ * @public
392
+ */
393
+ computeId?: string | undefined;
394
+ /**
395
+ * <p>The metadata of the notebook.</p>
396
+ * @public
397
+ */
398
+ metadata?: Record<string, string> | undefined;
399
+ /**
400
+ * <p>The sensitive parameters of the notebook.</p>
401
+ * @public
402
+ */
403
+ parameters?: Record<string, string> | undefined;
404
+ /**
405
+ * <p>The environment configuration of the notebook.</p>
406
+ * @public
407
+ */
408
+ environmentConfiguration?: EnvironmentConfig | undefined;
409
+ /**
410
+ * <p>The error details if the notebook is in a failed state.</p>
411
+ * @public
412
+ */
413
+ error?: NotebookError | undefined;
414
+ /**
415
+ * <p>The Git metadata associated with the notebook.</p>
416
+ * @public
417
+ */
418
+ gitMetadata?: GitMetadata | undefined;
419
+ }
420
+ /**
421
+ * @public
422
+ */
423
+ export interface GetNotebookExportInput {
424
+ /**
425
+ * <p>The identifier of the Amazon SageMaker Unified Studio domain in which the notebook export exists.</p>
426
+ * @public
427
+ */
428
+ domainIdentifier: string | undefined;
429
+ /**
430
+ * <p>The identifier of the notebook export.</p>
431
+ * @public
432
+ */
433
+ identifier: string | undefined;
434
+ }
435
+ /**
436
+ * <p>The error details of a failed notebook export in Amazon SageMaker Unified Studio.</p>
437
+ * @public
438
+ */
439
+ export interface NotebookExportError {
440
+ /**
441
+ * <p>The error message. The maximum length is 256 characters.</p>
442
+ * @public
443
+ */
444
+ message: string | undefined;
445
+ }
4
446
  /**
5
447
  * <p>The Amazon Simple Storage Service destination for a notebook export in Amazon SageMaker Unified Studio.</p>
6
448
  * @public
@@ -238,7 +680,7 @@ export interface NetworkConfig {
238
680
  */
239
681
  export interface NotificationConfig {
240
682
  /**
241
- * Notebook run states that trigger notifications. Ordering is not significant.
683
+ * <p>The notebook run states that trigger notifications. You can specify up to 7 states, and the ordering of the states is not significant.</p>
242
684
  * @public
243
685
  */
244
686
  notifyOn: NotifyOnState[] | undefined;
@@ -3003,6 +3445,101 @@ export interface UpdateConnectionOutput {
3003
3445
  */
3004
3446
  scope?: ConnectionScope | undefined;
3005
3447
  }
3448
+ /**
3449
+ * @public
3450
+ */
3451
+ export interface UpdateDesignationInput {
3452
+ /**
3453
+ * <p>The identifier of the Amazon DataZone domain that contains the designation to update.</p>
3454
+ * @public
3455
+ */
3456
+ domainIdentifier: string | undefined;
3457
+ /**
3458
+ * <p>The unique ID of the designation to update.</p>
3459
+ * @public
3460
+ */
3461
+ identifier: string | undefined;
3462
+ /**
3463
+ * <p>The updated name of the designation. The name must be unique within the domain.</p>
3464
+ * @public
3465
+ */
3466
+ name?: string | undefined;
3467
+ /**
3468
+ * <p>The updated human-readable description of the designation and its intended use.</p>
3469
+ * @public
3470
+ */
3471
+ description?: string | undefined;
3472
+ /**
3473
+ * The updated Cedar permit policy.
3474
+ * @public
3475
+ */
3476
+ policy?: string | undefined;
3477
+ /**
3478
+ * Whether deletion protection is enabled for this designation. Omit to keep the existing value.
3479
+ * @public
3480
+ */
3481
+ deletionProtection?: boolean | undefined;
3482
+ }
3483
+ /**
3484
+ * A designation defines a named role with a Cedar permit policy that controls
3485
+ * what actions members holding this designation can perform within a project.
3486
+ * @public
3487
+ */
3488
+ export interface UpdateDesignationOutput {
3489
+ /**
3490
+ * <p>The identifier of the Amazon DataZone domain that contains the designation.</p>
3491
+ * @public
3492
+ */
3493
+ domainId: string | undefined;
3494
+ /**
3495
+ * <p>The unique ID of the designation.</p>
3496
+ * @public
3497
+ */
3498
+ id: string | undefined;
3499
+ /**
3500
+ * <p>The name of the designation. The name is unique within the domain.</p>
3501
+ * @public
3502
+ */
3503
+ name: string | undefined;
3504
+ /**
3505
+ * <p>A human-readable description of the designation and its intended use.</p>
3506
+ * @public
3507
+ */
3508
+ description?: string | undefined;
3509
+ /**
3510
+ * The classification of this designation. MANAGED designations are
3511
+ * system-defined and cannot be modified or deleted.
3512
+ * @public
3513
+ */
3514
+ designationType: DesignationType | undefined;
3515
+ /**
3516
+ * The Cedar permit policy that governs what actions holders of this
3517
+ * designation are allowed to perform.
3518
+ * @public
3519
+ */
3520
+ policy: string | undefined;
3521
+ /**
3522
+ * Whether deletion protection is enabled for this designation. When true,
3523
+ * DeleteDesignation is rejected until protection is disabled via UpdateDesignation.
3524
+ * @public
3525
+ */
3526
+ deletionProtection: boolean | undefined;
3527
+ /**
3528
+ * <p>The identifier of the Amazon DataZone user who created the designation.</p>
3529
+ * @public
3530
+ */
3531
+ createdBy: string | undefined;
3532
+ /**
3533
+ * <p>The date and time when the designation was created.</p>
3534
+ * @public
3535
+ */
3536
+ createdAt?: Date | undefined;
3537
+ /**
3538
+ * <p>The date and time when the designation was last updated.</p>
3539
+ * @public
3540
+ */
3541
+ lastUpdatedAt?: Date | undefined;
3542
+ }
3006
3543
  /**
3007
3544
  * @public
3008
3545
  */
@@ -0,0 +1,7 @@
1
+ import type { Paginator } from "@smithy/types";
2
+ import { ListDesignationsCommandInput, ListDesignationsCommandOutput } from "../commands/ListDesignationsCommand";
3
+ import type { DataZonePaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare const paginateListDesignations: (config: DataZonePaginationConfiguration, input: ListDesignationsCommandInput, ...rest: any[]) => Paginator<ListDesignationsCommandOutput>;
@@ -8,6 +8,7 @@ export * from "./ListDataProductRevisionsPaginator";
8
8
  export * from "./ListDataSourceRunActivitiesPaginator";
9
9
  export * from "./ListDataSourceRunsPaginator";
10
10
  export * from "./ListDataSourcesPaginator";
11
+ export * from "./ListDesignationsPaginator";
11
12
  export * from "./ListDomainsPaginator";
12
13
  export * from "./ListDomainUnitsForParentPaginator";
13
14
  export * from "./ListEntityOwnersPaginator";
@@ -109,6 +109,8 @@ export declare var CreateDataProductRevisionInput$: StaticStructureSchema;
109
109
  export declare var CreateDataProductRevisionOutput$: StaticStructureSchema;
110
110
  export declare var CreateDataSourceInput$: StaticStructureSchema;
111
111
  export declare var CreateDataSourceOutput$: StaticStructureSchema;
112
+ export declare var CreateDesignationInput$: StaticStructureSchema;
113
+ export declare var CreateDesignationOutput$: StaticStructureSchema;
112
114
  export declare var CreateDomainInput$: StaticStructureSchema;
113
115
  export declare var CreateDomainOutput$: StaticStructureSchema;
114
116
  export declare var CreateDomainUnitInput$: StaticStructureSchema;
@@ -184,6 +186,8 @@ export declare var DeleteDataProductInput$: StaticStructureSchema;
184
186
  export declare var DeleteDataProductOutput$: StaticStructureSchema;
185
187
  export declare var DeleteDataSourceInput$: StaticStructureSchema;
186
188
  export declare var DeleteDataSourceOutput$: StaticStructureSchema;
189
+ export declare var DeleteDesignationInput$: StaticStructureSchema;
190
+ export declare var DeleteDesignationOutput$: StaticStructureSchema;
187
191
  export declare var DeleteDomainInput$: StaticStructureSchema;
188
192
  export declare var DeleteDomainOutput$: StaticStructureSchema;
189
193
  export declare var DeleteDomainUnitInput$: StaticStructureSchema;
@@ -223,6 +227,7 @@ export declare var DeleteTimeSeriesDataPointsInput$: StaticStructureSchema;
223
227
  export declare var DeleteTimeSeriesDataPointsOutput$: StaticStructureSchema;
224
228
  export declare var Deployment$: StaticStructureSchema;
225
229
  export declare var DeploymentProperties$: StaticStructureSchema;
230
+ export declare var DesignationSummary$: StaticStructureSchema;
226
231
  export declare var DetailedGlossaryTerm$: StaticStructureSchema;
227
232
  export declare var DisassociateEnvironmentRoleInput$: StaticStructureSchema;
228
233
  export declare var DisassociateEnvironmentRoleOutput$: StaticStructureSchema;
@@ -279,6 +284,8 @@ export declare var GetDataSourceInput$: StaticStructureSchema;
279
284
  export declare var GetDataSourceOutput$: StaticStructureSchema;
280
285
  export declare var GetDataSourceRunInput$: StaticStructureSchema;
281
286
  export declare var GetDataSourceRunOutput$: StaticStructureSchema;
287
+ export declare var GetDesignationInput$: StaticStructureSchema;
288
+ export declare var GetDesignationOutput$: StaticStructureSchema;
282
289
  export declare var GetDomainInput$: StaticStructureSchema;
283
290
  export declare var GetDomainOutput$: StaticStructureSchema;
284
291
  export declare var GetDomainUnitInput$: StaticStructureSchema;
@@ -411,6 +418,8 @@ export declare var ListDataSourceRunsInput$: StaticStructureSchema;
411
418
  export declare var ListDataSourceRunsOutput$: StaticStructureSchema;
412
419
  export declare var ListDataSourcesInput$: StaticStructureSchema;
413
420
  export declare var ListDataSourcesOutput$: StaticStructureSchema;
421
+ export declare var ListDesignationsInput$: StaticStructureSchema;
422
+ export declare var ListDesignationsOutput$: StaticStructureSchema;
414
423
  export declare var ListDomainsInput$: StaticStructureSchema;
415
424
  export declare var ListDomainsOutput$: StaticStructureSchema;
416
425
  export declare var ListDomainUnitsForParentInput$: StaticStructureSchema;
@@ -644,6 +653,8 @@ export declare var UpdateConnectionInput$: StaticStructureSchema;
644
653
  export declare var UpdateConnectionOutput$: StaticStructureSchema;
645
654
  export declare var UpdateDataSourceInput$: StaticStructureSchema;
646
655
  export declare var UpdateDataSourceOutput$: StaticStructureSchema;
656
+ export declare var UpdateDesignationInput$: StaticStructureSchema;
657
+ export declare var UpdateDesignationOutput$: StaticStructureSchema;
647
658
  export declare var UpdateDomainInput$: StaticStructureSchema;
648
659
  export declare var UpdateDomainOutput$: StaticStructureSchema;
649
660
  export declare var UpdateDomainUnitInput$: StaticStructureSchema;
@@ -761,6 +772,7 @@ export declare var CreateConnection$: StaticOperationSchema;
761
772
  export declare var CreateDataProduct$: StaticOperationSchema;
762
773
  export declare var CreateDataProductRevision$: StaticOperationSchema;
763
774
  export declare var CreateDataSource$: StaticOperationSchema;
775
+ export declare var CreateDesignation$: StaticOperationSchema;
764
776
  export declare var CreateDomain$: StaticOperationSchema;
765
777
  export declare var CreateDomainUnit$: StaticOperationSchema;
766
778
  export declare var CreateEnvironment$: StaticOperationSchema;
@@ -789,6 +801,7 @@ export declare var DeleteConnection$: StaticOperationSchema;
789
801
  export declare var DeleteDataExportConfiguration$: StaticOperationSchema;
790
802
  export declare var DeleteDataProduct$: StaticOperationSchema;
791
803
  export declare var DeleteDataSource$: StaticOperationSchema;
804
+ export declare var DeleteDesignation$: StaticOperationSchema;
792
805
  export declare var DeleteDomain$: StaticOperationSchema;
793
806
  export declare var DeleteDomainUnit$: StaticOperationSchema;
794
807
  export declare var DeleteEnvironment$: StaticOperationSchema;
@@ -821,6 +834,7 @@ export declare var GetDataExportConfiguration$: StaticOperationSchema;
821
834
  export declare var GetDataProduct$: StaticOperationSchema;
822
835
  export declare var GetDataSource$: StaticOperationSchema;
823
836
  export declare var GetDataSourceRun$: StaticOperationSchema;
837
+ export declare var GetDesignation$: StaticOperationSchema;
824
838
  export declare var GetDomain$: StaticOperationSchema;
825
839
  export declare var GetDomainUnit$: StaticOperationSchema;
826
840
  export declare var GetEnvironment$: StaticOperationSchema;
@@ -860,6 +874,7 @@ export declare var ListDataProductRevisions$: StaticOperationSchema;
860
874
  export declare var ListDataSourceRunActivities$: StaticOperationSchema;
861
875
  export declare var ListDataSourceRuns$: StaticOperationSchema;
862
876
  export declare var ListDataSources$: StaticOperationSchema;
877
+ export declare var ListDesignations$: StaticOperationSchema;
863
878
  export declare var ListDomains$: StaticOperationSchema;
864
879
  export declare var ListDomainUnitsForParent$: StaticOperationSchema;
865
880
  export declare var ListEntityOwners$: StaticOperationSchema;
@@ -914,6 +929,7 @@ export declare var UpdateAccountPool$: StaticOperationSchema;
914
929
  export declare var UpdateAssetFilter$: StaticOperationSchema;
915
930
  export declare var UpdateConnection$: StaticOperationSchema;
916
931
  export declare var UpdateDataSource$: StaticOperationSchema;
932
+ export declare var UpdateDesignation$: StaticOperationSchema;
917
933
  export declare var UpdateDomain$: StaticOperationSchema;
918
934
  export declare var UpdateDomainUnit$: StaticOperationSchema;
919
935
  export declare var UpdateEnvironment$: StaticOperationSchema;