Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateMlflowApp

Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store.

Request Syntax


{
   "AccountDefaultStatus": "string",
   "ArtifactStoreUri": "string",
   "DefaultDomainIdList": [ "string" ],
   "ModelRegistrationMode": "string",
   "Name": "string",
   "RoleArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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 MLflow app is the default for the entire account.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

ArtifactStoreUri

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

Type: String

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

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

Required: Yes

DefaultDomainIdList

List of SageMaker domain IDs for which this MLflow App is used as 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 AutoModelRegistrationDisabled.

Type: String

Valid Values: AutoModelRegistrationEnabled | AutoModelRegistrationDisabled

Required: No

Name

A string identifying the MLflow app name. This string is not part of the tracking server ARN.

Type: String

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

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

Required: Yes

RoleArn

The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3. The role should have the AmazonS3FullAccess permission.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Required: Yes

Tags

Tags consisting of key-value pairs used to manage metadata for the MLflow App.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

WeeklyMaintenanceWindowStart

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. 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 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.

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400