Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.
In a CreateNotebookInstance
request, specify the type of ML compute
instance that you want to run. SageMaker launches the instance, installs
common libraries that you can use to explore datasets for model
training, and attaches an ML storage volume to the notebook instance.
SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework.
After receiving the request, SageMaker does the following:
- Creates a network interface in the SageMaker VPC.
- (Option) If you specified
SubnetId
, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC. - Launches an EC2 instance of the type specified in the request in the
SageMaker VPC. If you specified
SubnetId
of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.
After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.
After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models.
For more information, see How It Works.
Synopsis
- data CreateNotebookInstance = CreateNotebookInstance' {
- acceleratorTypes :: Maybe [NotebookInstanceAcceleratorType]
- additionalCodeRepositories :: Maybe [Text]
- defaultCodeRepository :: Maybe Text
- directInternetAccess :: Maybe DirectInternetAccess
- instanceMetadataServiceConfiguration :: Maybe InstanceMetadataServiceConfiguration
- kmsKeyId :: Maybe Text
- lifecycleConfigName :: Maybe Text
- platformIdentifier :: Maybe Text
- rootAccess :: Maybe RootAccess
- securityGroupIds :: Maybe [Text]
- subnetId :: Maybe Text
- tags :: Maybe [Tag]
- volumeSizeInGB :: Maybe Natural
- notebookInstanceName :: Text
- instanceType :: InstanceType
- roleArn :: Text
- newCreateNotebookInstance :: Text -> InstanceType -> Text -> CreateNotebookInstance
- createNotebookInstance_acceleratorTypes :: Lens' CreateNotebookInstance (Maybe [NotebookInstanceAcceleratorType])
- createNotebookInstance_additionalCodeRepositories :: Lens' CreateNotebookInstance (Maybe [Text])
- createNotebookInstance_defaultCodeRepository :: Lens' CreateNotebookInstance (Maybe Text)
- createNotebookInstance_directInternetAccess :: Lens' CreateNotebookInstance (Maybe DirectInternetAccess)
- createNotebookInstance_instanceMetadataServiceConfiguration :: Lens' CreateNotebookInstance (Maybe InstanceMetadataServiceConfiguration)
- createNotebookInstance_kmsKeyId :: Lens' CreateNotebookInstance (Maybe Text)
- createNotebookInstance_lifecycleConfigName :: Lens' CreateNotebookInstance (Maybe Text)
- createNotebookInstance_platformIdentifier :: Lens' CreateNotebookInstance (Maybe Text)
- createNotebookInstance_rootAccess :: Lens' CreateNotebookInstance (Maybe RootAccess)
- createNotebookInstance_securityGroupIds :: Lens' CreateNotebookInstance (Maybe [Text])
- createNotebookInstance_subnetId :: Lens' CreateNotebookInstance (Maybe Text)
- createNotebookInstance_tags :: Lens' CreateNotebookInstance (Maybe [Tag])
- createNotebookInstance_volumeSizeInGB :: Lens' CreateNotebookInstance (Maybe Natural)
- createNotebookInstance_notebookInstanceName :: Lens' CreateNotebookInstance Text
- createNotebookInstance_instanceType :: Lens' CreateNotebookInstance InstanceType
- createNotebookInstance_roleArn :: Lens' CreateNotebookInstance Text
- data CreateNotebookInstanceResponse = CreateNotebookInstanceResponse' {}
- newCreateNotebookInstanceResponse :: Int -> CreateNotebookInstanceResponse
- createNotebookInstanceResponse_notebookInstanceArn :: Lens' CreateNotebookInstanceResponse (Maybe Text)
- createNotebookInstanceResponse_httpStatus :: Lens' CreateNotebookInstanceResponse Int
Creating a Request
data CreateNotebookInstance Source #
See: newCreateNotebookInstance
smart constructor.
CreateNotebookInstance' | |
|
Instances
newCreateNotebookInstance Source #
:: Text | |
-> InstanceType | |
-> Text | |
-> CreateNotebookInstance |
Create a value of CreateNotebookInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceleratorTypes:CreateNotebookInstance'
, createNotebookInstance_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.
CreateNotebookInstance
, createNotebookInstance_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.
CreateNotebookInstance
, createNotebookInstance_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.
$sel:directInternetAccess:CreateNotebookInstance'
, createNotebookInstance_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.
$sel:instanceMetadataServiceConfiguration:CreateNotebookInstance'
, createNotebookInstance_instanceMetadataServiceConfiguration
- Information on the IMDS configuration of the notebook instance
CreateNotebookInstance
, createNotebookInstance_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.
$sel:lifecycleConfigName:CreateNotebookInstance'
, createNotebookInstance_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.
$sel:platformIdentifier:CreateNotebookInstance'
, createNotebookInstance_platformIdentifier
- The platform identifier of the notebook instance runtime environment.
$sel:rootAccess:CreateNotebookInstance'
, createNotebookInstance_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.
CreateNotebookInstance
, createNotebookInstance_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.
$sel:subnetId:CreateNotebookInstance'
, createNotebookInstance_subnetId
- The ID of the subnet in a VPC to which you would like to have a
connectivity from your ML compute instance.
CreateNotebookInstance
, createNotebookInstance_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.
CreateNotebookInstance
, createNotebookInstance_volumeSizeInGB
- The size, in GB, of the ML storage volume to attach to the notebook
instance. The default value is 5 GB.
CreateNotebookInstance
, createNotebookInstance_notebookInstanceName
- The name of the new notebook instance.
CreateNotebookInstance
, createNotebookInstance_instanceType
- The type of ML compute instance to launch for the notebook instance.
CreateNotebookInstance
, createNotebookInstance_roleArn
- 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.
Request Lenses
createNotebookInstance_acceleratorTypes :: Lens' CreateNotebookInstance (Maybe [NotebookInstanceAcceleratorType]) Source #
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.
createNotebookInstance_additionalCodeRepositories :: Lens' CreateNotebookInstance (Maybe [Text]) Source #
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.
createNotebookInstance_defaultCodeRepository :: Lens' CreateNotebookInstance (Maybe Text) Source #
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.
createNotebookInstance_directInternetAccess :: Lens' CreateNotebookInstance (Maybe DirectInternetAccess) Source #
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.
createNotebookInstance_instanceMetadataServiceConfiguration :: Lens' CreateNotebookInstance (Maybe InstanceMetadataServiceConfiguration) Source #
Information on the IMDS configuration of the notebook instance
createNotebookInstance_kmsKeyId :: Lens' CreateNotebookInstance (Maybe Text) Source #
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.
createNotebookInstance_lifecycleConfigName :: Lens' CreateNotebookInstance (Maybe Text) Source #
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.
createNotebookInstance_platformIdentifier :: Lens' CreateNotebookInstance (Maybe Text) Source #
The platform identifier of the notebook instance runtime environment.
createNotebookInstance_rootAccess :: Lens' CreateNotebookInstance (Maybe RootAccess) Source #
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.
createNotebookInstance_securityGroupIds :: Lens' CreateNotebookInstance (Maybe [Text]) Source #
The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
createNotebookInstance_subnetId :: Lens' CreateNotebookInstance (Maybe Text) Source #
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
createNotebookInstance_tags :: Lens' CreateNotebookInstance (Maybe [Tag]) Source #
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.
createNotebookInstance_volumeSizeInGB :: Lens' CreateNotebookInstance (Maybe Natural) Source #
The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
createNotebookInstance_notebookInstanceName :: Lens' CreateNotebookInstance Text Source #
The name of the new notebook instance.
createNotebookInstance_instanceType :: Lens' CreateNotebookInstance InstanceType Source #
The type of ML compute instance to launch for the notebook instance.
createNotebookInstance_roleArn :: Lens' CreateNotebookInstance Text Source #
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.
Destructuring the Response
data CreateNotebookInstanceResponse Source #
See: newCreateNotebookInstanceResponse
smart constructor.
CreateNotebookInstanceResponse' | |
|
Instances
Generic CreateNotebookInstanceResponse Source # | |
Read CreateNotebookInstanceResponse Source # | |
Show CreateNotebookInstanceResponse Source # | |
Defined in Amazonka.SageMaker.CreateNotebookInstance | |
NFData CreateNotebookInstanceResponse Source # | |
Defined in Amazonka.SageMaker.CreateNotebookInstance rnf :: CreateNotebookInstanceResponse -> () # | |
Eq CreateNotebookInstanceResponse Source # | |
type Rep CreateNotebookInstanceResponse Source # | |
Defined in Amazonka.SageMaker.CreateNotebookInstance type Rep CreateNotebookInstanceResponse = D1 ('MetaData "CreateNotebookInstanceResponse" "Amazonka.SageMaker.CreateNotebookInstance" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateNotebookInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "notebookInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateNotebookInstanceResponse Source #
Create a value of CreateNotebookInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateNotebookInstanceResponse
, createNotebookInstanceResponse_notebookInstanceArn
- The Amazon Resource Name (ARN) of the notebook instance.
$sel:httpStatus:CreateNotebookInstanceResponse'
, createNotebookInstanceResponse_httpStatus
- The response's http status code.
Response Lenses
createNotebookInstanceResponse_notebookInstanceArn :: Lens' CreateNotebookInstanceResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the notebook instance.
createNotebookInstanceResponse_httpStatus :: Lens' CreateNotebookInstanceResponse Int Source #
The response's http status code.