@aws-sdk/client-datazone 3.1039.0 → 3.1040.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 (54) hide show
  1. package/README.md +28 -0
  2. package/dist-cjs/index.js +85 -0
  3. package/dist-cjs/schemas/schemas_0.js +214 -42
  4. package/dist-es/DataZone.js +10 -0
  5. package/dist-es/commands/GetNotebookRunCommand.js +16 -0
  6. package/dist-es/commands/ListNotebookRunsCommand.js +16 -0
  7. package/dist-es/commands/StartNotebookRunCommand.js +16 -0
  8. package/dist-es/commands/StopNotebookRunCommand.js +16 -0
  9. package/dist-es/commands/index.js +4 -0
  10. package/dist-es/models/enums.js +21 -0
  11. package/dist-es/pagination/ListNotebookRunsPaginator.js +4 -0
  12. package/dist-es/pagination/index.js +1 -0
  13. package/dist-es/schemas/schemas_0.js +197 -26
  14. package/dist-types/DataZone.d.ts +35 -0
  15. package/dist-types/DataZoneClient.d.ts +6 -2
  16. package/dist-types/commands/DeleteRuleCommand.d.ts +1 -1
  17. package/dist-types/commands/GetNotebookRunCommand.d.ts +148 -0
  18. package/dist-types/commands/GetRuleCommand.d.ts +1 -1
  19. package/dist-types/commands/ListNotebookRunsCommand.d.ts +116 -0
  20. package/dist-types/commands/ListRulesCommand.d.ts +1 -1
  21. package/dist-types/commands/RemovePolicyGrantCommand.d.ts +2 -1
  22. package/dist-types/commands/RevokeSubscriptionCommand.d.ts +1 -1
  23. package/dist-types/commands/StartNotebookRunCommand.d.ts +184 -0
  24. package/dist-types/commands/StopNotebookRunCommand.d.ts +100 -0
  25. package/dist-types/commands/UpdateRuleCommand.d.ts +1 -1
  26. package/dist-types/commands/index.d.ts +4 -0
  27. package/dist-types/models/enums.d.ts +92 -0
  28. package/dist-types/models/models_0.d.ts +22 -22
  29. package/dist-types/models/models_1.d.ts +557 -574
  30. package/dist-types/models/models_2.d.ts +635 -3
  31. package/dist-types/pagination/ListNotebookRunsPaginator.d.ts +7 -0
  32. package/dist-types/pagination/index.d.ts +1 -0
  33. package/dist-types/schemas/schemas_0.d.ts +22 -0
  34. package/dist-types/ts3.4/DataZone.d.ts +75 -0
  35. package/dist-types/ts3.4/DataZoneClient.d.ts +24 -0
  36. package/dist-types/ts3.4/commands/DeleteRuleCommand.d.ts +1 -1
  37. package/dist-types/ts3.4/commands/GetNotebookRunCommand.d.ts +47 -0
  38. package/dist-types/ts3.4/commands/GetRuleCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/ListNotebookRunsCommand.d.ts +50 -0
  40. package/dist-types/ts3.4/commands/ListRulesCommand.d.ts +1 -1
  41. package/dist-types/ts3.4/commands/RemovePolicyGrantCommand.d.ts +2 -4
  42. package/dist-types/ts3.4/commands/RevokeSubscriptionCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/StartNotebookRunCommand.d.ts +50 -0
  44. package/dist-types/ts3.4/commands/StopNotebookRunCommand.d.ts +50 -0
  45. package/dist-types/ts3.4/commands/UpdateRuleCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  47. package/dist-types/ts3.4/models/enums.d.ts +29 -0
  48. package/dist-types/ts3.4/models/models_0.d.ts +5 -6
  49. package/dist-types/ts3.4/models/models_1.d.ts +145 -149
  50. package/dist-types/ts3.4/models/models_2.d.ts +154 -4
  51. package/dist-types/ts3.4/pagination/ListNotebookRunsPaginator.d.ts +11 -0
  52. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  53. package/dist-types/ts3.4/schemas/schemas_0.d.ts +22 -0
  54. package/package.json +1 -1
@@ -1,5 +1,27 @@
1
- import type { ConfigurationStatus, ConnectionScope, ConnectionType, DataAssetActivityStatus, DataProductStatus, DataSourceRunStatus, DataSourceRunType, DataSourceStatus, DataZoneEntityType, DomainStatus, DomainVersion, EdgeDirection, EnableSetting, EnvironmentStatus, FilterOperator, FilterStatus, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GovernedEntityType, GroupProfileStatus, JobRunMode, JobRunStatus, JobType, LineageEventProcessingStatus, LineageImportStatus, ListingStatus, ManagedPolicyType, MetadataGenerationRunStatus, MetadataGenerationRunType, MetadataGenerationTargetType, NotificationResourceType, NotificationRole, NotificationType, OpenLineageRunState, ProjectStatus, RejectRuleBehavior, RelationDirection, RelationType, ResolutionStrategy, RuleAction, RuleTargetType, RuleType, SelfGrantStatus, SortFieldAccountPool, SortFieldConnection, SortFieldProject, SortKey, SortOrder, Status, SubscriptionGrantCreationMode, SubscriptionGrantOverallStatus, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TaskStatus, TimeSeriesEntityType, UserDesignation, UserProfileStatus, UserProfileType, UserType } from "./enums";
2
- import type { AcceptedAssetScope, AccountInfo, AccountPoolSummary, AccountSource, ActionParameters, AssetFilterSummary, AssetListing, AssetPermission, AssetRevision, ConfigurableEnvironmentAction, Configuration, ConnectionCredentials, ConnectionPropertiesOutput, ConnectionSummary, CustomParameter, DataProductItem, DataSourceConfigurationInput, DataSourceConfigurationOutput, DataSourceErrorMessage, Deployment, DeploymentProperties, DetailedGlossaryTerm, DomainUnitOwnerProperties, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, FormInput, FormOutput, GrantedEntity, MatchRationaleItem, Member, Model, OwnerProperties, PhysicalEndpoint, PolicyGrantDetail, PolicyGrantPrincipal, ProjectDeletionError, ProvisioningProperties, RecommendationConfiguration, Resource, ResourceTag, ResourceTagParameter, RuleDetail, RuleScope, RuleTarget, ScheduleConfiguration, SingleSignOn, SubscribedAsset, SubscribedGroupInput, SubscribedIamPrincipalInput, SubscribedListing, SubscribedListingInput, SubscribedPrincipal, SubscribedProjectInput, SubscribedUserInput, TermRelations, TimeSeriesDataPointSummaryFormOutput, UserProfileDetails } from "./models_0";
1
+ import type { ConfigurationStatus, ConnectionScope, ConnectionType, DataAssetActivityStatus, DataProductStatus, DataSourceRunStatus, DataSourceRunType, DataSourceStatus, DataZoneEntityType, DomainStatus, DomainVersion, EdgeDirection, EnableSetting, EnvironmentStatus, FilterOperator, FilterStatus, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GovernedEntityType, GroupProfileStatus, JobRunMode, JobRunStatus, JobType, LineageEventProcessingStatus, LineageImportStatus, ListingStatus, ManagedPolicyType, MetadataGenerationRunStatus, MetadataGenerationRunType, MetadataGenerationTargetType, NetworkAccessType, NotebookRunStatus, NotificationResourceType, NotificationRole, NotificationType, OpenLineageRunState, PackageManager, ProjectStatus, RejectRuleBehavior, RelationDirection, RelationType, ResolutionStrategy, SelfGrantStatus, SortFieldAccountPool, SortFieldConnection, SortFieldProject, SortKey, SortOrder, Status, SubscriptionGrantCreationMode, SubscriptionGrantOverallStatus, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TaskStatus, TimeSeriesEntityType, TriggerSourceType, UserDesignation, UserProfileStatus, UserProfileType, UserType } from "./enums";
2
+ import type { AcceptedAssetScope, AccountInfo, AccountPoolSummary, AccountSource, ActionParameters, AssetFilterSummary, AssetListing, AssetPermission, AssetRevision, CellInformation, ComputeConfig, ConfigurableEnvironmentAction, Configuration, ConnectionCredentials, ConnectionPropertiesOutput, ConnectionSummary, CustomParameter, DataProductItem, DataSourceConfigurationInput, DataSourceConfigurationOutput, DataSourceErrorMessage, Deployment, DeploymentProperties, DetailedGlossaryTerm, DomainUnitOwnerProperties, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, FormInput, FormOutput, GrantedEntity, MatchRationaleItem, Member, Model, OwnerProperties, PhysicalEndpoint, PolicyGrantDetail, PolicyGrantPrincipal, ProjectDeletionError, ProvisioningProperties, RecommendationConfiguration, Resource, ResourceTag, ResourceTagParameter, ScheduleConfiguration, SingleSignOn, SubscribedAsset, SubscribedGroupInput, SubscribedIamPrincipalInput, SubscribedListing, SubscribedListingInput, SubscribedPrincipal, TermRelations, TimeSeriesDataPointSummaryFormOutput, UserProfileDetails } from "./models_0";
3
+ /**
4
+ * <p>The project that is to be given a subscription grant.</p>
5
+ * @public
6
+ */
7
+ export interface SubscribedProjectInput {
8
+ /**
9
+ * <p>The identifier of the project that is to be given a subscription grant.</p>
10
+ * @public
11
+ */
12
+ identifier?: string | undefined;
13
+ }
14
+ /**
15
+ * <p>The subscribed user.</p>
16
+ * @public
17
+ */
18
+ export interface SubscribedUserInput {
19
+ /**
20
+ * <p>The ID of the subscribed user.</p>
21
+ * @public
22
+ */
23
+ identifier?: string | undefined;
24
+ }
3
25
  /**
4
26
  * <p>The principal that is to be given a subscriptiong grant.</p>
5
27
  * @public
@@ -8459,1218 +8481,1179 @@ export interface StartMetadataGenerationRunOutput {
8459
8481
  owningProjectId?: string | undefined;
8460
8482
  }
8461
8483
  /**
8484
+ * <p>The package configuration for a notebook run environment in Amazon DataZone.</p>
8462
8485
  * @public
8463
8486
  */
8464
- export interface PostLineageEventInput {
8487
+ export interface PackageConfig {
8465
8488
  /**
8466
- * <p>The ID of the domain where you want to post a data lineage event.</p>
8489
+ * <p>The package manager for the notebook run environment. The default value is <code>UV</code>.</p>
8467
8490
  * @public
8468
8491
  */
8469
- domainIdentifier: string | undefined;
8492
+ packageManager: PackageManager | undefined;
8470
8493
  /**
8471
- * <p>The data lineage event that you want to post. Only open-lineage run event are supported as events. </p>
8494
+ * <p>The package specification content for the notebook run environment. The maximum length is 10240 characters.</p>
8472
8495
  * @public
8473
8496
  */
8474
- event: Uint8Array | undefined;
8497
+ packageSpecification?: string | undefined;
8498
+ }
8499
+ /**
8500
+ * <p>The environment configuration for a notebook run in Amazon DataZone.</p>
8501
+ * @public
8502
+ */
8503
+ export interface EnvironmentConfig {
8475
8504
  /**
8476
- * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
8505
+ * <p>The image version for the notebook run environment.</p>
8477
8506
  * @public
8478
8507
  */
8479
- clientToken?: string | undefined;
8508
+ imageVersion?: string | undefined;
8509
+ /**
8510
+ * <p>The package configuration for the notebook run environment.</p>
8511
+ * @public
8512
+ */
8513
+ packageConfig?: PackageConfig | undefined;
8480
8514
  }
8481
8515
  /**
8482
8516
  * @public
8483
8517
  */
8484
- export interface PostLineageEventOutput {
8518
+ export interface GetNotebookRunInput {
8485
8519
  /**
8486
- * <p>The ID of the lineage event.</p>
8520
+ * <p>The identifier of the Amazon DataZone domain in which the notebook run exists.</p>
8487
8521
  * @public
8488
8522
  */
8489
- id?: string | undefined;
8523
+ domainIdentifier: string | undefined;
8490
8524
  /**
8491
- * <p>The ID of the domain.</p>
8525
+ * <p>The identifier of the notebook run.</p>
8492
8526
  * @public
8493
8527
  */
8494
- domainId?: string | undefined;
8528
+ identifier: string | undefined;
8495
8529
  }
8496
8530
  /**
8497
- * <p>The time series data points form.</p>
8531
+ * <p>The error details of a failed notebook run in Amazon DataZone.</p>
8498
8532
  * @public
8499
8533
  */
8500
- export interface TimeSeriesDataPointFormInput {
8534
+ export interface NotebookRunError {
8501
8535
  /**
8502
- * <p>The name of the time series data points form.</p>
8536
+ * <p>The error message. The maximum length is 1024 characters.</p>
8503
8537
  * @public
8504
8538
  */
8505
- formName: string | undefined;
8539
+ message: string | undefined;
8540
+ }
8541
+ /**
8542
+ * <p>The network configuration for a notebook run in Amazon DataZone.</p>
8543
+ * @public
8544
+ */
8545
+ export interface NetworkConfig {
8506
8546
  /**
8507
- * <p>The ID of the type of the time series data points form.</p>
8547
+ * <p>The network access type for the notebook run. Valid values are <code>PUBLIC_INTERNET_ONLY</code> and <code>VPC_ONLY</code>.</p>
8508
8548
  * @public
8509
8549
  */
8510
- typeIdentifier: string | undefined;
8550
+ networkAccessType: NetworkAccessType | undefined;
8511
8551
  /**
8512
- * <p>The revision type of the time series data points form.</p>
8552
+ * <p>The identifier of the VPC for the notebook run. This is required when the network access type is <code>VPC_ONLY</code>.</p>
8513
8553
  * @public
8514
8554
  */
8515
- typeRevision?: string | undefined;
8555
+ vpcId?: string | undefined;
8516
8556
  /**
8517
- * <p>The timestamp of the time series data points form.</p>
8557
+ * <p>The identifiers of the subnets for the notebook run. You can specify up to 10 subnets.</p>
8518
8558
  * @public
8519
8559
  */
8520
- timestamp: Date | undefined;
8560
+ subnetIds?: string[] | undefined;
8521
8561
  /**
8522
- * <p>The content of the time series data points form.</p>
8562
+ * <p>The identifiers of the security groups for the notebook run. You can specify up to 5 security groups.</p>
8523
8563
  * @public
8524
8564
  */
8525
- content?: string | undefined;
8565
+ securityGroupIds?: string[] | undefined;
8526
8566
  }
8527
8567
  /**
8568
+ * <p>The storage configuration for a notebook run in Amazon DataZone.</p>
8528
8569
  * @public
8529
8570
  */
8530
- export interface PostTimeSeriesDataPointsInput {
8531
- /**
8532
- * <p>The ID of the Amazon DataZone domain in which you want to post time series data points.</p>
8533
- * @public
8534
- */
8535
- domainIdentifier: string | undefined;
8536
- /**
8537
- * <p>The ID of the asset for which you want to post time series data points.</p>
8538
- * @public
8539
- */
8540
- entityIdentifier: string | undefined;
8571
+ export interface StorageConfig {
8541
8572
  /**
8542
- * <p>The type of the asset for which you want to post data points.</p>
8573
+ * <p>The Amazon Simple Storage Service path for the project storage.</p>
8543
8574
  * @public
8544
8575
  */
8545
- entityType: TimeSeriesEntityType | undefined;
8576
+ projectS3Path?: string | undefined;
8546
8577
  /**
8547
- * <p>The forms that contain the data points that you want to post.</p>
8578
+ * <p>The ARN of the KMS key used for encryption.</p>
8548
8579
  * @public
8549
8580
  */
8550
- forms: TimeSeriesDataPointFormInput[] | undefined;
8581
+ kmsKeyArn?: string | undefined;
8582
+ }
8583
+ /**
8584
+ * <p>The timeout configuration for a notebook run in Amazon DataZone.</p>
8585
+ * @public
8586
+ */
8587
+ export interface TimeoutConfig {
8551
8588
  /**
8552
- * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
8589
+ * <p>The timeout for the notebook run, in minutes. The minimum value is 60 minutes (1 hour), the maximum value is 1440 minutes (24 hours), and the default value is 720 minutes (12 hours).</p>
8553
8590
  * @public
8554
8591
  */
8555
- clientToken?: string | undefined;
8592
+ runTimeoutInMinutes?: number | undefined;
8556
8593
  }
8557
8594
  /**
8595
+ * <p>The source that triggered a notebook run in Amazon DataZone.</p>
8558
8596
  * @public
8559
8597
  */
8560
- export interface PostTimeSeriesDataPointsOutput {
8598
+ export interface TriggerSource {
8561
8599
  /**
8562
- * <p>The ID of the Amazon DataZone domain in which you want to post time series data points.</p>
8600
+ * <p>The type of the trigger source. Valid values are <code>MANUAL</code>, <code>SCHEDULED</code>, and <code>WORKFLOW</code>.</p>
8563
8601
  * @public
8564
8602
  */
8565
- domainId?: string | undefined;
8603
+ type?: TriggerSourceType | undefined;
8566
8604
  /**
8567
- * <p>The ID of the asset for which you want to post time series data points.</p>
8605
+ * <p>The name of the trigger source.</p>
8568
8606
  * @public
8569
8607
  */
8570
- entityId?: string | undefined;
8608
+ name?: string | undefined;
8609
+ }
8610
+ /**
8611
+ * @public
8612
+ */
8613
+ export interface GetNotebookRunOutput {
8571
8614
  /**
8572
- * <p>The type of the asset for which you want to post data points.</p>
8615
+ * <p>The identifier of the notebook run.</p>
8573
8616
  * @public
8574
8617
  */
8575
- entityType?: TimeSeriesEntityType | undefined;
8618
+ id: string | undefined;
8576
8619
  /**
8577
- * <p>The forms that contain the data points that you have posted.</p>
8620
+ * <p>The identifier of the Amazon DataZone domain.</p>
8578
8621
  * @public
8579
8622
  */
8580
- forms?: TimeSeriesDataPointFormOutput[] | undefined;
8581
- }
8582
- /**
8583
- * @public
8584
- */
8585
- export interface PutDataExportConfigurationInput {
8623
+ domainId: string | undefined;
8586
8624
  /**
8587
- * <p>The domain ID for which you want to create data export configuration details.</p>
8625
+ * <p>The identifier of the project that owns the notebook run.</p>
8588
8626
  * @public
8589
8627
  */
8590
- domainIdentifier: string | undefined;
8628
+ owningProjectId: string | undefined;
8591
8629
  /**
8592
- * <p>Specifies that the export is to be enabled as part of creating data export configuration details.</p>
8630
+ * <p>The identifier of the notebook.</p>
8593
8631
  * @public
8594
8632
  */
8595
- enableExport: boolean | undefined;
8633
+ notebookId: string | undefined;
8596
8634
  /**
8597
- * <p>The encryption configuration as part of creating data export configuration details.</p> <p>The KMS key provided here as part of encryptionConfiguration must have the required permissions as described in <a href="https://docs.aws.amazon.com/sagemaker-unified-studio/latest/adminguide/sagemaker-unified-studio-export-asset-metadata-kms-permissions.html">KMS permissions for exporting asset metadata in Amazon SageMaker Unified Studio</a>.</p>
8635
+ * <p>The identifier of the schedule associated with the notebook run.</p>
8598
8636
  * @public
8599
8637
  */
8600
- encryptionConfiguration?: EncryptionConfiguration | undefined;
8638
+ scheduleId?: string | undefined;
8601
8639
  /**
8602
- * <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>
8640
+ * <p>The status of the notebook run.</p>
8603
8641
  * @public
8604
8642
  */
8605
- clientToken?: string | undefined;
8606
- }
8607
- /**
8608
- * @public
8609
- */
8610
- export interface PutDataExportConfigurationOutput {
8611
- }
8612
- /**
8613
- * <p>A search filter in Amazon DataZone.</p>
8614
- * @public
8615
- */
8616
- export interface Filter {
8643
+ status: NotebookRunStatus | undefined;
8617
8644
  /**
8618
- * <p>A search filter attribute in Amazon DataZone.</p>
8645
+ * <p>The ordered list of cells in the notebook run.</p>
8619
8646
  * @public
8620
8647
  */
8621
- attribute: string | undefined;
8648
+ cellOrder?: CellInformation[] | undefined;
8622
8649
  /**
8623
- * <p>A search filter string value in Amazon DataZone.</p>
8650
+ * <p>The metadata of the notebook run.</p>
8624
8651
  * @public
8625
8652
  */
8626
- value?: string | undefined;
8653
+ metadata?: Record<string, string> | undefined;
8627
8654
  /**
8628
- * <p>A search filter integer value in Amazon DataZone.</p>
8655
+ * <p>The sensitive parameters of the notebook run.</p>
8629
8656
  * @public
8630
8657
  */
8631
- intValue?: number | undefined;
8658
+ parameters?: Record<string, string> | undefined;
8632
8659
  /**
8633
- * <p>Specifies the search filter operator.</p>
8660
+ * <p>The compute configuration of the notebook run.</p>
8634
8661
  * @public
8635
8662
  */
8636
- operator?: FilterOperator | undefined;
8637
- }
8638
- /**
8639
- * <p>The pattern describing the query's relational traversal.</p>
8640
- * @public
8641
- */
8642
- export interface RelationPattern {
8663
+ computeConfiguration?: ComputeConfig | undefined;
8643
8664
  /**
8644
- * <p>The type of relation to query.</p>
8665
+ * <p>The network configuration of the notebook run.</p>
8645
8666
  * @public
8646
8667
  */
8647
- relationType: RelationType | undefined;
8668
+ networkConfiguration?: NetworkConfig | undefined;
8648
8669
  /**
8649
- * <p>The direction to query.</p>
8670
+ * <p>The timeout configuration of the notebook run.</p>
8650
8671
  * @public
8651
8672
  */
8652
- relationDirection: RelationDirection | undefined;
8673
+ timeoutConfiguration?: TimeoutConfig | undefined;
8653
8674
  /**
8654
- * <p>The number of hops to query.</p>
8675
+ * <p>The environment configuration of the notebook run, including image version and package settings.</p>
8655
8676
  * @public
8656
8677
  */
8657
- maxPathLength?: number | undefined;
8658
- }
8659
- /**
8660
- * <p>The summary and output forms of a LineageNode</p>
8661
- * @public
8662
- */
8663
- export interface LineageNodeItem {
8678
+ environmentConfiguration?: EnvironmentConfig | undefined;
8664
8679
  /**
8665
- * <p>The ID of the domain of the data lineage node.</p>
8680
+ * <p>The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.</p>
8666
8681
  * @public
8667
8682
  */
8668
- domainId: string | undefined;
8683
+ storageConfiguration?: StorageConfig | undefined;
8669
8684
  /**
8670
- * <p>The name of the data lineage node.</p>
8685
+ * <p>The source that triggered the notebook run.</p>
8671
8686
  * @public
8672
8687
  */
8673
- name?: string | undefined;
8688
+ triggerSource?: TriggerSource | undefined;
8674
8689
  /**
8675
- * <p>The description of the data lineage node.</p>
8690
+ * <p>The error details if the notebook run failed.</p>
8676
8691
  * @public
8677
8692
  */
8678
- description?: string | undefined;
8693
+ error?: NotebookRunError | undefined;
8679
8694
  /**
8680
- * <p>The timestamp at which the data lineage node was created.</p>
8695
+ * <p>The timestamp of when the notebook run was created.</p>
8681
8696
  * @public
8682
8697
  */
8683
8698
  createdAt?: Date | undefined;
8684
8699
  /**
8685
- * <p>The user who created the data lineage node.</p>
8700
+ * <p>The identifier of the user who created the notebook run.</p>
8686
8701
  * @public
8687
8702
  */
8688
8703
  createdBy?: string | undefined;
8689
8704
  /**
8690
- * <p>The timestamp at which the data lineage node was updated.</p>
8705
+ * <p>The timestamp of when the notebook run was last updated.</p>
8691
8706
  * @public
8692
8707
  */
8693
8708
  updatedAt?: Date | undefined;
8694
8709
  /**
8695
- * <p>The user who updated the data lineage node.</p>
8710
+ * <p>The identifier of the user who last updated the notebook run.</p>
8696
8711
  * @public
8697
8712
  */
8698
8713
  updatedBy?: string | undefined;
8699
8714
  /**
8700
- * <p>The ID of the data lineage node.</p>
8715
+ * <p>The timestamp of when the notebook run started executing.</p>
8701
8716
  * @public
8702
8717
  */
8703
- id: string | undefined;
8718
+ startedAt?: Date | undefined;
8704
8719
  /**
8705
- * <p>The name of the type of the data lineage node.</p>
8720
+ * <p>The timestamp of when the notebook run completed.</p>
8706
8721
  * @public
8707
8722
  */
8708
- typeName: string | undefined;
8723
+ completedAt?: Date | undefined;
8724
+ }
8725
+ /**
8726
+ * @public
8727
+ */
8728
+ export interface ListNotebookRunsInput {
8709
8729
  /**
8710
- * <p>The type of the revision of the data lineage node.</p>
8730
+ * <p>The identifier of the Amazon DataZone domain in which to list notebook runs.</p>
8711
8731
  * @public
8712
8732
  */
8713
- typeRevision?: string | undefined;
8733
+ domainIdentifier: string | undefined;
8714
8734
  /**
8715
- * <p>The alternate ID of the data lineage node.</p>
8735
+ * <p>The identifier of the project that owns the notebook runs.</p>
8716
8736
  * @public
8717
8737
  */
8718
- sourceIdentifier?: string | undefined;
8738
+ owningProjectIdentifier: string | undefined;
8719
8739
  /**
8720
- * <p>The event timestamp of the data lineage node.</p>
8740
+ * <p>The identifier of the notebook to filter runs by.</p>
8721
8741
  * @public
8722
8742
  */
8723
- eventTimestamp?: Date | undefined;
8743
+ notebookIdentifier?: string | undefined;
8724
8744
  /**
8725
- * <p>The forms included in the additional attributes of a data lineage node.</p>
8745
+ * <p>The status to filter notebook runs by.</p>
8726
8746
  * @public
8727
8747
  */
8728
- formsOutput?: FormOutput[] | undefined;
8748
+ status?: NotebookRunStatus | undefined;
8729
8749
  /**
8730
- * <p>The IDs of the upstream data lineage nodes.</p>
8750
+ * <p>The identifier of the schedule to filter notebook runs by.</p>
8731
8751
  * @public
8732
8752
  */
8733
- upstreamLineageNodeIds?: string[] | undefined;
8753
+ scheduleIdentifier?: string | undefined;
8734
8754
  /**
8735
- * <p>The IDs of the downstream data lineage nodes.</p>
8755
+ * <p>The maximum number of notebook runs to return in a single call. When the number of notebook runs exceeds the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value.</p>
8736
8756
  * @public
8737
8757
  */
8738
- downstreamLineageNodeIds?: string[] | undefined;
8739
- }
8740
- /**
8741
- * <p>Resulting entity from the query.</p>
8742
- * @public
8743
- */
8744
- export type ResultItem = ResultItem.LineageNodeMember | ResultItem.$UnknownMember;
8745
- /**
8746
- * @public
8747
- */
8748
- export declare namespace ResultItem {
8758
+ maxResults?: number | undefined;
8749
8759
  /**
8750
- * <p>Resulting data lineage node from the query.</p>
8760
+ * <p>The sort order for the results.</p>
8751
8761
  * @public
8752
8762
  */
8753
- interface LineageNodeMember {
8754
- lineageNode: LineageNodeItem;
8755
- $unknown?: never;
8756
- }
8763
+ sortOrder?: SortOrder | undefined;
8757
8764
  /**
8765
+ * <p>When the number of notebook runs 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 notebook runs, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebookRuns</code> to list the next set of notebook runs.</p>
8758
8766
  * @public
8759
8767
  */
8760
- interface $UnknownMember {
8761
- lineageNode?: never;
8762
- $unknown: [string, any];
8763
- }
8764
- /**
8765
- * @deprecated unused in schema-serde mode.
8766
- *
8767
- */
8768
- interface Visitor<T> {
8769
- lineageNode: (value: LineageNodeItem) => T;
8770
- _: (name: string, value: any) => T;
8771
- }
8768
+ nextToken?: string | undefined;
8772
8769
  }
8773
8770
  /**
8771
+ * <p>The summary of a notebook run in Amazon DataZone.</p>
8774
8772
  * @public
8775
8773
  */
8776
- export interface QueryGraphOutput {
8774
+ export interface NotebookRunSummary {
8777
8775
  /**
8778
- * <p>The results of the <code>QueryGraph</code> action.</p>
8776
+ * <p>The identifier of the notebook run.</p>
8779
8777
  * @public
8780
8778
  */
8781
- items?: ResultItem[] | undefined;
8779
+ id: string | undefined;
8782
8780
  /**
8783
- * <p>When the number of entities 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 entities, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>QueryGraph</code> to list the next set of entities.</p>
8781
+ * <p>The identifier of the Amazon DataZone domain.</p>
8784
8782
  * @public
8785
8783
  */
8786
- nextToken?: string | undefined;
8787
- }
8788
- /**
8789
- * <p>The details of the automatically generated business metadata that is rejected.</p>
8790
- * @public
8791
- */
8792
- export interface RejectChoice {
8784
+ domainId: string | undefined;
8793
8785
  /**
8794
- * <p>Specifies the target (for example, a column name) where a prediction can be rejected.</p>
8786
+ * <p>The identifier of the project that owns the notebook run.</p>
8795
8787
  * @public
8796
8788
  */
8797
- predictionTarget: string | undefined;
8789
+ owningProjectId: string | undefined;
8798
8790
  /**
8799
- * <p>Specifies the the automatically generated business metadata that can be rejected.</p>
8791
+ * <p>The identifier of the notebook.</p>
8800
8792
  * @public
8801
8793
  */
8802
- predictionChoices?: number[] | undefined;
8803
- }
8804
- /**
8805
- * <p>Specifies the rule and the threshold under which a prediction can be rejected.</p>
8806
- * @public
8807
- */
8808
- export interface RejectRule {
8794
+ notebookId: string | undefined;
8809
8795
  /**
8810
- * <p>Specifies whether you want to reject the top prediction for all targets or none.</p>
8796
+ * <p>The identifier of the schedule associated with the notebook run.</p>
8811
8797
  * @public
8812
8798
  */
8813
- rule?: RejectRuleBehavior | undefined;
8799
+ scheduleId?: string | undefined;
8814
8800
  /**
8815
- * <p>The confidence score that specifies the condition at which a prediction can be rejected.</p>
8801
+ * <p>The status of the notebook run.</p>
8816
8802
  * @public
8817
8803
  */
8818
- threshold?: number | undefined;
8819
- }
8820
- /**
8821
- * @public
8822
- */
8823
- export interface RejectPredictionsInput {
8804
+ status: NotebookRunStatus | undefined;
8824
8805
  /**
8825
- * <p>The identifier of the Amazon DataZone domain.</p>
8806
+ * <p>The source that triggered the notebook run.</p>
8826
8807
  * @public
8827
8808
  */
8828
- domainIdentifier: string | undefined;
8809
+ triggerSource?: TriggerSource | undefined;
8829
8810
  /**
8830
- * <p>The identifier of the prediction.</p>
8811
+ * <p>The timestamp of when the notebook run was created.</p>
8831
8812
  * @public
8832
8813
  */
8833
- identifier: string | undefined;
8814
+ createdAt?: Date | undefined;
8834
8815
  /**
8835
- * <p>The revision that is to be made to the asset.</p>
8816
+ * <p>The identifier of the user who created the notebook run.</p>
8836
8817
  * @public
8837
8818
  */
8838
- revision?: string | undefined;
8819
+ createdBy?: string | undefined;
8839
8820
  /**
8840
- * <p>Specifies the rule (or the conditions) under which a prediction can be rejected.</p>
8821
+ * <p>The timestamp of when the notebook run was last updated.</p>
8841
8822
  * @public
8842
8823
  */
8843
- rejectRule?: RejectRule | undefined;
8824
+ updatedAt?: Date | undefined;
8844
8825
  /**
8845
- * <p>Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be rejected.</p>
8826
+ * <p>The identifier of the user who last updated the notebook run.</p>
8846
8827
  * @public
8847
8828
  */
8848
- rejectChoices?: RejectChoice[] | undefined;
8829
+ updatedBy?: string | undefined;
8849
8830
  /**
8850
- * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
8851
- * @public
8852
- */
8853
- clientToken?: string | undefined;
8854
- }
8855
- /**
8856
- * @public
8857
- */
8858
- export interface RejectPredictionsOutput {
8859
- /**
8860
- * <p>The ID of the Amazon DataZone domain.</p>
8861
- * @public
8862
- */
8863
- domainId: string | undefined;
8864
- /**
8865
- * <p>The ID of the asset.</p>
8831
+ * <p>The timestamp of when the notebook run started executing.</p>
8866
8832
  * @public
8867
8833
  */
8868
- assetId: string | undefined;
8834
+ startedAt?: Date | undefined;
8869
8835
  /**
8870
- * <p>The revision that is to be made to the asset.</p>
8836
+ * <p>The timestamp of when the notebook run completed.</p>
8871
8837
  * @public
8872
8838
  */
8873
- assetRevision: string | undefined;
8839
+ completedAt?: Date | undefined;
8874
8840
  }
8875
8841
  /**
8876
8842
  * @public
8877
8843
  */
8878
- export interface RejectSubscriptionRequestInput {
8879
- /**
8880
- * <p>The identifier of the Amazon DataZone domain in which the subscription request was rejected.</p>
8881
- * @public
8882
- */
8883
- domainIdentifier: string | undefined;
8844
+ export interface ListNotebookRunsOutput {
8884
8845
  /**
8885
- * <p>The identifier of the subscription request that was rejected.</p>
8846
+ * <p>The results of the <code>ListNotebookRuns</code> action.</p>
8886
8847
  * @public
8887
8848
  */
8888
- identifier: string | undefined;
8849
+ items?: NotebookRunSummary[] | undefined;
8889
8850
  /**
8890
- * <p>The decision comment of the rejected subscription request.</p>
8851
+ * <p>When the number of notebook runs 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 notebook runs, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebookRuns</code> to list the next set of notebook runs.</p>
8891
8852
  * @public
8892
8853
  */
8893
- decisionComment?: string | undefined;
8854
+ nextToken?: string | undefined;
8894
8855
  }
8895
8856
  /**
8896
8857
  * @public
8897
8858
  */
8898
- export interface RejectSubscriptionRequestOutput {
8859
+ export interface StartNotebookRunInput {
8899
8860
  /**
8900
- * <p>The identifier of the subscription request that was rejected.</p>
8861
+ * <p>The identifier of the Amazon DataZone domain in which the notebook run is started.</p>
8901
8862
  * @public
8902
8863
  */
8903
- id: string | undefined;
8864
+ domainIdentifier: string | undefined;
8904
8865
  /**
8905
- * <p>The timestamp of when the subscription request was rejected.</p>
8866
+ * <p>The identifier of the project that owns the notebook run.</p>
8906
8867
  * @public
8907
8868
  */
8908
- createdBy: string | undefined;
8869
+ owningProjectIdentifier: string | undefined;
8909
8870
  /**
8910
- * <p>The Amazon DataZone user who updated the subscription request.</p>
8871
+ * <p>The identifier of the notebook to run.</p>
8911
8872
  * @public
8912
8873
  */
8913
- updatedBy?: string | undefined;
8874
+ notebookIdentifier: string | undefined;
8914
8875
  /**
8915
- * <p>The identifier of the Amazon DataZone domain in which the subscription request was rejected.</p>
8876
+ * <p>The identifier of the schedule associated with the notebook run.</p>
8916
8877
  * @public
8917
8878
  */
8918
- domainId: string | undefined;
8879
+ scheduleIdentifier?: string | undefined;
8919
8880
  /**
8920
- * <p>The status of the subscription request.</p>
8881
+ * <p>The compute configuration for the notebook run, including instance type and environment version.</p>
8921
8882
  * @public
8922
8883
  */
8923
- status: SubscriptionRequestStatus | undefined;
8884
+ computeConfiguration?: ComputeConfig | undefined;
8924
8885
  /**
8925
- * <p>The timestamp of when the subscription request was rejected.</p>
8886
+ * <p>The network configuration for the notebook run, including network access type and optional VPC settings.</p>
8926
8887
  * @public
8927
8888
  */
8928
- createdAt: Date | undefined;
8889
+ networkConfiguration?: NetworkConfig | undefined;
8929
8890
  /**
8930
- * <p>The timestamp of when the subscription request was updated.</p>
8891
+ * <p>The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).</p>
8931
8892
  * @public
8932
8893
  */
8933
- updatedAt: Date | undefined;
8894
+ timeoutConfiguration?: TimeoutConfig | undefined;
8934
8895
  /**
8935
- * <p>The reason for the subscription request.</p>
8896
+ * <p>The source that triggered the notebook run.</p>
8936
8897
  * @public
8937
8898
  */
8938
- requestReason: string | undefined;
8899
+ triggerSource?: TriggerSource | undefined;
8939
8900
  /**
8940
- * <p>The subscribed principals of the subscription request.</p>
8901
+ * <p>The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>
8941
8902
  * @public
8942
8903
  */
8943
- subscribedPrincipals: SubscribedPrincipal[] | undefined;
8904
+ metadata?: Record<string, string> | undefined;
8944
8905
  /**
8945
- * <p>The subscribed listings of the subscription request.</p>
8906
+ * <p>The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>
8946
8907
  * @public
8947
8908
  */
8948
- subscribedListings: SubscribedListing[] | undefined;
8909
+ parameters?: Record<string, string> | undefined;
8949
8910
  /**
8950
- * <p>The identifier of the subscription request reviewer.</p>
8911
+ * <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>
8951
8912
  * @public
8952
8913
  */
8953
- reviewerId?: string | undefined;
8914
+ clientToken?: string | undefined;
8915
+ }
8916
+ /**
8917
+ * @public
8918
+ */
8919
+ export interface StartNotebookRunOutput {
8954
8920
  /**
8955
- * <p>The decision comment of the rejected subscription request.</p>
8921
+ * <p>The identifier of the notebook run.</p>
8956
8922
  * @public
8957
8923
  */
8958
- decisionComment?: string | undefined;
8924
+ id: string | undefined;
8959
8925
  /**
8960
- * <p>The ID of the existing subscription.</p>
8926
+ * <p>The identifier of the Amazon DataZone domain.</p>
8961
8927
  * @public
8962
8928
  */
8963
- existingSubscriptionId?: string | undefined;
8929
+ domainId: string | undefined;
8964
8930
  /**
8965
- * <p>Metadata forms included in the subscription request.</p>
8931
+ * <p>The identifier of the project that owns the notebook run.</p>
8966
8932
  * @public
8967
8933
  */
8968
- metadataForms?: FormOutput[] | undefined;
8969
- }
8970
- /**
8971
- * @public
8972
- */
8973
- export interface RemoveEntityOwnerInput {
8934
+ owningProjectId: string | undefined;
8974
8935
  /**
8975
- * <p>The ID of the domain where you want to remove an owner from an entity.</p>
8936
+ * <p>The identifier of the notebook.</p>
8976
8937
  * @public
8977
8938
  */
8978
- domainIdentifier: string | undefined;
8939
+ notebookId: string | undefined;
8979
8940
  /**
8980
- * <p>The type of the entity from which you want to remove an owner.</p>
8941
+ * <p>The identifier of the schedule associated with the notebook run.</p>
8981
8942
  * @public
8982
8943
  */
8983
- entityType: DataZoneEntityType | undefined;
8944
+ scheduleId?: string | undefined;
8984
8945
  /**
8985
- * <p>The ID of the entity from which you want to remove an owner.</p>
8946
+ * <p>The status of the notebook run.</p>
8986
8947
  * @public
8987
8948
  */
8988
- entityIdentifier: string | undefined;
8949
+ status: NotebookRunStatus | undefined;
8989
8950
  /**
8990
- * <p>The owner that you want to remove from an entity.</p>
8951
+ * <p>The ordered list of cells in the notebook run.</p>
8991
8952
  * @public
8992
8953
  */
8993
- owner: OwnerProperties | undefined;
8954
+ cellOrder?: CellInformation[] | undefined;
8994
8955
  /**
8995
- * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
8956
+ * <p>The metadata of the notebook run.</p>
8996
8957
  * @public
8997
8958
  */
8998
- clientToken?: string | undefined;
8999
- }
9000
- /**
9001
- * @public
9002
- */
9003
- export interface RemoveEntityOwnerOutput {
9004
- }
9005
- /**
9006
- * @public
9007
- */
9008
- export interface RemovePolicyGrantInput {
8959
+ metadata?: Record<string, string> | undefined;
9009
8960
  /**
9010
- * <p>The ID of the domain where you want to remove a policy grant.</p>
8961
+ * <p>The sensitive parameters of the notebook run.</p>
9011
8962
  * @public
9012
8963
  */
9013
- domainIdentifier: string | undefined;
8964
+ parameters?: Record<string, string> | undefined;
9014
8965
  /**
9015
- * <p>The type of the entity from which you want to remove a policy grant.</p>
8966
+ * <p>The compute configuration of the notebook run.</p>
9016
8967
  * @public
9017
8968
  */
9018
- entityType: TargetEntityType | undefined;
8969
+ computeConfiguration?: ComputeConfig | undefined;
9019
8970
  /**
9020
- * <p>The ID of the entity from which you want to remove a policy grant.</p>
8971
+ * <p>The network configuration of the notebook run.</p>
9021
8972
  * @public
9022
8973
  */
9023
- entityIdentifier: string | undefined;
8974
+ networkConfiguration?: NetworkConfig | undefined;
9024
8975
  /**
9025
- * <p>The type of the policy that you want to remove.</p>
8976
+ * <p>The timeout configuration of the notebook run.</p>
9026
8977
  * @public
9027
8978
  */
9028
- policyType: ManagedPolicyType | undefined;
8979
+ timeoutConfiguration?: TimeoutConfig | undefined;
9029
8980
  /**
9030
- * <p>The principal from which you want to remove a policy grant.</p>
8981
+ * <p>The environment configuration of the notebook run, including image version and package settings.</p>
9031
8982
  * @public
9032
8983
  */
9033
- principal: PolicyGrantPrincipal | undefined;
8984
+ environmentConfiguration?: EnvironmentConfig | undefined;
9034
8985
  /**
9035
- * <p>The ID of the policy grant that is to be removed from a specified entity.</p>
8986
+ * <p>The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.</p>
9036
8987
  * @public
9037
8988
  */
9038
- grantIdentifier?: string | undefined;
8989
+ storageConfiguration?: StorageConfig | undefined;
9039
8990
  /**
9040
- * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
8991
+ * <p>The source that triggered the notebook run.</p>
9041
8992
  * @public
9042
8993
  */
9043
- clientToken?: string | undefined;
9044
- }
9045
- /**
9046
- * @public
9047
- */
9048
- export interface RemovePolicyGrantOutput {
9049
- }
9050
- /**
9051
- * @public
9052
- */
9053
- export interface RevokeSubscriptionInput {
8994
+ triggerSource?: TriggerSource | undefined;
9054
8995
  /**
9055
- * <p>The identifier of the Amazon DataZone domain where you want to revoke a subscription.</p>
8996
+ * <p>The error details if the notebook run failed.</p>
9056
8997
  * @public
9057
8998
  */
9058
- domainIdentifier: string | undefined;
8999
+ error?: NotebookRunError | undefined;
9059
9000
  /**
9060
- * <p>The identifier of the revoked subscription.</p>
9001
+ * <p>The timestamp of when the notebook run was created.</p>
9061
9002
  * @public
9062
9003
  */
9063
- identifier: string | undefined;
9004
+ createdAt?: Date | undefined;
9064
9005
  /**
9065
- * <p>Specifies whether permissions are retained when the subscription is revoked.</p>
9006
+ * <p>The identifier of the user who created the notebook run.</p>
9066
9007
  * @public
9067
9008
  */
9068
- retainPermissions?: boolean | undefined;
9069
- }
9070
- /**
9071
- * @public
9072
- */
9073
- export interface RevokeSubscriptionOutput {
9009
+ createdBy?: string | undefined;
9074
9010
  /**
9075
- * <p>The identifier of the revoked subscription.</p>
9011
+ * <p>The timestamp of when the notebook run was last updated.</p>
9076
9012
  * @public
9077
9013
  */
9078
- id: string | undefined;
9014
+ updatedAt?: Date | undefined;
9079
9015
  /**
9080
- * <p>The identifier of the user who revoked the subscription.</p>
9016
+ * <p>The identifier of the user who last updated the notebook run.</p>
9081
9017
  * @public
9082
9018
  */
9083
- createdBy: string | undefined;
9019
+ updatedBy?: string | undefined;
9084
9020
  /**
9085
- * <p>The Amazon DataZone user who revoked the subscription.</p>
9021
+ * <p>The timestamp of when the notebook run started executing.</p>
9086
9022
  * @public
9087
9023
  */
9088
- updatedBy?: string | undefined;
9024
+ startedAt?: Date | undefined;
9089
9025
  /**
9090
- * <p>The identifier of the Amazon DataZone domain where you want to revoke a subscription.</p>
9026
+ * <p>The timestamp of when the notebook run completed.</p>
9091
9027
  * @public
9092
9028
  */
9093
- domainId: string | undefined;
9029
+ completedAt?: Date | undefined;
9030
+ }
9031
+ /**
9032
+ * @public
9033
+ */
9034
+ export interface StopNotebookRunInput {
9094
9035
  /**
9095
- * <p>The status of the revoked subscription.</p>
9036
+ * <p>The identifier of the Amazon DataZone domain in which the notebook run is stopped.</p>
9096
9037
  * @public
9097
9038
  */
9098
- status: SubscriptionStatus | undefined;
9039
+ domainIdentifier: string | undefined;
9099
9040
  /**
9100
- * <p>The timestamp of when the subscription was revoked.</p>
9041
+ * <p>The identifier of the notebook run to stop.</p>
9101
9042
  * @public
9102
9043
  */
9103
- createdAt: Date | undefined;
9044
+ identifier: string | undefined;
9104
9045
  /**
9105
- * <p>The timestamp of when the subscription was revoked.</p>
9046
+ * <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>
9106
9047
  * @public
9107
9048
  */
9108
- updatedAt: Date | undefined;
9049
+ clientToken?: string | undefined;
9050
+ }
9051
+ /**
9052
+ * @public
9053
+ */
9054
+ export interface StopNotebookRunOutput {
9109
9055
  /**
9110
- * <p>The subscribed principal of the revoked subscription.</p>
9056
+ * <p>The identifier of the notebook run.</p>
9111
9057
  * @public
9112
9058
  */
9113
- subscribedPrincipal: SubscribedPrincipal | undefined;
9059
+ id: string | undefined;
9114
9060
  /**
9115
- * <p>The subscribed listing of the revoked subscription.</p>
9061
+ * <p>The identifier of the Amazon DataZone domain.</p>
9116
9062
  * @public
9117
9063
  */
9118
- subscribedListing: SubscribedListing | undefined;
9064
+ domainId: string | undefined;
9119
9065
  /**
9120
- * <p>The identifier of the subscription request for the revoked subscription.</p>
9066
+ * <p>The identifier of the project that owns the notebook run.</p>
9121
9067
  * @public
9122
9068
  */
9123
- subscriptionRequestId?: string | undefined;
9069
+ owningProjectId: string | undefined;
9124
9070
  /**
9125
- * <p>Specifies whether permissions are retained when the subscription is revoked.</p>
9071
+ * <p>The status of the notebook run.</p>
9126
9072
  * @public
9127
9073
  */
9128
- retainPermissions?: boolean | undefined;
9074
+ status: NotebookRunStatus | undefined;
9129
9075
  }
9130
9076
  /**
9131
9077
  * @public
9132
9078
  */
9133
- export interface DeleteRuleInput {
9079
+ export interface PostLineageEventInput {
9134
9080
  /**
9135
- * <p>The ID of the domain that where the rule is to be deleted.</p>
9081
+ * <p>The ID of the domain where you want to post a data lineage event.</p>
9136
9082
  * @public
9137
9083
  */
9138
9084
  domainIdentifier: string | undefined;
9139
9085
  /**
9140
- * <p>The ID of the rule that is to be deleted.</p>
9086
+ * <p>The data lineage event that you want to post. Only open-lineage run event are supported as events. </p>
9141
9087
  * @public
9142
9088
  */
9143
- identifier: string | undefined;
9144
- }
9145
- /**
9146
- * @public
9147
- */
9148
- export interface DeleteRuleOutput {
9089
+ event: Uint8Array | undefined;
9090
+ /**
9091
+ * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
9092
+ * @public
9093
+ */
9094
+ clientToken?: string | undefined;
9149
9095
  }
9150
9096
  /**
9151
9097
  * @public
9152
9098
  */
9153
- export interface GetRuleInput {
9154
- /**
9155
- * <p>The ID of the domain where the <code>GetRule</code> action is to be invoked.</p>
9156
- * @public
9157
- */
9158
- domainIdentifier: string | undefined;
9099
+ export interface PostLineageEventOutput {
9159
9100
  /**
9160
- * <p>The ID of the rule.</p>
9101
+ * <p>The ID of the lineage event.</p>
9161
9102
  * @public
9162
9103
  */
9163
- identifier: string | undefined;
9104
+ id?: string | undefined;
9164
9105
  /**
9165
- * <p>The revision of the rule.</p>
9106
+ * <p>The ID of the domain.</p>
9166
9107
  * @public
9167
9108
  */
9168
- revision?: string | undefined;
9109
+ domainId?: string | undefined;
9169
9110
  }
9170
9111
  /**
9112
+ * <p>The time series data points form.</p>
9171
9113
  * @public
9172
9114
  */
9173
- export interface GetRuleOutput {
9115
+ export interface TimeSeriesDataPointFormInput {
9174
9116
  /**
9175
- * <p>The ID of the rule.</p>
9117
+ * <p>The name of the time series data points form.</p>
9176
9118
  * @public
9177
9119
  */
9178
- identifier: string | undefined;
9120
+ formName: string | undefined;
9179
9121
  /**
9180
- * <p>The revision of the rule.</p>
9122
+ * <p>The ID of the type of the time series data points form.</p>
9181
9123
  * @public
9182
9124
  */
9183
- revision: string | undefined;
9125
+ typeIdentifier: string | undefined;
9184
9126
  /**
9185
- * <p>The name of the rule.</p>
9127
+ * <p>The revision type of the time series data points form.</p>
9186
9128
  * @public
9187
9129
  */
9188
- name: string | undefined;
9130
+ typeRevision?: string | undefined;
9189
9131
  /**
9190
- * <p>The type of the rule.</p>
9132
+ * <p>The timestamp of the time series data points form.</p>
9191
9133
  * @public
9192
9134
  */
9193
- ruleType: RuleType | undefined;
9135
+ timestamp: Date | undefined;
9194
9136
  /**
9195
- * <p>The target of the rule.</p>
9137
+ * <p>The content of the time series data points form.</p>
9196
9138
  * @public
9197
9139
  */
9198
- target: RuleTarget | undefined;
9140
+ content?: string | undefined;
9141
+ }
9142
+ /**
9143
+ * @public
9144
+ */
9145
+ export interface PostTimeSeriesDataPointsInput {
9199
9146
  /**
9200
- * <p>The action of the rule.</p>
9147
+ * <p>The ID of the Amazon DataZone domain in which you want to post time series data points.</p>
9201
9148
  * @public
9202
9149
  */
9203
- action: RuleAction | undefined;
9150
+ domainIdentifier: string | undefined;
9204
9151
  /**
9205
- * <p>The scope of the rule.</p>
9152
+ * <p>The ID of the asset for which you want to post time series data points.</p>
9206
9153
  * @public
9207
9154
  */
9208
- scope: RuleScope | undefined;
9155
+ entityIdentifier: string | undefined;
9209
9156
  /**
9210
- * <p>The detail of the rule.</p>
9157
+ * <p>The type of the asset for which you want to post data points.</p>
9211
9158
  * @public
9212
9159
  */
9213
- detail: RuleDetail | undefined;
9160
+ entityType: TimeSeriesEntityType | undefined;
9214
9161
  /**
9215
- * <p>The target type of the rule.</p>
9162
+ * <p>The forms that contain the data points that you want to post.</p>
9216
9163
  * @public
9217
9164
  */
9218
- targetType?: RuleTargetType | undefined;
9165
+ forms: TimeSeriesDataPointFormInput[] | undefined;
9219
9166
  /**
9220
- * <p>The description of the rule.</p>
9167
+ * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
9221
9168
  * @public
9222
9169
  */
9223
- description?: string | undefined;
9170
+ clientToken?: string | undefined;
9171
+ }
9172
+ /**
9173
+ * @public
9174
+ */
9175
+ export interface PostTimeSeriesDataPointsOutput {
9224
9176
  /**
9225
- * <p>The timestamp at which the rule was created.</p>
9177
+ * <p>The ID of the Amazon DataZone domain in which you want to post time series data points.</p>
9226
9178
  * @public
9227
9179
  */
9228
- createdAt: Date | undefined;
9180
+ domainId?: string | undefined;
9229
9181
  /**
9230
- * <p>The timestamp at which the rule was last updated.</p>
9182
+ * <p>The ID of the asset for which you want to post time series data points.</p>
9231
9183
  * @public
9232
9184
  */
9233
- updatedAt: Date | undefined;
9185
+ entityId?: string | undefined;
9234
9186
  /**
9235
- * <p>The user who created the rule.</p>
9187
+ * <p>The type of the asset for which you want to post data points.</p>
9236
9188
  * @public
9237
9189
  */
9238
- createdBy: string | undefined;
9190
+ entityType?: TimeSeriesEntityType | undefined;
9239
9191
  /**
9240
- * <p>The timestamp at which the rule was last updated.</p>
9192
+ * <p>The forms that contain the data points that you have posted.</p>
9241
9193
  * @public
9242
9194
  */
9243
- lastUpdatedBy: string | undefined;
9195
+ forms?: TimeSeriesDataPointFormOutput[] | undefined;
9244
9196
  }
9245
9197
  /**
9246
9198
  * @public
9247
9199
  */
9248
- export interface ListRulesInput {
9200
+ export interface PutDataExportConfigurationInput {
9249
9201
  /**
9250
- * <p>The ID of the domain in which the rules are to be listed.</p>
9202
+ * <p>The domain ID for which you want to create data export configuration details.</p>
9251
9203
  * @public
9252
9204
  */
9253
9205
  domainIdentifier: string | undefined;
9254
9206
  /**
9255
- * <p>The target type of the rule.</p>
9207
+ * <p>Specifies that the export is to be enabled as part of creating data export configuration details.</p>
9256
9208
  * @public
9257
9209
  */
9258
- targetType: RuleTargetType | undefined;
9210
+ enableExport: boolean | undefined;
9259
9211
  /**
9260
- * <p>The target ID of the rule.</p>
9212
+ * <p>The encryption configuration as part of creating data export configuration details.</p> <p>The KMS key provided here as part of encryptionConfiguration must have the required permissions as described in <a href="https://docs.aws.amazon.com/sagemaker-unified-studio/latest/adminguide/sagemaker-unified-studio-export-asset-metadata-kms-permissions.html">KMS permissions for exporting asset metadata in Amazon SageMaker Unified Studio</a>.</p>
9261
9213
  * @public
9262
9214
  */
9263
- targetIdentifier: string | undefined;
9215
+ encryptionConfiguration?: EncryptionConfiguration | undefined;
9264
9216
  /**
9265
- * <p>The type of the rule.</p>
9217
+ * <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>
9266
9218
  * @public
9267
9219
  */
9268
- ruleType?: RuleType | undefined;
9220
+ clientToken?: string | undefined;
9221
+ }
9222
+ /**
9223
+ * @public
9224
+ */
9225
+ export interface PutDataExportConfigurationOutput {
9226
+ }
9227
+ /**
9228
+ * <p>A search filter in Amazon DataZone.</p>
9229
+ * @public
9230
+ */
9231
+ export interface Filter {
9269
9232
  /**
9270
- * <p>The action of the rule.</p>
9233
+ * <p>A search filter attribute in Amazon DataZone.</p>
9271
9234
  * @public
9272
9235
  */
9273
- action?: RuleAction | undefined;
9236
+ attribute: string | undefined;
9274
9237
  /**
9275
- * <p>The IDs of projects in which rules are to be listed.</p>
9238
+ * <p>A search filter string value in Amazon DataZone.</p>
9276
9239
  * @public
9277
9240
  */
9278
- projectIds?: string[] | undefined;
9241
+ value?: string | undefined;
9279
9242
  /**
9280
- * <p>The asset types of the rule.</p>
9243
+ * <p>A search filter integer value in Amazon DataZone.</p>
9281
9244
  * @public
9282
9245
  */
9283
- assetTypes?: string[] | undefined;
9246
+ intValue?: number | undefined;
9284
9247
  /**
9285
- * <p>The data product of the rule.</p>
9248
+ * <p>Specifies the search filter operator.</p>
9286
9249
  * @public
9287
9250
  */
9288
- dataProduct?: boolean | undefined;
9251
+ operator?: FilterOperator | undefined;
9252
+ }
9253
+ /**
9254
+ * <p>The pattern describing the query's relational traversal.</p>
9255
+ * @public
9256
+ */
9257
+ export interface RelationPattern {
9289
9258
  /**
9290
- * <p>Specifies whether to include cascading rules in the results.</p>
9259
+ * <p>The type of relation to query.</p>
9291
9260
  * @public
9292
9261
  */
9293
- includeCascaded?: boolean | undefined;
9262
+ relationType: RelationType | undefined;
9294
9263
  /**
9295
- * <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>
9264
+ * <p>The direction to query.</p>
9296
9265
  * @public
9297
9266
  */
9298
- maxResults?: number | undefined;
9267
+ relationDirection: RelationDirection | undefined;
9299
9268
  /**
9300
- * <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>
9269
+ * <p>The number of hops to query.</p>
9301
9270
  * @public
9302
9271
  */
9303
- nextToken?: string | undefined;
9272
+ maxPathLength?: number | undefined;
9304
9273
  }
9305
9274
  /**
9306
- * <p>The summary of the rule.</p>
9275
+ * <p>The summary and output forms of a LineageNode</p>
9307
9276
  * @public
9308
9277
  */
9309
- export interface RuleSummary {
9278
+ export interface LineageNodeItem {
9310
9279
  /**
9311
- * <p>The ID of the rule.</p>
9280
+ * <p>The ID of the domain of the data lineage node.</p>
9312
9281
  * @public
9313
9282
  */
9314
- identifier?: string | undefined;
9283
+ domainId: string | undefined;
9315
9284
  /**
9316
- * <p>The revision of the rule.</p>
9285
+ * <p>The name of the data lineage node.</p>
9317
9286
  * @public
9318
9287
  */
9319
- revision?: string | undefined;
9288
+ name?: string | undefined;
9320
9289
  /**
9321
- * <p>The type of the rule.</p>
9290
+ * <p>The description of the data lineage node.</p>
9322
9291
  * @public
9323
9292
  */
9324
- ruleType?: RuleType | undefined;
9293
+ description?: string | undefined;
9325
9294
  /**
9326
- * <p>The name of the rule.</p>
9295
+ * <p>The timestamp at which the data lineage node was created.</p>
9327
9296
  * @public
9328
9297
  */
9329
- name?: string | undefined;
9298
+ createdAt?: Date | undefined;
9330
9299
  /**
9331
- * <p>The target type of the rule.</p>
9300
+ * <p>The user who created the data lineage node.</p>
9332
9301
  * @public
9333
9302
  */
9334
- targetType?: RuleTargetType | undefined;
9303
+ createdBy?: string | undefined;
9335
9304
  /**
9336
- * <p>The target of the rule.</p>
9305
+ * <p>The timestamp at which the data lineage node was updated.</p>
9337
9306
  * @public
9338
9307
  */
9339
- target?: RuleTarget | undefined;
9308
+ updatedAt?: Date | undefined;
9340
9309
  /**
9341
- * <p>The action of the rule.</p>
9310
+ * <p>The user who updated the data lineage node.</p>
9342
9311
  * @public
9343
9312
  */
9344
- action?: RuleAction | undefined;
9313
+ updatedBy?: string | undefined;
9345
9314
  /**
9346
- * <p>The scope of the rule.</p>
9315
+ * <p>The ID of the data lineage node.</p>
9347
9316
  * @public
9348
9317
  */
9349
- scope?: RuleScope | undefined;
9318
+ id: string | undefined;
9350
9319
  /**
9351
- * <p>The timestamp at which the rule was last updated.</p>
9320
+ * <p>The name of the type of the data lineage node.</p>
9352
9321
  * @public
9353
9322
  */
9354
- updatedAt?: Date | undefined;
9323
+ typeName: string | undefined;
9355
9324
  /**
9356
- * <p>The timestamp at which the rule was last updated.</p>
9325
+ * <p>The type of the revision of the data lineage node.</p>
9357
9326
  * @public
9358
9327
  */
9359
- lastUpdatedBy?: string | undefined;
9360
- }
9361
- /**
9362
- * @public
9363
- */
9364
- export interface ListRulesOutput {
9328
+ typeRevision?: string | undefined;
9365
9329
  /**
9366
- * <p>The results of the <code>ListRules</code> action.</p>
9330
+ * <p>The alternate ID of the data lineage node.</p>
9367
9331
  * @public
9368
9332
  */
9369
- items: RuleSummary[] | undefined;
9333
+ sourceIdentifier?: string | undefined;
9370
9334
  /**
9371
- * <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>
9335
+ * <p>The event timestamp of the data lineage node.</p>
9372
9336
  * @public
9373
9337
  */
9374
- nextToken?: string | undefined;
9375
- }
9376
- /**
9377
- * @public
9378
- */
9379
- export interface UpdateRuleInput {
9338
+ eventTimestamp?: Date | undefined;
9380
9339
  /**
9381
- * <p>The ID of the domain in which a rule is to be updated.</p>
9340
+ * <p>The forms included in the additional attributes of a data lineage node.</p>
9382
9341
  * @public
9383
9342
  */
9384
- domainIdentifier: string | undefined;
9343
+ formsOutput?: FormOutput[] | undefined;
9385
9344
  /**
9386
- * <p>The ID of the rule that is to be updated</p>
9345
+ * <p>The IDs of the upstream data lineage nodes.</p>
9387
9346
  * @public
9388
9347
  */
9389
- identifier: string | undefined;
9348
+ upstreamLineageNodeIds?: string[] | undefined;
9390
9349
  /**
9391
- * <p>The name of the rule.</p>
9350
+ * <p>The IDs of the downstream data lineage nodes.</p>
9392
9351
  * @public
9393
9352
  */
9394
- name?: string | undefined;
9353
+ downstreamLineageNodeIds?: string[] | undefined;
9354
+ }
9355
+ /**
9356
+ * <p>Resulting entity from the query.</p>
9357
+ * @public
9358
+ */
9359
+ export type ResultItem = ResultItem.LineageNodeMember | ResultItem.$UnknownMember;
9360
+ /**
9361
+ * @public
9362
+ */
9363
+ export declare namespace ResultItem {
9395
9364
  /**
9396
- * <p>The description of the rule.</p>
9365
+ * <p>Resulting data lineage node from the query.</p>
9397
9366
  * @public
9398
9367
  */
9399
- description?: string | undefined;
9368
+ interface LineageNodeMember {
9369
+ lineageNode: LineageNodeItem;
9370
+ $unknown?: never;
9371
+ }
9400
9372
  /**
9401
- * <p>The scrope of the rule.</p>
9402
9373
  * @public
9403
9374
  */
9404
- scope?: RuleScope | undefined;
9375
+ interface $UnknownMember {
9376
+ lineageNode?: never;
9377
+ $unknown: [string, any];
9378
+ }
9405
9379
  /**
9406
- * <p>The detail of the rule.</p>
9380
+ * @deprecated unused in schema-serde mode.
9381
+ *
9382
+ */
9383
+ interface Visitor<T> {
9384
+ lineageNode: (value: LineageNodeItem) => T;
9385
+ _: (name: string, value: any) => T;
9386
+ }
9387
+ }
9388
+ /**
9389
+ * @public
9390
+ */
9391
+ export interface QueryGraphOutput {
9392
+ /**
9393
+ * <p>The results of the <code>QueryGraph</code> action.</p>
9407
9394
  * @public
9408
9395
  */
9409
- detail?: RuleDetail | undefined;
9396
+ items?: ResultItem[] | undefined;
9410
9397
  /**
9411
- * <p>Specifies whether to update this rule in the child domain units.</p>
9398
+ * <p>When the number of entities 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 entities, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>QueryGraph</code> to list the next set of entities.</p>
9412
9399
  * @public
9413
9400
  */
9414
- includeChildDomainUnits?: boolean | undefined;
9401
+ nextToken?: string | undefined;
9415
9402
  }
9416
9403
  /**
9404
+ * <p>The details of the automatically generated business metadata that is rejected.</p>
9417
9405
  * @public
9418
9406
  */
9419
- export interface UpdateRuleOutput {
9407
+ export interface RejectChoice {
9420
9408
  /**
9421
- * <p>The ID of the rule.</p>
9409
+ * <p>Specifies the target (for example, a column name) where a prediction can be rejected.</p>
9422
9410
  * @public
9423
9411
  */
9424
- identifier: string | undefined;
9412
+ predictionTarget: string | undefined;
9425
9413
  /**
9426
- * <p>The revision of the rule.</p>
9414
+ * <p>Specifies the the automatically generated business metadata that can be rejected.</p>
9427
9415
  * @public
9428
9416
  */
9429
- revision: string | undefined;
9417
+ predictionChoices?: number[] | undefined;
9418
+ }
9419
+ /**
9420
+ * <p>Specifies the rule and the threshold under which a prediction can be rejected.</p>
9421
+ * @public
9422
+ */
9423
+ export interface RejectRule {
9430
9424
  /**
9431
- * <p>The name of the rule.</p>
9425
+ * <p>Specifies whether you want to reject the top prediction for all targets or none.</p>
9432
9426
  * @public
9433
9427
  */
9434
- name: string | undefined;
9428
+ rule?: RejectRuleBehavior | undefined;
9435
9429
  /**
9436
- * <p>The type of the rule.</p>
9430
+ * <p>The confidence score that specifies the condition at which a prediction can be rejected.</p>
9437
9431
  * @public
9438
9432
  */
9439
- ruleType: RuleType | undefined;
9433
+ threshold?: number | undefined;
9434
+ }
9435
+ /**
9436
+ * @public
9437
+ */
9438
+ export interface RejectPredictionsInput {
9440
9439
  /**
9441
- * <p>The target of the rule.</p>
9440
+ * <p>The identifier of the Amazon DataZone domain.</p>
9442
9441
  * @public
9443
9442
  */
9444
- target: RuleTarget | undefined;
9443
+ domainIdentifier: string | undefined;
9445
9444
  /**
9446
- * <p>The action of the rule.</p>
9445
+ * <p>The identifier of the prediction.</p>
9447
9446
  * @public
9448
9447
  */
9449
- action: RuleAction | undefined;
9448
+ identifier: string | undefined;
9450
9449
  /**
9451
- * <p>The scope of the rule.</p>
9450
+ * <p>The revision that is to be made to the asset.</p>
9452
9451
  * @public
9453
9452
  */
9454
- scope: RuleScope | undefined;
9453
+ revision?: string | undefined;
9455
9454
  /**
9456
- * <p>The detail of the rule.</p>
9455
+ * <p>Specifies the rule (or the conditions) under which a prediction can be rejected.</p>
9457
9456
  * @public
9458
9457
  */
9459
- detail: RuleDetail | undefined;
9458
+ rejectRule?: RejectRule | undefined;
9460
9459
  /**
9461
- * <p>The description of the rule.</p>
9460
+ * <p>Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be rejected.</p>
9462
9461
  * @public
9463
9462
  */
9464
- description?: string | undefined;
9463
+ rejectChoices?: RejectChoice[] | undefined;
9465
9464
  /**
9466
- * <p>The timestamp at which the rule was created.</p>
9465
+ * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
9467
9466
  * @public
9468
9467
  */
9469
- createdAt: Date | undefined;
9468
+ clientToken?: string | undefined;
9469
+ }
9470
+ /**
9471
+ * @public
9472
+ */
9473
+ export interface RejectPredictionsOutput {
9470
9474
  /**
9471
- * <p>The timestamp at which the rule was last updated.</p>
9475
+ * <p>The ID of the Amazon DataZone domain.</p>
9472
9476
  * @public
9473
9477
  */
9474
- updatedAt: Date | undefined;
9478
+ domainId: string | undefined;
9475
9479
  /**
9476
- * <p>The user who created the rule.</p>
9480
+ * <p>The ID of the asset.</p>
9477
9481
  * @public
9478
9482
  */
9479
- createdBy: string | undefined;
9483
+ assetId: string | undefined;
9480
9484
  /**
9481
- * <p>The timestamp at which the rule was last updated.</p>
9485
+ * <p>The revision that is to be made to the asset.</p>
9482
9486
  * @public
9483
9487
  */
9484
- lastUpdatedBy: string | undefined;
9488
+ assetRevision: string | undefined;
9485
9489
  }
9486
9490
  /**
9487
- * <p>The details of the search.</p>
9488
9491
  * @public
9489
9492
  */
9490
- export interface SearchInItem {
9493
+ export interface RejectSubscriptionRequestInput {
9491
9494
  /**
9492
- * <p>The search attribute.</p>
9495
+ * <p>The identifier of the Amazon DataZone domain in which the subscription request was rejected.</p>
9493
9496
  * @public
9494
9497
  */
9495
- attribute: string | undefined;
9496
- }
9497
- /**
9498
- * <p>The details of the way to sort search results.</p>
9499
- * @public
9500
- */
9501
- export interface SearchSort {
9498
+ domainIdentifier: string | undefined;
9502
9499
  /**
9503
- * <p>The attribute detail of the way to sort search results.</p>
9500
+ * <p>The identifier of the subscription request that was rejected.</p>
9504
9501
  * @public
9505
9502
  */
9506
- attribute: string | undefined;
9503
+ identifier: string | undefined;
9507
9504
  /**
9508
- * <p>The order detail of the wya to sort search results.</p>
9505
+ * <p>The decision comment of the rejected subscription request.</p>
9509
9506
  * @public
9510
9507
  */
9511
- order?: SortOrder | undefined;
9508
+ decisionComment?: string | undefined;
9512
9509
  }
9513
9510
  /**
9514
- * <p>The additional attributes of an Amazon DataZone glossary.</p>
9515
9511
  * @public
9516
9512
  */
9517
- export interface GlossaryItemAdditionalAttributes {
9513
+ export interface RejectSubscriptionRequestOutput {
9518
9514
  /**
9519
- * <p>List of rationales indicating why this item was matched by search.</p>
9515
+ * <p>The identifier of the subscription request that was rejected.</p>
9520
9516
  * @public
9521
9517
  */
9522
- matchRationale?: MatchRationaleItem[] | undefined;
9523
- }
9524
- /**
9525
- * <p>The details of a business glossary.</p>
9526
- * @public
9527
- */
9528
- export interface GlossaryItem {
9518
+ id: string | undefined;
9529
9519
  /**
9530
- * <p>The identifier of the Amazon DataZone domain in which the business glossary exists.</p>
9520
+ * <p>The timestamp of when the subscription request was rejected.</p>
9531
9521
  * @public
9532
9522
  */
9533
- domainId: string | undefined;
9523
+ createdBy: string | undefined;
9534
9524
  /**
9535
- * <p>The identifier of the glossary.</p>
9525
+ * <p>The Amazon DataZone user who updated the subscription request.</p>
9536
9526
  * @public
9537
9527
  */
9538
- id: string | undefined;
9528
+ updatedBy?: string | undefined;
9539
9529
  /**
9540
- * <p>The name of the glossary.</p>
9530
+ * <p>The identifier of the Amazon DataZone domain in which the subscription request was rejected.</p>
9541
9531
  * @public
9542
9532
  */
9543
- name: string | undefined;
9533
+ domainId: string | undefined;
9544
9534
  /**
9545
- * <p>The identifier of the project that owns the business glosary.</p>
9535
+ * <p>The status of the subscription request.</p>
9546
9536
  * @public
9547
9537
  */
9548
- owningProjectId: string | undefined;
9538
+ status: SubscriptionRequestStatus | undefined;
9549
9539
  /**
9550
- * <p>The business glossary description.</p>
9540
+ * <p>The timestamp of when the subscription request was rejected.</p>
9551
9541
  * @public
9552
9542
  */
9553
- description?: string | undefined;
9543
+ createdAt: Date | undefined;
9554
9544
  /**
9555
- * <p>The business glossary status.</p>
9545
+ * <p>The timestamp of when the subscription request was updated.</p>
9556
9546
  * @public
9557
9547
  */
9558
- status: GlossaryStatus | undefined;
9548
+ updatedAt: Date | undefined;
9559
9549
  /**
9560
- * <p>The usage restrictions associated with a goverened glossary term.</p>
9550
+ * <p>The reason for the subscription request.</p>
9561
9551
  * @public
9562
9552
  */
9563
- usageRestrictions?: GlossaryUsageRestriction[] | undefined;
9553
+ requestReason: string | undefined;
9564
9554
  /**
9565
- * <p>The timestamp of when the glossary was created.</p>
9555
+ * <p>The subscribed principals of the subscription request.</p>
9566
9556
  * @public
9567
9557
  */
9568
- createdAt?: Date | undefined;
9558
+ subscribedPrincipals: SubscribedPrincipal[] | undefined;
9569
9559
  /**
9570
- * <p>The Amazon DataZone user who created the glossary.</p>
9560
+ * <p>The subscribed listings of the subscription request.</p>
9571
9561
  * @public
9572
9562
  */
9573
- createdBy?: string | undefined;
9563
+ subscribedListings: SubscribedListing[] | undefined;
9574
9564
  /**
9575
- * <p>The timestamp of when the business glossary was updated.</p>
9565
+ * <p>The identifier of the subscription request reviewer.</p>
9576
9566
  * @public
9577
9567
  */
9578
- updatedAt?: Date | undefined;
9568
+ reviewerId?: string | undefined;
9579
9569
  /**
9580
- * <p>The Amazon DataZone user who updated the business glossary.</p>
9570
+ * <p>The decision comment of the rejected subscription request.</p>
9581
9571
  * @public
9582
9572
  */
9583
- updatedBy?: string | undefined;
9573
+ decisionComment?: string | undefined;
9584
9574
  /**
9585
- * <p>The additional attributes of an Amazon DataZone glossary.</p>
9575
+ * <p>The ID of the existing subscription.</p>
9586
9576
  * @public
9587
9577
  */
9588
- additionalAttributes?: GlossaryItemAdditionalAttributes | undefined;
9589
- }
9590
- /**
9591
- * <p>The additional attributes of an Amazon DataZone glossary term.</p>
9592
- * @public
9593
- */
9594
- export interface GlossaryTermItemAdditionalAttributes {
9578
+ existingSubscriptionId?: string | undefined;
9595
9579
  /**
9596
- * <p>List of rationales indicating why this item was matched by search.</p>
9580
+ * <p>Metadata forms included in the subscription request.</p>
9597
9581
  * @public
9598
9582
  */
9599
- matchRationale?: MatchRationaleItem[] | undefined;
9583
+ metadataForms?: FormOutput[] | undefined;
9600
9584
  }
9601
9585
  /**
9602
- * <p>The details of a business glossary term.</p>
9603
9586
  * @public
9604
9587
  */
9605
- export interface GlossaryTermItem {
9606
- /**
9607
- * <p>The identifier of the Amazon DataZone domain in which the business glossary exists.</p>
9608
- * @public
9609
- */
9610
- domainId: string | undefined;
9611
- /**
9612
- * <p>The identifier of the business glossary to which the term belongs.</p>
9613
- * @public
9614
- */
9615
- glossaryId: string | undefined;
9588
+ export interface RemoveEntityOwnerInput {
9616
9589
  /**
9617
- * <p>The identifier of the business glossary term.</p>
9590
+ * <p>The ID of the domain where you want to remove an owner from an entity.</p>
9618
9591
  * @public
9619
9592
  */
9620
- id: string | undefined;
9593
+ domainIdentifier: string | undefined;
9621
9594
  /**
9622
- * <p>The name of the business glossary term.</p>
9595
+ * <p>The type of the entity from which you want to remove an owner.</p>
9623
9596
  * @public
9624
9597
  */
9625
- name: string | undefined;
9598
+ entityType: DataZoneEntityType | undefined;
9626
9599
  /**
9627
- * <p>The short description of the business glossary term.</p>
9600
+ * <p>The ID of the entity from which you want to remove an owner.</p>
9628
9601
  * @public
9629
9602
  */
9630
- shortDescription?: string | undefined;
9603
+ entityIdentifier: string | undefined;
9631
9604
  /**
9632
- * <p>The usage restrictions associated with a goverened glossary term.</p>
9605
+ * <p>The owner that you want to remove from an entity.</p>
9633
9606
  * @public
9634
9607
  */
9635
- usageRestrictions?: GlossaryUsageRestriction[] | undefined;
9608
+ owner: OwnerProperties | undefined;
9636
9609
  /**
9637
- * <p>The long description of the business glossary term.</p>
9610
+ * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
9638
9611
  * @public
9639
9612
  */
9640
- longDescription?: string | undefined;
9613
+ clientToken?: string | undefined;
9614
+ }
9615
+ /**
9616
+ * @public
9617
+ */
9618
+ export interface RemoveEntityOwnerOutput {
9619
+ }
9620
+ /**
9621
+ * @public
9622
+ */
9623
+ export interface RemovePolicyGrantInput {
9641
9624
  /**
9642
- * <p>The relations of the business glossary term.</p>
9625
+ * <p>The ID of the domain where you want to remove a policy grant.</p>
9643
9626
  * @public
9644
9627
  */
9645
- termRelations?: TermRelations | undefined;
9628
+ domainIdentifier: string | undefined;
9646
9629
  /**
9647
- * <p>The status of the business glossary term.</p>
9630
+ * <p>The type of the entity from which you want to remove a policy grant.</p>
9648
9631
  * @public
9649
9632
  */
9650
- status: GlossaryTermStatus | undefined;
9633
+ entityType: TargetEntityType | undefined;
9651
9634
  /**
9652
- * <p>The timestamp of when a business glossary term was created.</p>
9635
+ * <p>The ID of the entity from which you want to remove a policy grant.</p>
9653
9636
  * @public
9654
9637
  */
9655
- createdAt?: Date | undefined;
9638
+ entityIdentifier: string | undefined;
9656
9639
  /**
9657
- * <p>The Amazon DataZone user who created the business glossary.</p>
9640
+ * <p>The type of the policy that you want to remove.</p>
9658
9641
  * @public
9659
9642
  */
9660
- createdBy?: string | undefined;
9643
+ policyType: ManagedPolicyType | undefined;
9661
9644
  /**
9662
- * <p>The timestamp of when a business glossary term was updated.</p>
9645
+ * <p>The principal from which you want to remove a policy grant.</p>
9663
9646
  * @public
9664
9647
  */
9665
- updatedAt?: Date | undefined;
9648
+ principal: PolicyGrantPrincipal | undefined;
9666
9649
  /**
9667
- * <p>The Amazon DataZone user who updated the business glossary term.</p>
9650
+ * <p>The ID of the policy grant that is to be removed from a specified entity.</p>
9668
9651
  * @public
9669
9652
  */
9670
- updatedBy?: string | undefined;
9653
+ grantIdentifier?: string | undefined;
9671
9654
  /**
9672
- * <p>The additional attributes of an Amazon DataZone glossary term.</p>
9655
+ * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
9673
9656
  * @public
9674
9657
  */
9675
- additionalAttributes?: GlossaryTermItemAdditionalAttributes | undefined;
9658
+ clientToken?: string | undefined;
9676
9659
  }