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 { 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/core/client").CommandImpl; new (input: StartNotebookRunCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Starts a notebook run in Amazon SageMaker Unified Studio. A notebook run represents the execution of an Amazon SageMaker notebook within a project. You can configure compute, network, timeout, and environment settings for the run.

* @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 * "": "STRING_VALUE", * }, * parameters: { // Parameters * "": "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 * // "": "STRING_VALUE", * // }, * // parameters: { // Parameters * // "": "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) *

You do not have sufficient access to perform this action.

* * @throws {@link ConflictException} (client fault) *

There is a conflict while performing this action.

* * @throws {@link InternalServerException} (server fault) *

The request has failed because of an unknown error, exception or failure.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified resource cannot be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) *

The request has exceeded the specified service quota.

* * @throws {@link ThrottlingException} (client fault) *

The request was denied due to request throttling.

* * @throws {@link ValidationException} (client fault) *

The input fails to satisfy the constraints specified by the Amazon Web Services service.

* * @throws {@link UnauthorizedException} (client fault) *

You do not have permission to perform this action.

* * @throws {@link DataZoneServiceException} *

Base exception class for all service exceptions from DataZone service.

* * * @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; }; }; }