AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon DataZone StartNotebookRun API operation.

Syntax

Start-DZNotebookRun
-DomainIdentifier <String>
-ComputeConfiguration_EnvironmentVersion <String>
-ComputeConfiguration_InstanceType <String>
-Metadata <Hashtable>
-TriggerSource_Name <String>
-NetworkConfiguration_NetworkAccessType <NetworkAccessType>
-NotebookIdentifier <String>
-OwningProjectIdentifier <String>
-Parameter <Hashtable>
-TimeoutConfiguration_RunTimeoutInMinute <Int32>
-ScheduleIdentifier <String>
-NetworkConfiguration_SecurityGroupId <String[]>
-NetworkConfiguration_SubnetId <String[]>
-TriggerSource_Type <TriggerSourceType>
-NetworkConfiguration_VpcId <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonDataZoneConfig>

Description

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.

Parameters

-ClientConfig <AmazonDataZoneConfig>
Amazon.PowerShell.Cmdlets.DZ.AmazonDataZoneClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_EnvironmentVersion <String>
The environment version for the notebook run compute.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_InstanceType <String>
The instance type for the notebook run compute.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainIdentifier <String>
The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run is started.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Metadata <Hashtable>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkConfiguration_NetworkAccessType <NetworkAccessType>
The network access type for the notebook run. Valid values are PUBLIC_INTERNET_ONLY and VPC_ONLY.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkConfiguration_SecurityGroupId <String[]>
The identifiers of the security groups for the notebook run. You can specify up to 5 security groups. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_SecurityGroupIds
-NetworkConfiguration_SubnetId <String[]>
The identifiers of the subnets for the notebook run. You can specify up to 10 subnets. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_SubnetIds
-NetworkConfiguration_VpcId <String>
The identifier of the VPC for the notebook run. This is required when the network access type is VPC_ONLY.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NotebookIdentifier <String>
The identifier of the notebook to run.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OwningProjectIdentifier <String>
The identifier of the project that owns the notebook run.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Parameter <Hashtable>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters
-ScheduleIdentifier <String>
The identifier of the schedule associated with the notebook run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataZone.Model.StartNotebookRunResponse). Specifying the name of a property of type Amazon.DataZone.Model.StartNotebookRunResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimeoutConfiguration_RunTimeoutInMinute <Int32>
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).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTimeoutConfiguration_RunTimeoutInMinutes
-TriggerSource_Name <String>
The name of the trigger source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TriggerSource_Type <TriggerSourceType>
The type of the trigger source. Valid values are MANUAL, SCHEDULED, and WORKFLOW.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.DataZone.Model.StartNotebookRunResponse
This cmdlet returns an Amazon.DataZone.Model.StartNotebookRunResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z