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

Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

Synopsis

Creating a Request

data CreateNotebookInstanceLifecycleConfig Source #

See: newCreateNotebookInstanceLifecycleConfig smart constructor.

Constructors

CreateNotebookInstanceLifecycleConfig'

Fields

onCreate :: Maybe [NotebookInstanceLifecycleHook]
A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
onStart :: Maybe [NotebookInstanceLifecycleHook]
A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.
notebookInstanceLifecycleConfigName :: Text
The name of the lifecycle configuration.

Instances

Instances details

ToJSON CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods toJSON :: CreateNotebookInstanceLifecycleConfig -> Value # toEncoding :: CreateNotebookInstanceLifecycleConfig -> Encoding # toJSONList :: [CreateNotebookInstanceLifecycleConfig] -> Value # toEncodingList :: [CreateNotebookInstanceLifecycleConfig] -> Encoding #
ToHeaders CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods toHeaders :: CreateNotebookInstanceLifecycleConfig -> [Header] #
ToPath CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods toPath :: CreateNotebookInstanceLifecycleConfig -> ByteString #
ToQuery CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods toQuery :: CreateNotebookInstanceLifecycleConfig -> QueryString #
AWSRequest CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Associated Types type AWSResponse CreateNotebookInstanceLifecycleConfig # Methods request :: (Service -> Service) -> CreateNotebookInstanceLifecycleConfig -> Request CreateNotebookInstanceLifecycleConfig # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateNotebookInstanceLifecycleConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateNotebookInstanceLifecycleConfig))) #
Generic CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Associated Types type Rep CreateNotebookInstanceLifecycleConfig :: Type -> Type # Methods from :: CreateNotebookInstanceLifecycleConfig -> Rep CreateNotebookInstanceLifecycleConfig x # to :: Rep CreateNotebookInstanceLifecycleConfig x -> CreateNotebookInstanceLifecycleConfig #
Read CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods readsPrec :: Int -> ReadS CreateNotebookInstanceLifecycleConfig # readList :: ReadS [CreateNotebookInstanceLifecycleConfig] # readPrec :: ReadPrec CreateNotebookInstanceLifecycleConfig # readListPrec :: ReadPrec [CreateNotebookInstanceLifecycleConfig] #
Show CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods showsPrec :: Int -> CreateNotebookInstanceLifecycleConfig -> ShowS # show :: CreateNotebookInstanceLifecycleConfig -> String # showList :: [CreateNotebookInstanceLifecycleConfig] -> ShowS #
NFData CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods rnf :: CreateNotebookInstanceLifecycleConfig -> () #
Eq CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods (==) :: CreateNotebookInstanceLifecycleConfig -> CreateNotebookInstanceLifecycleConfig -> Bool # (/=) :: CreateNotebookInstanceLifecycleConfig -> CreateNotebookInstanceLifecycleConfig -> Bool #
Hashable CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods hashWithSalt :: Int -> CreateNotebookInstanceLifecycleConfig -> Int # hash :: CreateNotebookInstanceLifecycleConfig -> Int #
type AWSResponse CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig type AWSResponse CreateNotebookInstanceLifecycleConfig = CreateNotebookInstanceLifecycleConfigResponse
type Rep CreateNotebookInstanceLifecycleConfig Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig type Rep CreateNotebookInstanceLifecycleConfig = D1 ('MetaData "CreateNotebookInstanceLifecycleConfig" "Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateNotebookInstanceLifecycleConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "onCreate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NotebookInstanceLifecycleHook])) :: (S1 ('MetaSel ('Just "onStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NotebookInstanceLifecycleHook])) :: S1 ('MetaSel ('Just "notebookInstanceLifecycleConfigName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateNotebookInstanceLifecycleConfig Source #

Arguments

:: Text	`CreateNotebookInstanceLifecycleConfig`
-> CreateNotebookInstanceLifecycleConfig

Create a value of CreateNotebookInstanceLifecycleConfig 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:onCreate:CreateNotebookInstanceLifecycleConfig', createNotebookInstanceLifecycleConfig_onCreate - A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

$sel:onStart:CreateNotebookInstanceLifecycleConfig', createNotebookInstanceLifecycleConfig_onStart - A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

CreateNotebookInstanceLifecycleConfig, createNotebookInstanceLifecycleConfig_notebookInstanceLifecycleConfigName - The name of the lifecycle configuration.

Request Lenses

createNotebookInstanceLifecycleConfig_onCreate :: Lens' CreateNotebookInstanceLifecycleConfig (Maybe [NotebookInstanceLifecycleHook]) Source #

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

createNotebookInstanceLifecycleConfig_onStart :: Lens' CreateNotebookInstanceLifecycleConfig (Maybe [NotebookInstanceLifecycleHook]) Source #

A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

createNotebookInstanceLifecycleConfig_notebookInstanceLifecycleConfigName :: Lens' CreateNotebookInstanceLifecycleConfig Text Source #

The name of the lifecycle configuration.

Destructuring the Response

data CreateNotebookInstanceLifecycleConfigResponse Source #

See: newCreateNotebookInstanceLifecycleConfigResponse smart constructor.

Constructors

CreateNotebookInstanceLifecycleConfigResponse'
Fields notebookInstanceLifecycleConfigArn :: Maybe Text The Amazon Resource Name (ARN) of the lifecycle configuration. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateNotebookInstanceLifecycleConfigResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Associated Types type Rep CreateNotebookInstanceLifecycleConfigResponse :: Type -> Type # Methods from :: CreateNotebookInstanceLifecycleConfigResponse -> Rep CreateNotebookInstanceLifecycleConfigResponse x # to :: Rep CreateNotebookInstanceLifecycleConfigResponse x -> CreateNotebookInstanceLifecycleConfigResponse #
Read CreateNotebookInstanceLifecycleConfigResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods readsPrec :: Int -> ReadS CreateNotebookInstanceLifecycleConfigResponse # readList :: ReadS [CreateNotebookInstanceLifecycleConfigResponse] # readPrec :: ReadPrec CreateNotebookInstanceLifecycleConfigResponse # readListPrec :: ReadPrec [CreateNotebookInstanceLifecycleConfigResponse] #
Show CreateNotebookInstanceLifecycleConfigResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods showsPrec :: Int -> CreateNotebookInstanceLifecycleConfigResponse -> ShowS # show :: CreateNotebookInstanceLifecycleConfigResponse -> String # showList :: [CreateNotebookInstanceLifecycleConfigResponse] -> ShowS #
NFData CreateNotebookInstanceLifecycleConfigResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods rnf :: CreateNotebookInstanceLifecycleConfigResponse -> () #
Eq CreateNotebookInstanceLifecycleConfigResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig Methods (==) :: CreateNotebookInstanceLifecycleConfigResponse -> CreateNotebookInstanceLifecycleConfigResponse -> Bool # (/=) :: CreateNotebookInstanceLifecycleConfigResponse -> CreateNotebookInstanceLifecycleConfigResponse -> Bool #
type Rep CreateNotebookInstanceLifecycleConfigResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig type Rep CreateNotebookInstanceLifecycleConfigResponse = D1 ('MetaData "CreateNotebookInstanceLifecycleConfigResponse" "Amazonka.SageMaker.CreateNotebookInstanceLifecycleConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateNotebookInstanceLifecycleConfigResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "notebookInstanceLifecycleConfigArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateNotebookInstanceLifecycleConfigResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateNotebookInstanceLifecycleConfigResponse'`
-> CreateNotebookInstanceLifecycleConfigResponse

Create a value of CreateNotebookInstanceLifecycleConfigResponse 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:

CreateNotebookInstanceLifecycleConfigResponse, createNotebookInstanceLifecycleConfigResponse_notebookInstanceLifecycleConfigArn - The Amazon Resource Name (ARN) of the lifecycle configuration.

$sel:httpStatus:CreateNotebookInstanceLifecycleConfigResponse', createNotebookInstanceLifecycleConfigResponse_httpStatus - The response's http status code.

Response Lenses

createNotebookInstanceLifecycleConfigResponse_notebookInstanceLifecycleConfigArn :: Lens' CreateNotebookInstanceLifecycleConfigResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the lifecycle configuration.

createNotebookInstanceLifecycleConfigResponse_httpStatus :: Lens' CreateNotebookInstanceLifecycleConfigResponse Int Source #

The response's http status code.