@aws-sdk/client-datazone 3.1046.0 → 3.1048.0

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

@@ -0,0 +1,117 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient";
+import type { StartNotebookImportInput, StartNotebookImportOutput } from "../models/models_2";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartNotebookImportCommand}.
+ */
+export interface StartNotebookImportCommandInput extends StartNotebookImportInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartNotebookImportCommand}.
+ */
+export interface StartNotebookImportCommandOutput extends StartNotebookImportOutput, __MetadataBearer {
+}
+declare const StartNotebookImportCommand_base: {
+    new (input: StartNotebookImportCommandInput): import("@smithy/core/client").CommandImpl<StartNotebookImportCommandInput, StartNotebookImportCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: StartNotebookImportCommandInput): import("@smithy/core/client").CommandImpl<StartNotebookImportCommandInput, StartNotebookImportCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Starts a notebook import in Amazon SageMaker Unified Studio. This operation imports a notebook from an Amazon Simple Storage Service location into a project.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DataZoneClient, StartNotebookImportCommand } from "@aws-sdk/client-datazone"; // ES Modules import
+ * // const { DataZoneClient, StartNotebookImportCommand } = 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 = { // StartNotebookImportInput
+ *   domainIdentifier: "STRING_VALUE", // required
+ *   owningProjectIdentifier: "STRING_VALUE", // required
+ *   sourceLocation: { // SourceLocation Union: only one key present
+ *     s3: "STRING_VALUE",
+ *   },
+ *   name: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new StartNotebookImportCommand(input);
+ * const response = await client.send(command);
+ * // { // StartNotebookImportOutput
+ * //   notebookId: "STRING_VALUE",
+ * //   status: "ACTIVE" || "ARCHIVED",
+ * //   domainId: "STRING_VALUE",
+ * //   owningProjectId: "STRING_VALUE",
+ * //   name: "STRING_VALUE",
+ * //   description: "STRING_VALUE",
+ * //   sourceLocation: { // SourceLocation Union: only one key present
+ * //     s3: "STRING_VALUE",
+ * //   },
+ * //   createdAt: new Date("TIMESTAMP"),
+ * //   createdBy: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param StartNotebookImportCommandInput - {@link StartNotebookImportCommandInput}
+ * @returns {@link StartNotebookImportCommandOutput}
+ * @see {@link StartNotebookImportCommandInput} for command's `input` shape.
+ * @see {@link StartNotebookImportCommandOutput} 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 StartNotebookImportCommand extends StartNotebookImportCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartNotebookImportInput;
+            output: StartNotebookImportOutput;
+        };
+        sdk: {
+            input: StartNotebookImportCommandInput;
+            output: StartNotebookImportCommandOutput;
+        };
+    };
+}

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

@@ -29,7 +29,7 @@ declare const StartNotebookRunCommand_base: {
     };
 };
 /**
- * <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>
+ * <p>Starts a notebook run in Amazon SageMaker Unified Studio. A notebook run represents the execution of an <a href="https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html">Amazon SageMaker notebook</a> 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

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

@@ -29,7 +29,7 @@ declare const StopNotebookRunCommand_base: {
     };
 };
 /**
- * <p>Stops a running notebook run in an Amazon DataZone domain.</p>
+ * <p>Stops a running <a href="https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html">notebook run</a> in Amazon SageMaker Unified Studio.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -0,0 +1,150 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient";
+import type { UpdateNotebookInput, UpdateNotebookOutput } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateNotebookCommand}.
+ */
+export interface UpdateNotebookCommandInput extends UpdateNotebookInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateNotebookCommand}.
+ */
+export interface UpdateNotebookCommandOutput extends UpdateNotebookOutput, __MetadataBearer {
+}
+declare const UpdateNotebookCommand_base: {
+    new (input: UpdateNotebookCommandInput): import("@smithy/core/client").CommandImpl<UpdateNotebookCommandInput, UpdateNotebookCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateNotebookCommandInput): import("@smithy/core/client").CommandImpl<UpdateNotebookCommandInput, UpdateNotebookCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Updates a <a href="https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html">notebook</a> in Amazon SageMaker Unified Studio.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DataZoneClient, UpdateNotebookCommand } from "@aws-sdk/client-datazone"; // ES Modules import
+ * // const { DataZoneClient, UpdateNotebookCommand } = 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 = { // UpdateNotebookInput
+ *   domainIdentifier: "STRING_VALUE", // required
+ *   identifier: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   status: "ACTIVE" || "ARCHIVED",
+ *   name: "STRING_VALUE",
+ *   cellOrder: [ // CellOrder
+ *     {},
+ *   ],
+ *   metadata: { // Metadata
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   parameters: { // Parameters
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   environmentConfiguration: { // EnvironmentConfig
+ *     imageVersion: "STRING_VALUE",
+ *     packageConfig: { // PackageConfig
+ *       packageManager: "UV", // required
+ *       packageSpecification: "STRING_VALUE",
+ *     },
+ *   },
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new UpdateNotebookCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateNotebookOutput
+ * //   id: "STRING_VALUE", // required
+ * //   name: "STRING_VALUE", // required
+ * //   owningProjectId: "STRING_VALUE", // required
+ * //   domainId: "STRING_VALUE", // required
+ * //   cellOrder: [ // CellOrder // required
+ * //     {},
+ * //   ],
+ * //   status: "ACTIVE" || "ARCHIVED", // required
+ * //   description: "STRING_VALUE",
+ * //   createdAt: new Date("TIMESTAMP"),
+ * //   createdBy: "STRING_VALUE",
+ * //   updatedAt: new Date("TIMESTAMP"),
+ * //   updatedBy: "STRING_VALUE",
+ * //   lockedBy: "STRING_VALUE",
+ * //   lockedAt: new Date("TIMESTAMP"),
+ * //   lockExpiresAt: new Date("TIMESTAMP"),
+ * //   computeId: "STRING_VALUE",
+ * //   metadata: { // Metadata
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * //   parameters: { // Parameters
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * //   environmentConfiguration: { // EnvironmentConfig
+ * //     imageVersion: "STRING_VALUE",
+ * //     packageConfig: { // PackageConfig
+ * //       packageManager: "UV", // required
+ * //       packageSpecification: "STRING_VALUE",
+ * //     },
+ * //   },
+ * //   error: { // NotebookError
+ * //     message: "STRING_VALUE", // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateNotebookCommandInput - {@link UpdateNotebookCommandInput}
+ * @returns {@link UpdateNotebookCommandOutput}
+ * @see {@link UpdateNotebookCommandInput} for command's `input` shape.
+ * @see {@link UpdateNotebookCommandOutput} 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 UpdateNotebookCommand extends UpdateNotebookCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateNotebookInput;
+            output: UpdateNotebookOutput;
+        };
+        sdk: {
+            input: UpdateNotebookCommandInput;
+            output: UpdateNotebookCommandOutput;
+        };
+    };
+}

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

@@ -28,6 +28,7 @@ export * from "./CreateGlossaryCommand";
 export * from "./CreateGlossaryTermCommand";
 export * from "./CreateGroupProfileCommand";
 export * from "./CreateListingChangeSetCommand";
+export * from "./CreateNotebookCommand";
 export * from "./CreateProjectCommand";
 export * from "./CreateProjectMembershipCommand";
 export * from "./CreateProjectProfileCommand";
@@ -55,6 +56,7 @@ export * from "./DeleteFormTypeCommand";
 export * from "./DeleteGlossaryCommand";
 export * from "./DeleteGlossaryTermCommand";
 export * from "./DeleteListingCommand";
+export * from "./DeleteNotebookCommand";
 export * from "./DeleteProjectCommand";
 export * from "./DeleteProjectMembershipCommand";
 export * from "./DeleteProjectProfileCommand";
@@ -92,6 +94,8 @@ export * from "./GetLineageEventCommand";
 export * from "./GetLineageNodeCommand";
 export * from "./GetListingCommand";
 export * from "./GetMetadataGenerationRunCommand";
+export * from "./GetNotebookCommand";
+export * from "./GetNotebookExportCommand";
 export * from "./GetNotebookRunCommand";
 export * from "./GetProjectCommand";
 export * from "./GetProjectProfileCommand";
@@ -124,6 +128,7 @@ export * from "./ListLineageEventsCommand";
 export * from "./ListLineageNodeHistoryCommand";
 export * from "./ListMetadataGenerationRunsCommand";
 export * from "./ListNotebookRunsCommand";
+export * from "./ListNotebooksCommand";
 export * from "./ListNotificationsCommand";
 export * from "./ListPolicyGrantsCommand";
 export * from "./ListProjectMembershipsCommand";
@@ -153,6 +158,8 @@ export * from "./SearchTypesCommand";
 export * from "./SearchUserProfilesCommand";
 export * from "./StartDataSourceRunCommand";
 export * from "./StartMetadataGenerationRunCommand";
+export * from "./StartNotebookExportCommand";
+export * from "./StartNotebookImportCommand";
 export * from "./StartNotebookRunCommand";
 export * from "./StopNotebookRunCommand";
 export * from "./TagResourceCommand";
@@ -170,6 +177,7 @@ export * from "./UpdateEnvironmentProfileCommand";
 export * from "./UpdateGlossaryCommand";
 export * from "./UpdateGlossaryTermCommand";
 export * from "./UpdateGroupProfileCommand";
+export * from "./UpdateNotebookCommand";
 export * from "./UpdateProjectCommand";
 export * from "./UpdateProjectProfileCommand";
 export * from "./UpdateRootDomainUnitOwnerCommand";

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

@@ -738,6 +738,38 @@ export declare const EntityType: {
  * @public
  */
 export type EntityType = (typeof EntityType)[keyof typeof EntityType];
+/**
+ * @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 NotebookStatus: {
+    /**
+     * <p>The notebook is active.</p>
+     */
+    readonly ACTIVE: "ACTIVE";
+    /**
+     * <p>The notebook is archived.</p>
+     */
+    readonly ARCHIVED: "ARCHIVED";
+};
+/**
+ * @public
+ */
+export type NotebookStatus = (typeof NotebookStatus)[keyof typeof NotebookStatus];
 /**
  * @public
  * @enum
@@ -1249,16 +1281,42 @@ export type MetadataGenerationTargetType = (typeof MetadataGenerationTargetType)
  * @public
  * @enum
  */
-export declare const PackageManager: {
+export declare const FileFormat: {
     /**
-     * <p>The UV package manager.</p>
+     * <p>Export the notebook as a Jupyter notebook (.ipynb) file.</p>
      */
-    readonly UV: "UV";
+    readonly IPYNB: "IPYNB";
+    /**
+     * <p>Export the notebook as a PDF file.</p>
+     */
+    readonly PDF: "PDF";
 };
 /**
  * @public
  */
-export type PackageManager = (typeof PackageManager)[keyof typeof PackageManager];
+export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat];
+/**
+ * @public
+ * @enum
+ */
+export declare const NotebookExportStatus: {
+    /**
+     * <p>The notebook export failed.</p>
+     */
+    readonly FAILED: "FAILED";
+    /**
+     * <p>The notebook export is in progress.</p>
+     */
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    /**
+     * <p>The notebook export succeeded.</p>
+     */
+    readonly SUCCEEDED: "SUCCEEDED";
+};
+/**
+ * @public
+ */
+export type NotebookExportStatus = (typeof NotebookExportStatus)[keyof typeof NotebookExportStatus];
 /**
  * @public
  * @enum