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 |
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' {}
- 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
See: newCreateApp
smart constructor.
CreateApp' | |
|
Instances
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.
Destructuring the Response
data CreateAppResponse Source #
See: newCreateAppResponse
smart constructor.
CreateAppResponse' | |
|
Instances
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.