libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.CreateApp

Description

Creates a running app for the specified UserProfile. Supported apps are JupyterServer and KernelGateway. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

Synopsis

Creating a Request

data CreateApp Source #

See: newCreateApp smart constructor.

Constructors

CreateApp' 

Fields

Instances

Instances details
Eq CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

Read CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

Show CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

Generic CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

Associated Types

type Rep CreateApp :: Type -> Type #

NFData CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

Methods

rnf :: CreateApp -> () #

Hashable CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

ToJSON CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

AWSRequest CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

Associated Types

type AWSResponse CreateApp #

ToHeaders CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

Methods

toHeaders :: CreateApp -> [Header] #

ToPath CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

ToQuery CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

type Rep CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

type Rep CreateApp = D1 ('MetaData "CreateApp" "Amazonka.SageMaker.CreateApp" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreateApp'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourceSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceSpec)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "userProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "appType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AppType) :*: S1 ('MetaSel ('Just "appName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateApp Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

newCreateApp Source #

Create a value of CreateApp 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:resourceSpec:CreateApp', createApp_resourceSpec - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

$sel:tags:CreateApp', createApp_tags - Each tag consists of a key and an optional value. Tag keys must be unique per resource.

$sel:domainId:CreateApp', createApp_domainId - The domain ID.

$sel:userProfileName:CreateApp', createApp_userProfileName - The user profile name.

$sel:appType:CreateApp', createApp_appType - The type of app. Supported apps are JupyterServer and KernelGateway. TensorBoard is not supported.

$sel:appName:CreateApp', createApp_appName - The name of the app.

Request Lenses

createApp_resourceSpec :: Lens' CreateApp (Maybe ResourceSpec) Source #

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

createApp_tags :: Lens' CreateApp (Maybe [Tag]) Source #

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

createApp_appType :: Lens' CreateApp AppType Source #

The type of app. Supported apps are JupyterServer and KernelGateway. TensorBoard is not supported.

createApp_appName :: Lens' CreateApp Text Source #

The name of the app.

Destructuring the Response

data CreateAppResponse Source #

See: newCreateAppResponse smart constructor.

Constructors

CreateAppResponse' 

Fields

Instances

Instances details
Eq CreateAppResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

Read CreateAppResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

Show CreateAppResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

Generic CreateAppResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

Associated Types

type Rep CreateAppResponse :: Type -> Type #

NFData CreateAppResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

Methods

rnf :: CreateAppResponse -> () #

type Rep CreateAppResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateApp

type Rep CreateAppResponse = D1 ('MetaData "CreateAppResponse" "Amazonka.SageMaker.CreateApp" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreateAppResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "appArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateAppResponse Source #

Create a value of CreateAppResponse 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:appArn:CreateAppResponse', createAppResponse_appArn - The Amazon Resource Name (ARN) of the app.

$sel:httpStatus:CreateAppResponse', createAppResponse_httpStatus - The response's http status code.

Response Lenses

createAppResponse_appArn :: Lens' CreateAppResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the app.

createAppResponse_httpStatus :: Lens' CreateAppResponse Int Source #

The response's http status code.