CreateApp
Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
Request Syntax
{
"AppName": "string
",
"AppType": "string
",
"DomainId": "string
",
"ResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionAlias": "string
",
"SageMakerImageVersionArn": "string
"
},
"SpaceName": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"UserProfileName": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AppName
-
The name of the app.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
Required: Yes
- AppType
-
The type of app.
Type: String
Valid Values:
JupyterServer | KernelGateway | DetailedProfiler | TensorBoard | CodeEditor | JupyterLab | RStudioServerPro | RSessionGateway | Canvas
Required: Yes
- DomainId
-
The domain ID.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^d-(-*[a-z0-9]){1,61}
Required: Yes
- ResourceSpec
-
The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
Note
The value of
InstanceType
passed as part of theResourceSpec
in theCreateApp
call overrides the value passed as part of theResourceSpec
configured for the user profile or the domain. IfInstanceType
is not specified in any of those threeResourceSpec
values for aKernelGateway
app, theCreateApp
call fails with a request validation error.Type: ResourceSpec object
Required: No
- SpaceName
-
The name of the space. If this value is not set, then
UserProfileName
must be set.Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
Required: No
- Tags
-
Each tag consists of a key and an optional value. Tag keys must be unique per resource.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
- UserProfileName
-
The user profile name. If this value is not set, then
SpaceName
must be set.Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
Required: No
Response Syntax
{
"AppArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AppArn
-
The Amazon Resource Name (ARN) of the app.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:app/.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceInUse
-
Resource being accessed is in use.
HTTP Status Code: 400
- ResourceLimitExceeded
-
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: