@aws-sdk/client-datazone 3.1154.0 → 3.1156.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,5 +1,86 @@
1
- import type { BlueprintCategory, ConfigurationStatus, ConnectionScope, ConnectionType, DataAssetActivityStatus, DataProductStatus, DataSourceRunStatus, DataSourceRunType, DataSourceStatus, DataZoneEntityType, DomainStatus, DomainVersion, EdgeDirection, EnableSetting, EnvironmentStatus, FilterStatus, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GovernedEntityType, GroupProfileStatus, JobRunMode, JobRunStatus, JobType, LineageEventProcessingStatus, LineageImportStatus, ListingStatus, ManagedPolicyType, MetadataGenerationRunStatus, MetadataGenerationRunType, MetadataGenerationTargetType, NotebookStatus, NotebookType, NotificationResourceType, NotificationRole, NotificationType, OpenLineageRunState, ProjectStatus, ResolutionStrategy, RuleAction, RuleScopeSelectionMode, RuleTargetType, RuleType, SelfGrantStatus, SortFieldAccountPool, SortFieldConnection, SortFieldProject, SortKey, SortOrder, Status, SubscriptionGrantCreationMode, SubscriptionGrantOverallStatus, SubscriptionGrantStatus, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TaskStatus, TimeSeriesEntityType, UserDesignation, UserProfileStatus, UserProfileType, UserType } from "./enums";
2
- import type { AcceptedAssetScope, AccountInfo, AccountPoolSummary, AccountSource, ActionParameters, AssetFilterSummary, AssetListing, AssetPermission, AssetRevision, AssetScope, AssetTargetNameMap, AssetTypesForRule, CellInformation, ConfigurableEnvironmentAction, Configuration, ConnectionCredentials, ConnectionPropertiesOutput, ConnectionSummary, CustomParameter, DataProductItem, DataSourceConfigurationInput, DataSourceConfigurationOutput, DataSourceErrorMessage, Deployment, DeploymentProperties, DetailedGlossaryTerm, DomainUnitOwnerProperties, EnvironmentConfig, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, FormInput, FormOutput, GitMetadata, GlossaryTermEnforcementDetail, MatchRationaleItem, Member, Model, NotebookError, Permissions, PhysicalEndpoint, PolicyGrantDetail, PolicyGrantPrincipal, ProjectDeletionError, ProvisioningProperties, RecommendationConfiguration, Resource, ResourceTag, ResourceTagParameter, ScheduleConfiguration, SingleSignOn, SubscribedListing, SubscribedPrincipal, TermRelations, TimeSeriesDataPointSummaryFormOutput, UserProfileDetails } from "./models_0";
1
+ import type { BlueprintCategory, ConfigurationStatus, ConnectionScope, ConnectionType, DataAssetActivityStatus, DataProductStatus, DataSourceRunStatus, DataSourceRunType, DataSourceStatus, DataZoneEntityType, DesignationType, DomainStatus, DomainVersion, EdgeDirection, EnableSetting, EnvironmentStatus, FilterStatus, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GovernedEntityType, GroupProfileStatus, JobRunMode, JobRunStatus, JobType, LineageEventProcessingStatus, LineageImportStatus, ListingStatus, ManagedPolicyType, MetadataGenerationRunStatus, MetadataGenerationRunType, MetadataGenerationTargetType, NotificationResourceType, NotificationRole, NotificationType, OpenLineageRunState, ProjectStatus, ResolutionStrategy, RuleAction, RuleScopeSelectionMode, RuleTargetType, RuleType, SelfGrantStatus, SortFieldAccountPool, SortFieldConnection, SortFieldProject, SortKey, SortOrder, Status, SubscriptionGrantCreationMode, SubscriptionGrantOverallStatus, SubscriptionGrantStatus, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TaskStatus, TimeSeriesEntityType, UserDesignation, UserProfileStatus, UserProfileType, UserType } from "./enums";
2
+ import type { AcceptedAssetScope, AccountInfo, AccountPoolSummary, AccountSource, ActionParameters, AssetFilterSummary, AssetListing, AssetPermission, AssetRevision, AssetScope, AssetTargetNameMap, AssetTypesForRule, ConfigurableEnvironmentAction, Configuration, ConnectionCredentials, ConnectionPropertiesOutput, ConnectionSummary, CustomParameter, DataProductItem, DataSourceConfigurationInput, DataSourceConfigurationOutput, DataSourceErrorMessage, Deployment, DeploymentProperties, DetailedGlossaryTerm, DomainUnitOwnerProperties, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, FormInput, FormOutput, MatchRationaleItem, Member, Model, Permissions, PhysicalEndpoint, PolicyGrantDetail, PolicyGrantPrincipal, ProjectDeletionError, ProvisioningProperties, RecommendationConfiguration, Resource, ResourceTag, ResourceTagParameter, ScheduleConfiguration, SingleSignOn, SubscribedListing, SubscribedPrincipal, TermRelations, TimeSeriesDataPointSummaryFormOutput, UserProfileDetails } from "./models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export interface CreateProjectProfileOutput {
7
+ /**
8
+ * <p>The ID of the domain where a project profile is created.</p>
9
+ * @public
10
+ */
11
+ domainId: string | undefined;
12
+ /**
13
+ * <p>Project profile ID.</p>
14
+ * @public
15
+ */
16
+ id: string | undefined;
17
+ /**
18
+ * <p>Project profile name.</p>
19
+ * @public
20
+ */
21
+ name: string | undefined;
22
+ /**
23
+ * <p>A project profile description.</p>
24
+ * @public
25
+ */
26
+ description?: string | undefined;
27
+ /**
28
+ * <p>Project profile status.</p>
29
+ * @public
30
+ */
31
+ status?: Status | undefined;
32
+ /**
33
+ * <p>The resource tags of the project profile.</p>
34
+ * @public
35
+ */
36
+ projectResourceTags?: ResourceTagParameter[] | undefined;
37
+ /**
38
+ * <p>Specifies whether custom project resource tags are supported.</p>
39
+ * @public
40
+ */
41
+ allowCustomProjectResourceTags?: boolean | undefined;
42
+ /**
43
+ * <p>Field viewable through the UI that provides a project user with the allowed resource tag specifications.</p>
44
+ * @public
45
+ */
46
+ projectResourceTagsDescription?: string | undefined;
47
+ /**
48
+ * <p>Environment configurations of a project profile.</p>
49
+ * @public
50
+ */
51
+ environmentConfigurations?: EnvironmentConfiguration[] | undefined;
52
+ /**
53
+ * <p>A user who created a project profile.</p>
54
+ * @public
55
+ */
56
+ createdBy: string | undefined;
57
+ /**
58
+ * <p>A timestamp at which a project profile is created.</p>
59
+ * @public
60
+ */
61
+ createdAt?: Date | undefined;
62
+ /**
63
+ * <p>A timestamp when a project profile was last updated.</p>
64
+ * @public
65
+ */
66
+ lastUpdatedAt?: Date | undefined;
67
+ /**
68
+ * <p>The ID of the domain unit where a project profile is created.</p>
69
+ * @public
70
+ */
71
+ domainUnitId?: string | undefined;
72
+ }
73
+ /**
74
+ * <p>The enforcement details of a glossary term.</p>
75
+ * @public
76
+ */
77
+ export interface GlossaryTermEnforcementDetail {
78
+ /**
79
+ * <p>The ID of the required glossary term.</p>
80
+ * @public
81
+ */
82
+ requiredGlossaryTermIds?: string[] | undefined;
83
+ }
3
84
  /**
4
85
  * <p>The reference of a metadata form.</p>
5
86
  * @public
@@ -2580,6 +2661,26 @@ export interface DeleteDataExportConfigurationInput {
2580
2661
  */
2581
2662
  export interface DeleteDataExportConfigurationOutput {
2582
2663
  }
2664
+ /**
2665
+ * @public
2666
+ */
2667
+ export interface DeleteDesignationInput {
2668
+ /**
2669
+ * <p>The identifier of the Amazon DataZone domain that contains the designation to delete.</p>
2670
+ * @public
2671
+ */
2672
+ domainIdentifier: string | undefined;
2673
+ /**
2674
+ * <p>The unique ID of the designation to delete.</p>
2675
+ * @public
2676
+ */
2677
+ identifier: string | undefined;
2678
+ }
2679
+ /**
2680
+ * @public
2681
+ */
2682
+ export interface DeleteDesignationOutput {
2683
+ }
2583
2684
  /**
2584
2685
  * @public
2585
2686
  */
@@ -4325,6 +4426,81 @@ export interface GetDataExportConfigurationOutput {
4325
4426
  */
4326
4427
  updatedAt?: Date | undefined;
4327
4428
  }
4429
+ /**
4430
+ * @public
4431
+ */
4432
+ export interface GetDesignationInput {
4433
+ /**
4434
+ * <p>The identifier of the Amazon DataZone domain that contains the designation.</p>
4435
+ * @public
4436
+ */
4437
+ domainIdentifier: string | undefined;
4438
+ /**
4439
+ * <p>The unique ID of the designation to retrieve.</p>
4440
+ * @public
4441
+ */
4442
+ identifier: string | undefined;
4443
+ }
4444
+ /**
4445
+ * A designation defines a named role with a Cedar permit policy that controls
4446
+ * what actions members holding this designation can perform within a project.
4447
+ * @public
4448
+ */
4449
+ export interface GetDesignationOutput {
4450
+ /**
4451
+ * <p>The identifier of the Amazon DataZone domain that contains the designation.</p>
4452
+ * @public
4453
+ */
4454
+ domainId: string | undefined;
4455
+ /**
4456
+ * <p>The unique ID of the designation.</p>
4457
+ * @public
4458
+ */
4459
+ id: string | undefined;
4460
+ /**
4461
+ * <p>The name of the designation. The name is unique within the domain.</p>
4462
+ * @public
4463
+ */
4464
+ name: string | undefined;
4465
+ /**
4466
+ * <p>A human-readable description of the designation and its intended use.</p>
4467
+ * @public
4468
+ */
4469
+ description?: string | undefined;
4470
+ /**
4471
+ * The classification of this designation. MANAGED designations are
4472
+ * system-defined and cannot be modified or deleted.
4473
+ * @public
4474
+ */
4475
+ designationType: DesignationType | undefined;
4476
+ /**
4477
+ * The Cedar permit policy that governs what actions holders of this
4478
+ * designation are allowed to perform.
4479
+ * @public
4480
+ */
4481
+ policy: string | undefined;
4482
+ /**
4483
+ * Whether deletion protection is enabled for this designation. When true,
4484
+ * DeleteDesignation is rejected until protection is disabled via UpdateDesignation.
4485
+ * @public
4486
+ */
4487
+ deletionProtection: boolean | undefined;
4488
+ /**
4489
+ * <p>The identifier of the Amazon DataZone user who created the designation.</p>
4490
+ * @public
4491
+ */
4492
+ createdBy: string | undefined;
4493
+ /**
4494
+ * <p>The date and time when the designation was created.</p>
4495
+ * @public
4496
+ */
4497
+ createdAt?: Date | undefined;
4498
+ /**
4499
+ * <p>The date and time when the designation was last updated.</p>
4500
+ * @public
4501
+ */
4502
+ lastUpdatedAt?: Date | undefined;
4503
+ }
4328
4504
  /**
4329
4505
  * @public
4330
4506
  */
@@ -6510,6 +6686,92 @@ export interface ListDataSourceRunActivitiesOutput {
6510
6686
  */
6511
6687
  nextToken?: string | undefined;
6512
6688
  }
6689
+ /**
6690
+ * @public
6691
+ */
6692
+ export interface ListDesignationsInput {
6693
+ /**
6694
+ * <p>The identifier of the Amazon DataZone domain that contains the designations to list.</p>
6695
+ * @public
6696
+ */
6697
+ domainIdentifier: string | undefined;
6698
+ /**
6699
+ * <p>If the results exceed the value of <code>MaxResults</code>, the previous call returns a pagination token. Specify this token in a subsequent call to <code>ListDesignations</code> to retrieve the next set of results. If not specified, the operation returns the first page of results.</p>
6700
+ * @public
6701
+ */
6702
+ nextToken?: string | undefined;
6703
+ /**
6704
+ * <p>The maximum number of designations to return in a single call to <code>ListDesignations</code>. If the number of designations exceeds <code>MaxResults</code>, the response includes a <code>NextToken</code> value. Use that token in a subsequent call to <code>ListDesignations</code> to retrieve the next set of designations. The default value is 20.</p>
6705
+ * @public
6706
+ */
6707
+ maxResults?: number | undefined;
6708
+ }
6709
+ /**
6710
+ * Summary representation of a designation returned by list operations.
6711
+ * @public
6712
+ */
6713
+ export interface DesignationSummary {
6714
+ /**
6715
+ * <p>The identifier of the Amazon DataZone domain that contains the designation.</p>
6716
+ * @public
6717
+ */
6718
+ domainId: string | undefined;
6719
+ /**
6720
+ * <p>The unique ID of the designation.</p>
6721
+ * @public
6722
+ */
6723
+ id: string | undefined;
6724
+ /**
6725
+ * <p>The name of the designation. The name is unique within the domain.</p>
6726
+ * @public
6727
+ */
6728
+ name: string | undefined;
6729
+ /**
6730
+ * <p>A human-readable description of the designation and its intended use.</p>
6731
+ * @public
6732
+ */
6733
+ description?: string | undefined;
6734
+ /**
6735
+ * The classification of this designation.
6736
+ * @public
6737
+ */
6738
+ designationType?: DesignationType | undefined;
6739
+ /**
6740
+ * Whether deletion protection is enabled for this designation.
6741
+ * @public
6742
+ */
6743
+ deletionProtection: boolean | undefined;
6744
+ /**
6745
+ * <p>The identifier of the Amazon DataZone user who created the designation.</p>
6746
+ * @public
6747
+ */
6748
+ createdBy: string | undefined;
6749
+ /**
6750
+ * <p>The date and time when the designation was created.</p>
6751
+ * @public
6752
+ */
6753
+ createdAt?: Date | undefined;
6754
+ /**
6755
+ * <p>The date and time when the designation was last updated.</p>
6756
+ * @public
6757
+ */
6758
+ updatedAt?: Date | undefined;
6759
+ }
6760
+ /**
6761
+ * @public
6762
+ */
6763
+ export interface ListDesignationsOutput {
6764
+ /**
6765
+ * <p>The designation summaries that <code>ListDesignations</code> returned. Each item contains summary information about a designation in the domain.</p>
6766
+ * @public
6767
+ */
6768
+ items?: DesignationSummary[] | undefined;
6769
+ /**
6770
+ * <p>A pagination token that indicates that more results are available. Pass this token to a subsequent call to <code>ListDesignations</code> to retrieve the next page of results. If there are no more results, this value is null.</p>
6771
+ * @public
6772
+ */
6773
+ nextToken?: string | undefined;
6774
+ }
6513
6775
  /**
6514
6776
  * @public
6515
6777
  */
@@ -7985,6 +8247,11 @@ export interface ProjectMember {
7985
8247
  * @public
7986
8248
  */
7987
8249
  designation: UserDesignation | undefined;
8250
+ /**
8251
+ * <p>The ID of the user-created designation held by the project member when <code>designation</code> is <code>USER_CREATED_DESIGNATION</code>.</p>
8252
+ * @public
8253
+ */
8254
+ userCreatedDesignationId?: string | undefined;
7988
8255
  }
7989
8256
  /**
7990
8257
  * @public
@@ -9242,445 +9509,3 @@ export interface DeleteNotebookInput {
9242
9509
  */
9243
9510
  export interface DeleteNotebookOutput {
9244
9511
  }
9245
- /**
9246
- * @public
9247
- */
9248
- export interface GetNotebookInput {
9249
- /**
9250
- * <p>The identifier of the Amazon SageMaker Unified Studio domain in which the notebook exists.</p>
9251
- * @public
9252
- */
9253
- domainIdentifier: string | undefined;
9254
- /**
9255
- * <p>The identifier of the notebook.</p>
9256
- * @public
9257
- */
9258
- identifier: string | undefined;
9259
- }
9260
- /**
9261
- * @public
9262
- */
9263
- export interface GetNotebookOutput {
9264
- /**
9265
- * <p>The identifier of the notebook.</p>
9266
- * @public
9267
- */
9268
- id: string | undefined;
9269
- /**
9270
- * <p>The name of the notebook.</p>
9271
- * @public
9272
- */
9273
- name: string | undefined;
9274
- /**
9275
- * <p>The identifier of the project that owns the notebook.</p>
9276
- * @public
9277
- */
9278
- owningProjectId: string | undefined;
9279
- /**
9280
- * <p>The identifier of the Amazon SageMaker Unified Studio domain.</p>
9281
- * @public
9282
- */
9283
- domainId: string | undefined;
9284
- /**
9285
- * <p>The ordered list of cells in the notebook.</p>
9286
- * @public
9287
- */
9288
- cellOrder: CellInformation[] | undefined;
9289
- /**
9290
- * <p>The status of the notebook.</p>
9291
- * @public
9292
- */
9293
- status: NotebookStatus | undefined;
9294
- /**
9295
- * <p>The type of the notebook.</p>
9296
- * @public
9297
- */
9298
- type?: NotebookType | undefined;
9299
- /**
9300
- * <p>The description of the notebook.</p>
9301
- * @public
9302
- */
9303
- description?: string | undefined;
9304
- /**
9305
- * <p>The timestamp of when the notebook was created.</p>
9306
- * @public
9307
- */
9308
- createdAt?: Date | undefined;
9309
- /**
9310
- * <p>The identifier of the user who created the notebook.</p>
9311
- * @public
9312
- */
9313
- createdBy?: string | undefined;
9314
- /**
9315
- * <p>The timestamp of when the notebook was last updated.</p>
9316
- * @public
9317
- */
9318
- updatedAt?: Date | undefined;
9319
- /**
9320
- * <p>The identifier of the user who last updated the notebook.</p>
9321
- * @public
9322
- */
9323
- updatedBy?: string | undefined;
9324
- /**
9325
- * <p>The identifier of the user who locked the notebook.</p>
9326
- * @public
9327
- */
9328
- lockedBy?: string | undefined;
9329
- /**
9330
- * <p>The timestamp of when the notebook was locked.</p>
9331
- * @public
9332
- */
9333
- lockedAt?: Date | undefined;
9334
- /**
9335
- * <p>The timestamp of when the notebook lock expires.</p>
9336
- * @public
9337
- */
9338
- lockExpiresAt?: Date | undefined;
9339
- /**
9340
- * <p>The identifier of the compute associated with the notebook.</p>
9341
- * @public
9342
- */
9343
- computeId?: string | undefined;
9344
- /**
9345
- * <p>The metadata of the notebook.</p>
9346
- * @public
9347
- */
9348
- metadata?: Record<string, string> | undefined;
9349
- /**
9350
- * <p>The sensitive parameters of the notebook.</p>
9351
- * @public
9352
- */
9353
- parameters?: Record<string, string> | undefined;
9354
- /**
9355
- * <p>The environment configuration of the notebook.</p>
9356
- * @public
9357
- */
9358
- environmentConfiguration?: EnvironmentConfig | undefined;
9359
- /**
9360
- * <p>The error details if the notebook is in a failed state.</p>
9361
- * @public
9362
- */
9363
- error?: NotebookError | undefined;
9364
- /**
9365
- * <p>The Git metadata associated with the notebook.</p>
9366
- * @public
9367
- */
9368
- gitMetadata?: GitMetadata | undefined;
9369
- }
9370
- /**
9371
- * @public
9372
- */
9373
- export interface ListNotebooksInput {
9374
- /**
9375
- * <p>The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.</p>
9376
- * @public
9377
- */
9378
- domainIdentifier: string | undefined;
9379
- /**
9380
- * <p>The identifier of the project that owns the notebooks.</p>
9381
- * @public
9382
- */
9383
- owningProjectIdentifier: string | undefined;
9384
- /**
9385
- * <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>
9386
- * @public
9387
- */
9388
- maxResults?: number | undefined;
9389
- /**
9390
- * <p>The sort order for the results.</p>
9391
- * @public
9392
- */
9393
- sortOrder?: SortOrder | undefined;
9394
- /**
9395
- * <p>The field to sort the results by.</p>
9396
- * @public
9397
- */
9398
- sortBy?: SortKey | undefined;
9399
- /**
9400
- * <p>The status to filter notebooks by.</p>
9401
- * @public
9402
- */
9403
- status?: NotebookStatus | undefined;
9404
- /**
9405
- * <p>The type to filter notebooks by.</p>
9406
- * @public
9407
- */
9408
- type?: NotebookType | undefined;
9409
- /**
9410
- * <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>
9411
- * @public
9412
- */
9413
- nextToken?: string | undefined;
9414
- }
9415
- /**
9416
- * <p>The summary of a notebook in Amazon SageMaker Unified Studio.</p>
9417
- * @public
9418
- */
9419
- export interface NotebookSummary {
9420
- /**
9421
- * <p>The identifier of the notebook.</p>
9422
- * @public
9423
- */
9424
- id: string | undefined;
9425
- /**
9426
- * <p>The name of the notebook.</p>
9427
- * @public
9428
- */
9429
- name: string | undefined;
9430
- /**
9431
- * <p>The identifier of the project that owns the notebook.</p>
9432
- * @public
9433
- */
9434
- owningProjectId: string | undefined;
9435
- /**
9436
- * <p>The identifier of the Amazon SageMaker Unified Studio domain.</p>
9437
- * @public
9438
- */
9439
- domainId: string | undefined;
9440
- /**
9441
- * <p>The status of the notebook.</p>
9442
- * @public
9443
- */
9444
- status: NotebookStatus | undefined;
9445
- /**
9446
- * <p>The type of the notebook.</p>
9447
- * @public
9448
- */
9449
- type?: NotebookType | undefined;
9450
- /**
9451
- * <p>The description of the notebook.</p>
9452
- * @public
9453
- */
9454
- description?: string | undefined;
9455
- /**
9456
- * <p>The timestamp of when the notebook was created.</p>
9457
- * @public
9458
- */
9459
- createdAt?: Date | undefined;
9460
- /**
9461
- * <p>The identifier of the user who created the notebook.</p>
9462
- * @public
9463
- */
9464
- createdBy?: string | undefined;
9465
- /**
9466
- * <p>The timestamp of when the notebook was last updated.</p>
9467
- * @public
9468
- */
9469
- updatedAt?: Date | undefined;
9470
- /**
9471
- * <p>The identifier of the user who last updated the notebook.</p>
9472
- * @public
9473
- */
9474
- updatedBy?: string | undefined;
9475
- }
9476
- /**
9477
- * @public
9478
- */
9479
- export interface ListNotebooksOutput {
9480
- /**
9481
- * <p>The results of the <code>ListNotebooks</code> action.</p>
9482
- * @public
9483
- */
9484
- items?: NotebookSummary[] | undefined;
9485
- /**
9486
- * <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>
9487
- * @public
9488
- */
9489
- nextToken?: string | undefined;
9490
- }
9491
- /**
9492
- * @public
9493
- */
9494
- export interface UpdateNotebookInput {
9495
- /**
9496
- * <p>The identifier of the Amazon SageMaker Unified Studio domain in which the notebook exists.</p>
9497
- * @public
9498
- */
9499
- domainIdentifier: string | undefined;
9500
- /**
9501
- * <p>The identifier of the notebook to update.</p>
9502
- * @public
9503
- */
9504
- identifier: string | undefined;
9505
- /**
9506
- * <p>The updated description of the notebook.</p>
9507
- * @public
9508
- */
9509
- description?: string | undefined;
9510
- /**
9511
- * <p>The updated status of the notebook.</p>
9512
- * @public
9513
- */
9514
- status?: NotebookStatus | undefined;
9515
- /**
9516
- * <p>The updated name of the notebook.</p>
9517
- * @public
9518
- */
9519
- name?: string | undefined;
9520
- /**
9521
- * <p>The updated ordered list of cells in the notebook.</p>
9522
- * @public
9523
- */
9524
- cellOrder?: CellInformation[] | undefined;
9525
- /**
9526
- * <p>The updated type of the notebook.</p>
9527
- * @public
9528
- */
9529
- type?: NotebookType | undefined;
9530
- /**
9531
- * <p>The updated metadata for the notebook, specified as key-value pairs.</p>
9532
- * @public
9533
- */
9534
- metadata?: Record<string, string> | undefined;
9535
- /**
9536
- * <p>The updated sensitive parameters for the notebook, specified as key-value pairs.</p>
9537
- * @public
9538
- */
9539
- parameters?: Record<string, string> | undefined;
9540
- /**
9541
- * <p>The updated environment configuration for the notebook.</p>
9542
- * @public
9543
- */
9544
- environmentConfiguration?: EnvironmentConfig | undefined;
9545
- /**
9546
- * <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>
9547
- * @public
9548
- */
9549
- clientToken?: string | undefined;
9550
- }
9551
- /**
9552
- * @public
9553
- */
9554
- export interface UpdateNotebookOutput {
9555
- /**
9556
- * <p>The identifier of the notebook.</p>
9557
- * @public
9558
- */
9559
- id: string | undefined;
9560
- /**
9561
- * <p>The name of the notebook.</p>
9562
- * @public
9563
- */
9564
- name: string | undefined;
9565
- /**
9566
- * <p>The identifier of the project that owns the notebook.</p>
9567
- * @public
9568
- */
9569
- owningProjectId: string | undefined;
9570
- /**
9571
- * <p>The identifier of the Amazon SageMaker Unified Studio domain.</p>
9572
- * @public
9573
- */
9574
- domainId: string | undefined;
9575
- /**
9576
- * <p>The ordered list of cells in the notebook.</p>
9577
- * @public
9578
- */
9579
- cellOrder: CellInformation[] | undefined;
9580
- /**
9581
- * <p>The status of the notebook.</p>
9582
- * @public
9583
- */
9584
- status: NotebookStatus | undefined;
9585
- /**
9586
- * <p>The type of the notebook.</p>
9587
- * @public
9588
- */
9589
- type?: NotebookType | undefined;
9590
- /**
9591
- * <p>The description of the notebook.</p>
9592
- * @public
9593
- */
9594
- description?: string | undefined;
9595
- /**
9596
- * <p>The timestamp of when the notebook was created.</p>
9597
- * @public
9598
- */
9599
- createdAt?: Date | undefined;
9600
- /**
9601
- * <p>The identifier of the user who created the notebook.</p>
9602
- * @public
9603
- */
9604
- createdBy?: string | undefined;
9605
- /**
9606
- * <p>The timestamp of when the notebook was last updated.</p>
9607
- * @public
9608
- */
9609
- updatedAt?: Date | undefined;
9610
- /**
9611
- * <p>The identifier of the user who last updated the notebook.</p>
9612
- * @public
9613
- */
9614
- updatedBy?: string | undefined;
9615
- /**
9616
- * <p>The identifier of the user who locked the notebook.</p>
9617
- * @public
9618
- */
9619
- lockedBy?: string | undefined;
9620
- /**
9621
- * <p>The timestamp of when the notebook was locked.</p>
9622
- * @public
9623
- */
9624
- lockedAt?: Date | undefined;
9625
- /**
9626
- * <p>The timestamp of when the notebook lock expires.</p>
9627
- * @public
9628
- */
9629
- lockExpiresAt?: Date | undefined;
9630
- /**
9631
- * <p>The identifier of the compute associated with the notebook.</p>
9632
- * @public
9633
- */
9634
- computeId?: string | undefined;
9635
- /**
9636
- * <p>The metadata of the notebook.</p>
9637
- * @public
9638
- */
9639
- metadata?: Record<string, string> | undefined;
9640
- /**
9641
- * <p>The sensitive parameters of the notebook.</p>
9642
- * @public
9643
- */
9644
- parameters?: Record<string, string> | undefined;
9645
- /**
9646
- * <p>The environment configuration of the notebook.</p>
9647
- * @public
9648
- */
9649
- environmentConfiguration?: EnvironmentConfig | undefined;
9650
- /**
9651
- * <p>The error details if the notebook is in a failed state.</p>
9652
- * @public
9653
- */
9654
- error?: NotebookError | undefined;
9655
- /**
9656
- * <p>The Git metadata associated with the notebook.</p>
9657
- * @public
9658
- */
9659
- gitMetadata?: GitMetadata | undefined;
9660
- }
9661
- /**
9662
- * @public
9663
- */
9664
- export interface GetNotebookExportInput {
9665
- /**
9666
- * <p>The identifier of the Amazon SageMaker Unified Studio domain in which the notebook export exists.</p>
9667
- * @public
9668
- */
9669
- domainIdentifier: string | undefined;
9670
- /**
9671
- * <p>The identifier of the notebook export.</p>
9672
- * @public
9673
- */
9674
- identifier: string | undefined;
9675
- }
9676
- /**
9677
- * <p>The error details of a failed notebook export in Amazon SageMaker Unified Studio.</p>
9678
- * @public
9679
- */
9680
- export interface NotebookExportError {
9681
- /**
9682
- * <p>The error message. The maximum length is 256 characters.</p>
9683
- * @public
9684
- */
9685
- message: string | undefined;
9686
- }