UpdateMlflowApp - Amazon SageMaker

UpdateMlflowApp

Updates an MLflow App.

Request Syntax

{ "AccountDefaultStatus": "string", "Arn": "string", "ArtifactStoreUri": "string", "DefaultDomainIdList": [ "string" ], "ModelRegistrationMode": "string", "Name": "string", "WeeklyMaintenanceWindowStart": "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.

AccountDefaultStatus

Indicates whether this this MLflow App is the default for the account.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Arn

The ARN of the MLflow App to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-app/.*

Required: Yes

ArtifactStoreUri

The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow App.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: (https|s3)://([^/]+)/?(.*)

Required: No

DefaultDomainIdList

List of SageMaker Domain IDs for which this MLflow App is the default.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 63.

Pattern: d-(-*[a-z0-9]){1,61}

Required: No

ModelRegistrationMode

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to AutoModelRegistrationEnabled. To disable automatic model registration, set this value to AutoModelRegistrationDisabled. If not specified, AutomaticModelRegistration defaults to AutoModelRegistrationEnabled

Type: String

Valid Values: AutoModelRegistrationEnabled | AutoModelRegistrationDisabled

Required: No

Name

The name of the MLflow App to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}

Required: No

WeeklyMaintenanceWindowStart

The new weekly maintenance window start day and time to update. The maintenance window day and time should be in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 9.

Pattern: (Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):([0-5]\d)

Required: No

Response Syntax

{ "Arn": "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.

Arn

The ARN of the updated MLflow App.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-app/.*

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

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: