DeleteApp - Amazon SageMaker Service

DeleteApp

Used to stop and delete an app.

Request Syntax

{ "AppName": "string", "AppType": "string", "DomainId": "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])*

Required: Yes

AppType

The type of app.

Type: String

Valid Values: JupyterServer | KernelGateway | TensorBoard

Required: Yes

DomainId

The domain ID.

Type: String

Length Constraints: Maximum length of 63.

Required: Yes

UserProfileName

The user profile name.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: