Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.CreateApp

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data CreateApp = CreateApp' {
- resourceSpec :: Maybe ResourceSpec
- tags :: Maybe [Tag]
- domainId :: Text
- userProfileName :: Text
- appType :: AppType
- appName :: Text
}
newCreateApp :: Text -> Text -> AppType -> Text -> CreateApp
createApp_resourceSpec :: Lens' CreateApp (Maybe ResourceSpec)
createApp_tags :: Lens' CreateApp (Maybe [Tag])
createApp_domainId :: Lens' CreateApp Text
createApp_userProfileName :: Lens' CreateApp Text
createApp_appType :: Lens' CreateApp AppType
createApp_appName :: Lens' CreateApp Text
data CreateAppResponse = CreateAppResponse' {
- appArn :: Maybe Text
- httpStatus :: Int
}
newCreateAppResponse :: Int -> CreateAppResponse
createAppResponse_appArn :: Lens' CreateAppResponse (Maybe Text)
createAppResponse_httpStatus :: Lens' CreateAppResponse Int

Creating a Request

data CreateApp Source #

See: newCreateApp smart constructor.

Constructors

CreateApp'

Fields

resourceSpec :: Maybe ResourceSpec
The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
tags :: Maybe [Tag]
Each tag consists of a key and an optional value. Tag keys must be unique per resource.
domainId :: Text
The domain ID.
userProfileName :: Text
The user profile name.
appType :: AppType
The type of app. Supported apps are JupyterServer and KernelGateway. TensorBoard is not supported.
appName :: Text
The name of the app.

Instances

Instances details

Eq CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods (==) :: CreateApp -> CreateApp -> Bool # (/=) :: CreateApp -> CreateApp -> Bool #
Read CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods readsPrec :: Int -> ReadS CreateApp # readList :: ReadS [CreateApp] # readPrec :: ReadPrec CreateApp # readListPrec :: ReadPrec [CreateApp] #
Show CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods showsPrec :: Int -> CreateApp -> ShowS # show :: CreateApp -> String # showList :: [CreateApp] -> ShowS #
Generic CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Associated Types type Rep CreateApp :: Type -> Type # Methods from :: CreateApp -> Rep CreateApp x # to :: Rep CreateApp x -> CreateApp #
NFData CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods rnf :: CreateApp -> () #
Hashable CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods hashWithSalt :: Int -> CreateApp -> Int # hash :: CreateApp -> Int #
ToJSON CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods toJSON :: CreateApp -> Value # toEncoding :: CreateApp -> Encoding # toJSONList :: [CreateApp] -> Value # toEncodingList :: [CreateApp] -> Encoding #
AWSRequest CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Associated Types type AWSResponse CreateApp # Methods request :: CreateApp -> Request CreateApp # response :: MonadResource m => Logger -> Service -> Proxy CreateApp -> ClientResponse ClientBody -> m (Either Error (ClientResponse (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 Methods toPath :: CreateApp -> ByteString #
ToQuery CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods toQuery :: CreateApp -> QueryString #
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 type AWSResponse CreateApp = CreateAppResponse

newCreateApp Source #

Arguments

:: Text	`$sel:domainId:CreateApp'`
-> Text	`$sel:userProfileName:CreateApp'`
-> AppType	`$sel:appType:CreateApp'`
-> Text	`$sel:appName:CreateApp'`
-> CreateApp

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_domainId :: Lens' CreateApp Text Source #

The domain ID.

createApp_userProfileName :: Lens' CreateApp Text Source #

The user profile name.

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 appArn :: Maybe Text The Amazon Resource Name (ARN) of the app. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateAppResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods (==) :: CreateAppResponse -> CreateAppResponse -> Bool # (/=) :: CreateAppResponse -> CreateAppResponse -> Bool #
Read CreateAppResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods readsPrec :: Int -> ReadS CreateAppResponse # readList :: ReadS [CreateAppResponse] # readPrec :: ReadPrec CreateAppResponse # readListPrec :: ReadPrec [CreateAppResponse] #
Show CreateAppResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods showsPrec :: Int -> CreateAppResponse -> ShowS # show :: CreateAppResponse -> String # showList :: [CreateAppResponse] -> ShowS #
Generic CreateAppResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Associated Types type Rep CreateAppResponse :: Type -> Type # Methods from :: CreateAppResponse -> Rep CreateAppResponse x # to :: Rep CreateAppResponse x -> CreateAppResponse #
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 #

Arguments

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

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.