@aws-sdk/client-datazone 3.1038.0 → 3.1040.0

package/dist-types/commands/StartNotebookRunCommand.d.ts

@@ -0,0 +1,184 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient";
+import type { StartNotebookRunInput, StartNotebookRunOutput } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartNotebookRunCommand}.
+ */
+export interface StartNotebookRunCommandInput extends StartNotebookRunInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartNotebookRunCommand}.
+ */
+export interface StartNotebookRunCommandOutput extends StartNotebookRunOutput, __MetadataBearer {
+}
+declare const StartNotebookRunCommand_base: {
+    new (input: StartNotebookRunCommandInput): import("@smithy/smithy-client").CommandImpl<StartNotebookRunCommandInput, StartNotebookRunCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: StartNotebookRunCommandInput): import("@smithy/smithy-client").CommandImpl<StartNotebookRunCommandInput, StartNotebookRunCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Starts a notebook run in an Amazon DataZone domain. A notebook run represents the execution of a Amazon DataZone notebook within a project. You can configure compute, network, timeout, and environment settings for the run.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DataZoneClient, StartNotebookRunCommand } from "@aws-sdk/client-datazone"; // ES Modules import
+ * // const { DataZoneClient, StartNotebookRunCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
+ * // import type { DataZoneClientConfig } from "@aws-sdk/client-datazone";
+ * const config = {}; // type is DataZoneClientConfig
+ * const client = new DataZoneClient(config);
+ * const input = { // StartNotebookRunInput
+ *   domainIdentifier: "STRING_VALUE", // required
+ *   owningProjectIdentifier: "STRING_VALUE", // required
+ *   notebookIdentifier: "STRING_VALUE", // required
+ *   scheduleIdentifier: "STRING_VALUE",
+ *   computeConfiguration: { // ComputeConfig
+ *     instanceType: "STRING_VALUE",
+ *     environmentVersion: "STRING_VALUE",
+ *   },
+ *   networkConfiguration: { // NetworkConfig
+ *     networkAccessType: "PUBLIC_INTERNET_ONLY" || "VPC_ONLY", // required
+ *     vpcId: "STRING_VALUE",
+ *     subnetIds: [ // SubnetIds
+ *       "STRING_VALUE",
+ *     ],
+ *     securityGroupIds: [ // SecurityGroupIds
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   timeoutConfiguration: { // TimeoutConfig
+ *     runTimeoutInMinutes: Number("int"),
+ *   },
+ *   triggerSource: { // TriggerSource
+ *     type: "MANUAL" || "SCHEDULED" || "WORKFLOW",
+ *     name: "STRING_VALUE",
+ *   },
+ *   metadata: { // Metadata
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   parameters: { // Parameters
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new StartNotebookRunCommand(input);
+ * const response = await client.send(command);
+ * // { // StartNotebookRunOutput
+ * //   id: "STRING_VALUE", // required
+ * //   domainId: "STRING_VALUE", // required
+ * //   owningProjectId: "STRING_VALUE", // required
+ * //   notebookId: "STRING_VALUE", // required
+ * //   scheduleId: "STRING_VALUE",
+ * //   status: "QUEUED" || "STARTING" || "RUNNING" || "STOPPING" || "STOPPED" || "SUCCEEDED" || "FAILED", // required
+ * //   cellOrder: [ // CellOrder
+ * //     {},
+ * //   ],
+ * //   metadata: { // Metadata
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * //   parameters: { // Parameters
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * //   computeConfiguration: { // ComputeConfig
+ * //     instanceType: "STRING_VALUE",
+ * //     environmentVersion: "STRING_VALUE",
+ * //   },
+ * //   networkConfiguration: { // NetworkConfig
+ * //     networkAccessType: "PUBLIC_INTERNET_ONLY" || "VPC_ONLY", // required
+ * //     vpcId: "STRING_VALUE",
+ * //     subnetIds: [ // SubnetIds
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     securityGroupIds: [ // SecurityGroupIds
+ * //       "STRING_VALUE",
+ * //     ],
+ * //   },
+ * //   timeoutConfiguration: { // TimeoutConfig
+ * //     runTimeoutInMinutes: Number("int"),
+ * //   },
+ * //   environmentConfiguration: { // EnvironmentConfig
+ * //     imageVersion: "STRING_VALUE",
+ * //     packageConfig: { // PackageConfig
+ * //       packageManager: "UV", // required
+ * //       packageSpecification: "STRING_VALUE",
+ * //     },
+ * //   },
+ * //   storageConfiguration: { // StorageConfig
+ * //     projectS3Path: "STRING_VALUE",
+ * //     kmsKeyArn: "STRING_VALUE",
+ * //   },
+ * //   triggerSource: { // TriggerSource
+ * //     type: "MANUAL" || "SCHEDULED" || "WORKFLOW",
+ * //     name: "STRING_VALUE",
+ * //   },
+ * //   error: { // NotebookRunError
+ * //     message: "STRING_VALUE", // required
+ * //   },
+ * //   createdAt: new Date("TIMESTAMP"),
+ * //   createdBy: "STRING_VALUE",
+ * //   updatedAt: new Date("TIMESTAMP"),
+ * //   updatedBy: "STRING_VALUE",
+ * //   startedAt: new Date("TIMESTAMP"),
+ * //   completedAt: new Date("TIMESTAMP"),
+ * // };
+ *
+ * ```
+ *
+ * @param StartNotebookRunCommandInput - {@link StartNotebookRunCommandInput}
+ * @returns {@link StartNotebookRunCommandOutput}
+ * @see {@link StartNotebookRunCommandInput} for command's `input` shape.
+ * @see {@link StartNotebookRunCommandOutput} for command's `response` shape.
+ * @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>There is a conflict while performing this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request has failed because of an unknown error, exception or failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource cannot be found.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request has exceeded the specified service quota.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *  <p>You do not have permission to perform this action.</p>
+ *
+ * @throws {@link DataZoneServiceException}
+ * <p>Base exception class for all service exceptions from DataZone service.</p>
+ *
+ *
+ * @public
+ */
+export declare class StartNotebookRunCommand extends StartNotebookRunCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartNotebookRunInput;
+            output: StartNotebookRunOutput;
+        };
+        sdk: {
+            input: StartNotebookRunCommandInput;
+            output: StartNotebookRunCommandOutput;
+        };
+    };
+}

package/dist-types/commands/StopNotebookRunCommand.d.ts

@@ -0,0 +1,100 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient";
+import type { StopNotebookRunInput, StopNotebookRunOutput } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StopNotebookRunCommand}.
+ */
+export interface StopNotebookRunCommandInput extends StopNotebookRunInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link StopNotebookRunCommand}.
+ */
+export interface StopNotebookRunCommandOutput extends StopNotebookRunOutput, __MetadataBearer {
+}
+declare const StopNotebookRunCommand_base: {
+    new (input: StopNotebookRunCommandInput): import("@smithy/smithy-client").CommandImpl<StopNotebookRunCommandInput, StopNotebookRunCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: StopNotebookRunCommandInput): import("@smithy/smithy-client").CommandImpl<StopNotebookRunCommandInput, StopNotebookRunCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Stops a running notebook run in an Amazon DataZone domain.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DataZoneClient, StopNotebookRunCommand } from "@aws-sdk/client-datazone"; // ES Modules import
+ * // const { DataZoneClient, StopNotebookRunCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
+ * // import type { DataZoneClientConfig } from "@aws-sdk/client-datazone";
+ * const config = {}; // type is DataZoneClientConfig
+ * const client = new DataZoneClient(config);
+ * const input = { // StopNotebookRunInput
+ *   domainIdentifier: "STRING_VALUE", // required
+ *   identifier: "STRING_VALUE", // required
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new StopNotebookRunCommand(input);
+ * const response = await client.send(command);
+ * // { // StopNotebookRunOutput
+ * //   id: "STRING_VALUE", // required
+ * //   domainId: "STRING_VALUE", // required
+ * //   owningProjectId: "STRING_VALUE", // required
+ * //   status: "QUEUED" || "STARTING" || "RUNNING" || "STOPPING" || "STOPPED" || "SUCCEEDED" || "FAILED", // required
+ * // };
+ *
+ * ```
+ *
+ * @param StopNotebookRunCommandInput - {@link StopNotebookRunCommandInput}
+ * @returns {@link StopNotebookRunCommandOutput}
+ * @see {@link StopNotebookRunCommandInput} for command's `input` shape.
+ * @see {@link StopNotebookRunCommandOutput} for command's `response` shape.
+ * @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>There is a conflict while performing this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request has failed because of an unknown error, exception or failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource cannot be found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *  <p>You do not have permission to perform this action.</p>
+ *
+ * @throws {@link DataZoneServiceException}
+ * <p>Base exception class for all service exceptions from DataZone service.</p>
+ *
+ *
+ * @public
+ */
+export declare class StopNotebookRunCommand extends StopNotebookRunCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StopNotebookRunInput;
+            output: StopNotebookRunOutput;
+        };
+        sdk: {
+            input: StopNotebookRunCommandInput;
+            output: StopNotebookRunCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateRuleCommand.d.ts

@@ -1,7 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import type { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient";
-import type { UpdateRuleInput, UpdateRuleOutput } from "../models/models_1";
+import type { UpdateRuleInput, UpdateRuleOutput } from "../models/models_2";
 /**
  * @public
  */

package/dist-types/commands/index.d.ts

@@ -92,6 +92,7 @@ export * from "./GetLineageEventCommand";
 export * from "./GetLineageNodeCommand";
 export * from "./GetListingCommand";
 export * from "./GetMetadataGenerationRunCommand";
+export * from "./GetNotebookRunCommand";
 export * from "./GetProjectCommand";
 export * from "./GetProjectProfileCommand";
 export * from "./GetRuleCommand";
@@ -122,6 +123,7 @@ export * from "./ListJobRunsCommand";
 export * from "./ListLineageEventsCommand";
 export * from "./ListLineageNodeHistoryCommand";
 export * from "./ListMetadataGenerationRunsCommand";
+export * from "./ListNotebookRunsCommand";
 export * from "./ListNotificationsCommand";
 export * from "./ListPolicyGrantsCommand";
 export * from "./ListProjectMembershipsCommand";
@@ -151,6 +153,8 @@ export * from "./SearchTypesCommand";
 export * from "./SearchUserProfilesCommand";
 export * from "./StartDataSourceRunCommand";
 export * from "./StartMetadataGenerationRunCommand";
+export * from "./StartNotebookRunCommand";
+export * from "./StopNotebookRunCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateAccountPoolCommand";

package/dist-types/models/enums.d.ts

@@ -1245,6 +1245,98 @@ export declare const MetadataGenerationTargetType: {
  * @public
  */
 export type MetadataGenerationTargetType = (typeof MetadataGenerationTargetType)[keyof typeof MetadataGenerationTargetType];
+/**
+ * @public
+ * @enum
+ */
+export declare const PackageManager: {
+    /**
+     * <p>The UV package manager.</p>
+     */
+    readonly UV: "UV";
+};
+/**
+ * @public
+ */
+export type PackageManager = (typeof PackageManager)[keyof typeof PackageManager];
+/**
+ * @public
+ * @enum
+ */
+export declare const NetworkAccessType: {
+    /**
+     * <p>The notebook run uses public internet access only.</p>
+     */
+    readonly PUBLIC_INTERNET_ONLY: "PUBLIC_INTERNET_ONLY";
+    /**
+     * <p>The notebook run uses VPC access only.</p>
+     */
+    readonly VPC_ONLY: "VPC_ONLY";
+};
+/**
+ * @public
+ */
+export type NetworkAccessType = (typeof NetworkAccessType)[keyof typeof NetworkAccessType];
+/**
+ * @public
+ * @enum
+ */
+export declare const NotebookRunStatus: {
+    /**
+     * <p>The notebook run failed.</p>
+     */
+    readonly FAILED: "FAILED";
+    /**
+     * <p>The notebook run is queued.</p>
+     */
+    readonly QUEUED: "QUEUED";
+    /**
+     * <p>The notebook run is running.</p>
+     */
+    readonly RUNNING: "RUNNING";
+    /**
+     * <p>The notebook run is starting.</p>
+     */
+    readonly STARTING: "STARTING";
+    /**
+     * <p>The notebook run was stopped.</p>
+     */
+    readonly STOPPED: "STOPPED";
+    /**
+     * <p>The notebook run is stopping.</p>
+     */
+    readonly STOPPING: "STOPPING";
+    /**
+     * <p>The notebook run succeeded.</p>
+     */
+    readonly SUCCEEDED: "SUCCEEDED";
+};
+/**
+ * @public
+ */
+export type NotebookRunStatus = (typeof NotebookRunStatus)[keyof typeof NotebookRunStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const TriggerSourceType: {
+    /**
+     * <p>The notebook run was triggered manually.</p>
+     */
+    readonly MANUAL: "MANUAL";
+    /**
+     * <p>The notebook run was triggered by a schedule.</p>
+     */
+    readonly SCHEDULED: "SCHEDULED";
+    /**
+     * <p>The notebook run was triggered by a workflow.</p>
+     */
+    readonly WORKFLOW: "WORKFLOW";
+};
+/**
+ * @public
+ */
+export type TriggerSourceType = (typeof TriggerSourceType)[keyof typeof TriggerSourceType];
 /**
  * @public
  * @enum

package/dist-types/models/models_0.d.ts

@@ -4327,6 +4327,12 @@ export interface CancelSubscriptionOutput {
      */
     retainPermissions?: boolean | undefined;
 }
+/**
+ * <p>The information about a cell in a notebook run in Amazon DataZone.</p>
+ * @public
+ */
+export interface CellInformation {
+}
 /**
  * <p>Part of the provisioning properties of the environment blueprint.</p>
  * @public
@@ -4338,6 +4344,22 @@ export interface CloudFormationProperties {
      */
     templateUrl: string | undefined;
 }
+/**
+ * <p>The compute configuration for a notebook run in Amazon DataZone.</p>
+ * @public
+ */
+export interface ComputeConfig {
+    /**
+     * <p>The instance type for the notebook run compute.</p>
+     * @public
+     */
+    instanceType?: string | undefined;
+    /**
+     * <p>The environment version for the notebook run compute.</p>
+     * @public
+     */
+    environmentVersion?: string | undefined;
+}
 /**
  * <p>The details of the parameters for the configurable environment action.</p>
  * @public
@@ -10014,25 +10036,3 @@ export interface SubscribedIamPrincipalInput {
      */
     identifier?: string | undefined;
 }
-/**
- * <p>The project that is to be given a subscription grant.</p>
- * @public
- */
-export interface SubscribedProjectInput {
-    /**
-     * <p>The identifier of the project that is to be given a subscription grant.</p>
-     * @public
-     */
-    identifier?: string | undefined;
-}
-/**
- * <p>The subscribed user.</p>
- * @public
- */
-export interface SubscribedUserInput {
-    /**
-     * <p>The ID of the subscribed user.</p>
-     * @public
-     */
-    identifier?: string | undefined;
-}