Network.AWS.SageMaker.CreateNotebookInstance

Creates an Amazon 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. Amazon 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.

Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use Amazon SageMaker with a specific algorithm or with a machine learning framework.

After receiving the request, Amazon SageMaker does the following:

• Creates a network interface in the Amazon SageMaker VPC.
• (Option) If you specified SubnetId , Amazon 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, Amazon 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 Amazon SageMaker VPC. If you specified SubnetId of your VPC, Amazon 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, Amazon SageMaker returns its Amazon Resource Name (ARN).

After Amazon 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 Amazon SageMaker endpoints, and validate hosted models.

For more information, see How It Works .

Creating a Request

createNotebookInstance

Arguments

:: Text

cniNotebookInstanceName

-> InstanceType

cniInstanceType

-> Text

cniRoleARN

-> CreateNotebookInstance

Creates a value of CreateNotebookInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cniSecurityGroupIds - The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
• cniLifecycleConfigName - The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see 'notebook-lifecycle-config' .
• cniSubnetId - The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
• cniKMSKeyId - If you provide a AWS KMS key ID, Amazon SageMaker uses it to encrypt data at rest on the ML storage volume that is attached to your notebook instance.
• cniDirectInternetAccess - Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your configure a NAT Gateway in your VPC. For more information, see 'appendix-notebook-and-internet-access' . You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.
• cniTags - A list of tags to associate with the notebook instance. You can add tags later by using the CreateTags API.
• cniNotebookInstanceName - The name of the new notebook instance.
• cniInstanceType - The type of ML compute instance to launch for the notebook instance.
• cniRoleARN - When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see Amazon SageMaker Roles .

data CreateNotebookInstance

See: createNotebookInstance smart constructor.

Instances

Eq CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

(==) :: CreateNotebookInstance -> CreateNotebookInstance -> Bool

(/=) :: CreateNotebookInstance -> CreateNotebookInstance -> Bool

Data CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateNotebookInstance -> c CreateNotebookInstance

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateNotebookInstance

toConstr :: CreateNotebookInstance -> Constr

dataTypeOf :: CreateNotebookInstance -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateNotebookInstance)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateNotebookInstance)

gmapT :: (forall b. Data b => b -> b) -> CreateNotebookInstance -> CreateNotebookInstance

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateNotebookInstance -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateNotebookInstance -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateNotebookInstance -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateNotebookInstance -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateNotebookInstance -> m CreateNotebookInstance

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateNotebookInstance -> m CreateNotebookInstance

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateNotebookInstance -> m CreateNotebookInstance

Read CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

readsPrec :: Int -> ReadS CreateNotebookInstance

readList :: ReadS [CreateNotebookInstance]

readPrec :: ReadPrec CreateNotebookInstance

readListPrec :: ReadPrec [CreateNotebookInstance]

Show CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

showsPrec :: Int -> CreateNotebookInstance -> ShowS

show :: CreateNotebookInstance -> String

showList :: [CreateNotebookInstance] -> ShowS

Generic CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Associated Types

type Rep CreateNotebookInstance :: Type -> Type

Methods

from :: CreateNotebookInstance -> Rep CreateNotebookInstance x

to :: Rep CreateNotebookInstance x -> CreateNotebookInstance

Hashable CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

hashWithSalt :: Int -> CreateNotebookInstance -> Int

hash :: CreateNotebookInstance -> Int

ToJSON CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

toJSON :: CreateNotebookInstance -> Value

toEncoding :: CreateNotebookInstance -> Encoding

toJSONList :: [CreateNotebookInstance] -> Value

toEncodingList :: [CreateNotebookInstance] -> Encoding

AWSRequest CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Associated Types

type Rs CreateNotebookInstance :: Type

Methods

request :: CreateNotebookInstance -> Request CreateNotebookInstance

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateNotebookInstance -> ClientResponse -> m (Response CreateNotebookInstance)

ToHeaders CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

toHeaders :: CreateNotebookInstance -> [Header]

ToPath CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

toPath :: CreateNotebookInstance -> ByteString

ToQuery CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

toQuery :: CreateNotebookInstance -> QueryString

NFData CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

rnf :: CreateNotebookInstance -> ()

type Rep CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

type Rep CreateNotebookInstance = D1 (MetaData "CreateNotebookInstance" "Network.AWS.SageMaker.CreateNotebookInstance" "amazonka-sagemaker-1.6.1-KSR3FgWuE9u23bvJsHopKu" False) (C1 (MetaCons "CreateNotebookInstance'" PrefixI True) (((S1 (MetaSel (Just "_cniSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_cniLifecycleConfigName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cniSubnetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cniKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_cniDirectInternetAccess") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DirectInternetAccess)) :*: S1 (MetaSel (Just "_cniTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 (MetaSel (Just "_cniNotebookInstanceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_cniInstanceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 InstanceType) :*: S1 (MetaSel (Just "_cniRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CreateNotebookInstance

Defined in Network.AWS.SageMaker.CreateNotebookInstance

type Rs CreateNotebookInstance = CreateNotebookInstanceResponse

Request Lenses

cniSecurityGroupIds :: Lens' CreateNotebookInstance [Text]

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

cniLifecycleConfigName :: Lens' CreateNotebookInstance (Maybe Text)

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see 'notebook-lifecycle-config' .

cniSubnetId :: Lens' CreateNotebookInstance (Maybe Text)

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

cniKMSKeyId :: Lens' CreateNotebookInstance (Maybe Text)

If you provide a AWS KMS key ID, Amazon SageMaker uses it to encrypt data at rest on the ML storage volume that is attached to your notebook instance.

cniDirectInternetAccess :: Lens' CreateNotebookInstance (Maybe DirectInternetAccess)

Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your configure a NAT Gateway in your VPC. For more information, see 'appendix-notebook-and-internet-access' . You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

cniTags :: Lens' CreateNotebookInstance [Tag]

A list of tags to associate with the notebook instance. You can add tags later by using the CreateTags API.

cniNotebookInstanceName :: Lens' CreateNotebookInstance Text

The name of the new notebook instance.

cniInstanceType :: Lens' CreateNotebookInstance InstanceType

The type of ML compute instance to launch for the notebook instance.

cniRoleARN :: Lens' CreateNotebookInstance Text

When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see Amazon SageMaker Roles .

Destructuring the Response

createNotebookInstanceResponse

Arguments

:: Int

cnirsResponseStatus

-> CreateNotebookInstanceResponse

Creates a value of CreateNotebookInstanceResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cnirsNotebookInstanceARN - The Amazon Resource Name (ARN) of the notebook instance.
• cnirsResponseStatus - -- | The response status code.

data CreateNotebookInstanceResponse

See: createNotebookInstanceResponse smart constructor.

Instances

Eq CreateNotebookInstanceResponse

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

(==) :: CreateNotebookInstanceResponse -> CreateNotebookInstanceResponse -> Bool

(/=) :: CreateNotebookInstanceResponse -> CreateNotebookInstanceResponse -> Bool

Data CreateNotebookInstanceResponse

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateNotebookInstanceResponse -> c CreateNotebookInstanceResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateNotebookInstanceResponse

toConstr :: CreateNotebookInstanceResponse -> Constr

dataTypeOf :: CreateNotebookInstanceResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateNotebookInstanceResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateNotebookInstanceResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateNotebookInstanceResponse -> CreateNotebookInstanceResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateNotebookInstanceResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateNotebookInstanceResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateNotebookInstanceResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateNotebookInstanceResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateNotebookInstanceResponse -> m CreateNotebookInstanceResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateNotebookInstanceResponse -> m CreateNotebookInstanceResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateNotebookInstanceResponse -> m CreateNotebookInstanceResponse

Read CreateNotebookInstanceResponse

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

readsPrec :: Int -> ReadS CreateNotebookInstanceResponse

readList :: ReadS [CreateNotebookInstanceResponse]

readPrec :: ReadPrec CreateNotebookInstanceResponse

readListPrec :: ReadPrec [CreateNotebookInstanceResponse]

Show CreateNotebookInstanceResponse

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

showsPrec :: Int -> CreateNotebookInstanceResponse -> ShowS

show :: CreateNotebookInstanceResponse -> String

showList :: [CreateNotebookInstanceResponse] -> ShowS

Generic CreateNotebookInstanceResponse

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Associated Types

type Rep CreateNotebookInstanceResponse :: Type -> Type

Methods

from :: CreateNotebookInstanceResponse -> Rep CreateNotebookInstanceResponse x

to :: Rep CreateNotebookInstanceResponse x -> CreateNotebookInstanceResponse

NFData CreateNotebookInstanceResponse

Defined in Network.AWS.SageMaker.CreateNotebookInstance

Methods

rnf :: CreateNotebookInstanceResponse -> ()

type Rep CreateNotebookInstanceResponse

Defined in Network.AWS.SageMaker.CreateNotebookInstance

type Rep CreateNotebookInstanceResponse = D1 (MetaData "CreateNotebookInstanceResponse" "Network.AWS.SageMaker.CreateNotebookInstance" "amazonka-sagemaker-1.6.1-KSR3FgWuE9u23bvJsHopKu" False) (C1 (MetaCons "CreateNotebookInstanceResponse'" PrefixI True) (S1 (MetaSel (Just "_cnirsNotebookInstanceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cnirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

cnirsNotebookInstanceARN :: Lens' CreateNotebookInstanceResponse (Maybe Text)

The Amazon Resource Name (ARN) of the notebook instance.

cnirsResponseStatus :: Lens' CreateNotebookInstanceResponse Int

• - | The response status code.