mlflow_apps

Creates, updates, deletes, gets or lists a mlflow_apps resource.

Overview

Name	mlflow_apps
Type	Resource
Id	aws.sagemaker.mlflow_apps

Fields

The following fields are returned by SELECT queries:

describe_mlflow_app

Name	Datatype	Description
account_default_status	string	Indicates whether this MLflow app is the default for the entire account. (ENABLED, DISABLED)
arn	string	The ARN of the MLflow App. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:mlflow-app/.*</code>)
artifact_store_uri	string	The S3 URI of the general purpose bucket used as the MLflow App artifact store. (pattern: <code>(https|s3):​//([^/]+)/?(.*)</code>)
created_by	object	Information about the user who created or modified a SageMaker resource.
creation_time	string (date-time)	The timestamp when the MLflow App was created.
default_domain_id_list	array	List of SageMaker Domain IDs for which this MLflow App is the default.
last_modified_by	object	Information about the user who created or modified a SageMaker resource.
last_modified_time	string (date-time)	The timestamp when the MLflow App was last modified.
maintenance_status	string	Current maintenance status of the MLflow App. (MaintenanceInProgress, MaintenanceComplete, MaintenanceFailed)
mlflow_version	string	The MLflow version used. (pattern: <code>[0-9].[0-9].[0-9]*</code>)
model_registration_mode	string	Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled. (AutoModelRegistrationEnabled, AutoModelRegistrationDisabled)
name	string	The name of the MLflow App. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}</code>)
role_arn	string	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. (pattern: <code>arn:aws[a-z-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)
status	string	The current creation status of the described MLflow App. (Creating, Created, CreateFailed, Updating, Updated, UpdateFailed, Deleting, DeleteFailed, Deleted)
weekly_maintenance_window_start	string	The day and time of the week when weekly maintenance occurs. (pattern: <code>(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):([0-5]\d)</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_mlflow_app	select	region		Returns information about an MLflow App.
create_mlflow_app	insert	region, ArtifactStoreUri, RoleArn		Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store.
update_mlflow_app	update	region		Updates an MLflow App.
delete_mlflow_app	delete	region		Deletes an MLflow App.
list_mlflow_apps	exec	region		Lists all MLflow Apps

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_mlflow_app

Returns information about an MLflow App.

SELECT
account_default_status,
arn,
artifact_store_uri,
created_by,
creation_time,
default_domain_id_list,
last_modified_by,
last_modified_time,
maintenance_status,
mlflow_version,
model_registration_mode,
name,
role_arn,
status,
weekly_maintenance_window_start
FROM aws.sagemaker.mlflow_apps
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_mlflow_app

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

INSERT INTO aws.sagemaker.mlflow_apps (
Name,
ArtifactStoreUri,
RoleArn,
ModelRegistrationMode,
WeeklyMaintenanceWindowStart,
AccountDefaultStatus,
DefaultDomainIdList,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ ArtifactStoreUri }}' /* required */,
'{{ RoleArn }}' /* required */,
'{{ ModelRegistrationMode }}',
'{{ WeeklyMaintenanceWindowStart }}',
'{{ AccountDefaultStatus }}',
'{{ DefaultDomainIdList }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
arn
;

Manifest

# Description fields are for documentation purposes
- name: mlflow_apps
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the mlflow_apps resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      A string identifying the MLflow app name. This string is not part of the tracking server ARN.
  - name: ArtifactStoreUri
    value: "{{ ArtifactStoreUri }}"
    description: |
      The S3 URI for a general purpose bucket to use as the MLflow App artifact store.
  - name: RoleArn
    value: "{{ RoleArn }}"
    description: |
      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.
  - name: ModelRegistrationMode
    value: "{{ ModelRegistrationMode }}"
    description: |
      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.
    valid_values: ['AutoModelRegistrationEnabled', 'AutoModelRegistrationDisabled']
  - name: WeeklyMaintenanceWindowStart
    value: "{{ WeeklyMaintenanceWindowStart }}"
    description: |
      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.
  - name: AccountDefaultStatus
    value: "{{ AccountDefaultStatus }}"
    description: |
      Indicates whether this MLflow app is the default for the entire account.
    valid_values: ['ENABLED', 'DISABLED']
  - name: DefaultDomainIdList
    value:
      - "{{ DefaultDomainIdList }}"
    description: |
      List of SageMaker domain IDs for which this MLflow App is used as the default.
  - name: Tags
    description: |
      Tags consisting of key-value pairs used to manage metadata for the MLflow App.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_mlflow_app

Updates an MLflow App.

UPDATE aws.sagemaker.mlflow_apps
SET 
Arn = '{{ Arn }}',
Name = '{{ Name }}',
ArtifactStoreUri = '{{ ArtifactStoreUri }}',
ModelRegistrationMode = '{{ ModelRegistrationMode }}',
WeeklyMaintenanceWindowStart = '{{ WeeklyMaintenanceWindowStart }}',
DefaultDomainIdList = '{{ DefaultDomainIdList }}',
AccountDefaultStatus = '{{ AccountDefaultStatus }}'
WHERE 
region = '{{ region }}' --required
RETURNING
arn;

DELETE examples

delete_mlflow_app

Deletes an MLflow App.

DELETE FROM aws.sagemaker.mlflow_apps
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_mlflow_apps

Lists all MLflow Apps

EXEC aws.sagemaker.mlflow_apps.list_mlflow_apps 
@region='{{ region }}' --required 
@@json=
'{
"CreatedAfter": "{{ CreatedAfter }}", 
"CreatedBefore": "{{ CreatedBefore }}", 
"Status": "{{ Status }}", 
"MlflowVersion": "{{ MlflowVersion }}", 
"DefaultForDomainId": "{{ DefaultForDomainId }}", 
"AccountDefaultStatus": "{{ AccountDefaultStatus }}", 
"SortBy": "{{ SortBy }}", 
"SortOrder": "{{ SortOrder }}", 
"NextToken": "{{ NextToken }}", 
"MaxResults": {{ MaxResults }}
}'
;