sagemaker_create_notebook_instance: Creates an SageMaker notebook instance
In paws.machine.learning: 'Amazon Web Services' Machine Learning Services

sagemaker_create_notebook_instance

R Documentation

Creates an SageMaker notebook instance

Description

Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

See https://www.paws-r-sdk.com/docs/sagemaker_create_notebook_instance/ for full documentation.

Usage

sagemaker_create_notebook_instance(
  NotebookInstanceName,
  InstanceType,
  SubnetId = NULL,
  SecurityGroupIds = NULL,
  RoleArn,
  KmsKeyId = NULL,
  Tags = NULL,
  LifecycleConfigName = NULL,
  DirectInternetAccess = NULL,
  VolumeSizeInGB = NULL,
  AcceleratorTypes = NULL,
  DefaultCodeRepository = NULL,
  AdditionalCodeRepositories = NULL,
  RootAccess = NULL,
  PlatformIdentifier = NULL,
  InstanceMetadataServiceConfiguration = NULL
)

Arguments

`NotebookInstanceName`	[required] The name of the new notebook instance.
`InstanceType`	[required] The type of ML compute instance to launch for the notebook instance.
`SubnetId`	The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
`SecurityGroupIds`	The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
`RoleArn`	[required] When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker Roles. To be able to pass this role to SageMaker, the caller of this API must have the `iam:PassRole` permission.
`KmsKeyId`	The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.
`Tags`	An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
`LifecycleConfigName`	The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
`DirectInternetAccess`	Sets whether SageMaker provides internet access to the notebook instance. If you set this to `Disabled` this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a NAT Gateway in your VPC. For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to `Disabled` only if you set a value for the `SubnetId` parameter.
`VolumeSizeInGB`	The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
`AcceleratorTypes`	A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
`DefaultCodeRepository`	A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
`AdditionalCodeRepositories`	An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
`RootAccess`	Whether root access is enabled or disabled for users of the notebook instance. The default value is `Enabled`. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
`PlatformIdentifier`	The platform identifier of the notebook instance runtime environment.
`InstanceMetadataServiceConfiguration`	Information on the IMDS configuration of the notebook instance