{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.SageMaker.CreateApp -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Creates a running app for the specified UserProfile. 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. module Amazonka.SageMaker.CreateApp ( -- * Creating a Request CreateApp (..), newCreateApp, -- * Request Lenses createApp_resourceSpec, createApp_spaceName, createApp_tags, createApp_userProfileName, createApp_domainId, createApp_appType, createApp_appName, -- * Destructuring the Response CreateAppResponse (..), newCreateAppResponse, -- * Response Lenses createAppResponse_appArn, createAppResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response import Amazonka.SageMaker.Types -- | /See:/ 'newCreateApp' smart constructor. data CreateApp = CreateApp' { -- | The instance type and the Amazon Resource Name (ARN) of the SageMaker -- image created on the instance. -- -- The value of @InstanceType@ passed as part of the @ResourceSpec@ in the -- @CreateApp@ call overrides the value passed as part of the -- @ResourceSpec@ configured for the user profile or the domain. If -- @InstanceType@ is not specified in any of those three @ResourceSpec@ -- values for a @KernelGateway@ app, the @CreateApp@ call fails with a -- request validation error. resourceSpec :: Prelude.Maybe ResourceSpec, -- | The name of the space. If this value is not set, then @UserProfileName@ -- must be set. spaceName :: Prelude.Maybe Prelude.Text, -- | Each tag consists of a key and an optional value. Tag keys must be -- unique per resource. tags :: Prelude.Maybe [Tag], -- | The user profile name. If this value is not set, then @SpaceName@ must -- be set. userProfileName :: Prelude.Maybe Prelude.Text, -- | The domain ID. domainId :: Prelude.Text, -- | The type of app. appType :: AppType, -- | The name of the app. appName :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'CreateApp' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'resourceSpec', 'createApp_resourceSpec' - The instance type and the Amazon Resource Name (ARN) of the SageMaker -- image created on the instance. -- -- The value of @InstanceType@ passed as part of the @ResourceSpec@ in the -- @CreateApp@ call overrides the value passed as part of the -- @ResourceSpec@ configured for the user profile or the domain. If -- @InstanceType@ is not specified in any of those three @ResourceSpec@ -- values for a @KernelGateway@ app, the @CreateApp@ call fails with a -- request validation error. -- -- 'spaceName', 'createApp_spaceName' - The name of the space. If this value is not set, then @UserProfileName@ -- must be set. -- -- 'tags', 'createApp_tags' - Each tag consists of a key and an optional value. Tag keys must be -- unique per resource. -- -- 'userProfileName', 'createApp_userProfileName' - The user profile name. If this value is not set, then @SpaceName@ must -- be set. -- -- 'domainId', 'createApp_domainId' - The domain ID. -- -- 'appType', 'createApp_appType' - The type of app. -- -- 'appName', 'createApp_appName' - The name of the app. newCreateApp :: -- | 'domainId' Prelude.Text -> -- | 'appType' AppType -> -- | 'appName' Prelude.Text -> CreateApp newCreateApp pDomainId_ pAppType_ pAppName_ = CreateApp' { resourceSpec = Prelude.Nothing, spaceName = Prelude.Nothing, tags = Prelude.Nothing, userProfileName = Prelude.Nothing, domainId = pDomainId_, appType = pAppType_, appName = pAppName_ } -- | The instance type and the Amazon Resource Name (ARN) of the SageMaker -- image created on the instance. -- -- The value of @InstanceType@ passed as part of the @ResourceSpec@ in the -- @CreateApp@ call overrides the value passed as part of the -- @ResourceSpec@ configured for the user profile or the domain. If -- @InstanceType@ is not specified in any of those three @ResourceSpec@ -- values for a @KernelGateway@ app, the @CreateApp@ call fails with a -- request validation error. createApp_resourceSpec :: Lens.Lens' CreateApp (Prelude.Maybe ResourceSpec) createApp_resourceSpec = Lens.lens (\CreateApp' {resourceSpec} -> resourceSpec) (\s@CreateApp' {} a -> s {resourceSpec = a} :: CreateApp) -- | The name of the space. If this value is not set, then @UserProfileName@ -- must be set. createApp_spaceName :: Lens.Lens' CreateApp (Prelude.Maybe Prelude.Text) createApp_spaceName = Lens.lens (\CreateApp' {spaceName} -> spaceName) (\s@CreateApp' {} a -> s {spaceName = a} :: CreateApp) -- | Each tag consists of a key and an optional value. Tag keys must be -- unique per resource. createApp_tags :: Lens.Lens' CreateApp (Prelude.Maybe [Tag]) createApp_tags = Lens.lens (\CreateApp' {tags} -> tags) (\s@CreateApp' {} a -> s {tags = a} :: CreateApp) Prelude.. Lens.mapping Lens.coerced -- | The user profile name. If this value is not set, then @SpaceName@ must -- be set. createApp_userProfileName :: Lens.Lens' CreateApp (Prelude.Maybe Prelude.Text) createApp_userProfileName = Lens.lens (\CreateApp' {userProfileName} -> userProfileName) (\s@CreateApp' {} a -> s {userProfileName = a} :: CreateApp) -- | The domain ID. createApp_domainId :: Lens.Lens' CreateApp Prelude.Text createApp_domainId = Lens.lens (\CreateApp' {domainId} -> domainId) (\s@CreateApp' {} a -> s {domainId = a} :: CreateApp) -- | The type of app. createApp_appType :: Lens.Lens' CreateApp AppType createApp_appType = Lens.lens (\CreateApp' {appType} -> appType) (\s@CreateApp' {} a -> s {appType = a} :: CreateApp) -- | The name of the app. createApp_appName :: Lens.Lens' CreateApp Prelude.Text createApp_appName = Lens.lens (\CreateApp' {appName} -> appName) (\s@CreateApp' {} a -> s {appName = a} :: CreateApp) instance Core.AWSRequest CreateApp where type AWSResponse CreateApp = CreateAppResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> CreateAppResponse' Prelude.<$> (x Data..?> "AppArn") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable CreateApp where hashWithSalt _salt CreateApp' {..} = _salt `Prelude.hashWithSalt` resourceSpec `Prelude.hashWithSalt` spaceName `Prelude.hashWithSalt` tags `Prelude.hashWithSalt` userProfileName `Prelude.hashWithSalt` domainId `Prelude.hashWithSalt` appType `Prelude.hashWithSalt` appName instance Prelude.NFData CreateApp where rnf CreateApp' {..} = Prelude.rnf resourceSpec `Prelude.seq` Prelude.rnf spaceName `Prelude.seq` Prelude.rnf tags `Prelude.seq` Prelude.rnf userProfileName `Prelude.seq` Prelude.rnf domainId `Prelude.seq` Prelude.rnf appType `Prelude.seq` Prelude.rnf appName instance Data.ToHeaders CreateApp where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ("SageMaker.CreateApp" :: Prelude.ByteString), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON CreateApp where toJSON CreateApp' {..} = Data.object ( Prelude.catMaybes [ ("ResourceSpec" Data..=) Prelude.<$> resourceSpec, ("SpaceName" Data..=) Prelude.<$> spaceName, ("Tags" Data..=) Prelude.<$> tags, ("UserProfileName" Data..=) Prelude.<$> userProfileName, Prelude.Just ("DomainId" Data..= domainId), Prelude.Just ("AppType" Data..= appType), Prelude.Just ("AppName" Data..= appName) ] ) instance Data.ToPath CreateApp where toPath = Prelude.const "/" instance Data.ToQuery CreateApp where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newCreateAppResponse' smart constructor. data CreateAppResponse = CreateAppResponse' { -- | The Amazon Resource Name (ARN) of the app. appArn :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'CreateAppResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'appArn', 'createAppResponse_appArn' - The Amazon Resource Name (ARN) of the app. -- -- 'httpStatus', 'createAppResponse_httpStatus' - The response's http status code. newCreateAppResponse :: -- | 'httpStatus' Prelude.Int -> CreateAppResponse newCreateAppResponse pHttpStatus_ = CreateAppResponse' { appArn = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | The Amazon Resource Name (ARN) of the app. createAppResponse_appArn :: Lens.Lens' CreateAppResponse (Prelude.Maybe Prelude.Text) createAppResponse_appArn = Lens.lens (\CreateAppResponse' {appArn} -> appArn) (\s@CreateAppResponse' {} a -> s {appArn = a} :: CreateAppResponse) -- | The response's http status code. createAppResponse_httpStatus :: Lens.Lens' CreateAppResponse Prelude.Int createAppResponse_httpStatus = Lens.lens (\CreateAppResponse' {httpStatus} -> httpStatus) (\s@CreateAppResponse' {} a -> s {httpStatus = a} :: CreateAppResponse) instance Prelude.NFData CreateAppResponse where rnf CreateAppResponse' {..} = Prelude.rnf appArn `Prelude.seq` Prelude.rnf httpStatus