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.CreateApp

Contents

Description

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.

Synopsis

data CreateApp = CreateApp' {
- resourceSpec :: Maybe ResourceSpec
- spaceName :: Maybe Text
- tags :: Maybe [Tag]
- userProfileName :: Maybe Text
- domainId :: Text
- appType :: AppType
- appName :: Text
}
newCreateApp :: Text -> AppType -> Text -> CreateApp
createApp_resourceSpec :: Lens' CreateApp (Maybe ResourceSpec)
createApp_spaceName :: Lens' CreateApp (Maybe Text)
createApp_tags :: Lens' CreateApp (Maybe [Tag])
createApp_userProfileName :: Lens' CreateApp (Maybe Text)
createApp_domainId :: 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.
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 :: Maybe Text
The name of the space. If this value is not set, then UserProfileName must be set.
tags :: Maybe [Tag]
Each tag consists of a key and an optional value. Tag keys must be unique per resource.
userProfileName :: Maybe Text
The user profile name. If this value is not set, then SpaceName must be set.
domainId :: Text
The domain ID.
appType :: AppType
The type of app.
appName :: Text
The name of the app.

Instances

Instances details

ToJSON CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods toJSON :: CreateApp -> Value # toEncoding :: CreateApp -> Encoding # toJSONList :: [CreateApp] -> Value # toEncodingList :: [CreateApp] -> Encoding #
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 #
AWSRequest CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Associated Types type AWSResponse CreateApp # Methods request :: (Service -> Service) -> CreateApp -> Request CreateApp # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateApp -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateApp))) #
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 #
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 #
NFData CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods rnf :: CreateApp -> () #
Eq CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods (==) :: CreateApp -> CreateApp -> Bool # (/=) :: CreateApp -> CreateApp -> Bool #
Hashable CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods hashWithSalt :: Int -> CreateApp -> Int # hash :: CreateApp -> Int #
type AWSResponse CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp type AWSResponse CreateApp = CreateAppResponse
type Rep CreateApp Source #
Instance details Defined in Amazonka.SageMaker.CreateApp type Rep CreateApp = D1 ('MetaData "CreateApp" "Amazonka.SageMaker.CreateApp" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateApp'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourceSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceSpec)) :: (S1 ('MetaSel ('Just "spaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: ((S1 ('MetaSel ('Just "userProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "appType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AppType) :: S1 ('MetaSel ('Just "appName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateApp Source #

Arguments

:: Text	`CreateApp`
-> AppType	`CreateApp`
-> Text	`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.

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, createApp_spaceName - The name of the space. If this value is not set, then UserProfileName must be set.

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

CreateApp, createApp_userProfileName - The user profile name. If this value is not set, then SpaceName must be set.

CreateApp, createApp_domainId - The domain ID.

CreateApp, createApp_appType - The type of app.

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.

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_spaceName :: Lens' CreateApp (Maybe Text) Source #

The name of the space. If this value is not set, then UserProfileName must be set.

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_userProfileName :: Lens' CreateApp (Maybe Text) Source #

The user profile name. If this value is not set, then SpaceName must be set.

createApp_domainId :: Lens' CreateApp Text Source #

The domain ID.

createApp_appType :: Lens' CreateApp AppType Source #

The type of app.

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

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 #
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 #
NFData CreateAppResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods rnf :: CreateAppResponse -> () #
Eq CreateAppResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateApp Methods (==) :: CreateAppResponse -> CreateAppResponse -> Bool # (/=) :: CreateAppResponse -> CreateAppResponse -> Bool #
type Rep CreateAppResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateApp type Rep CreateAppResponse = D1 ('MetaData "CreateAppResponse" "Amazonka.SageMaker.CreateApp" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" '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.