Skip to main content

mlflow_tracking_servers

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

Overview​

Namemlflow_tracking_servers
TypeResource
Idaws.sagemaker.mlflow_tracking_servers

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
artifact_store_uristringThe S3 URI of the general purpose bucket used as the MLflow Tracking Server artifact store. (pattern: <code>(https|s3):​//([^/]+)/?(.*)</code>)
automatic_model_registrationbooleanWhether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
created_byobjectInformation about the user who created or modified a SageMaker resource.
creation_timestring (date-time)The timestamp of when the described MLflow Tracking Server was created.
is_activestringWhether the described MLflow Tracking Server is currently active. (Active, Inactive)
last_modified_byobjectInformation about the user who created or modified a SageMaker resource.
last_modified_timestring (date-time)The timestamp of when the described MLflow Tracking Server was last modified.
mlflow_versionstringThe MLflow version used for the described tracking server. (pattern: <code>[0-9].[0-9].[0-9]*</code>)
role_arnstringThe Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server 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>)
s3_bucket_owner_account_idstringExpected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage. (pattern: <code>\d+</code>)
s3_bucket_owner_verificationbooleanWhether Amazon S3 Bucket Ownership checks are enabled whenever the tracking server interacts with Amazon Amazon S3.
tracking_server_arnstringThe ARN of the described tracking server. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:mlflow-tracking-server/.*</code>)
tracking_server_maintenance_statusstringThe current maintenance status of the described MLflow Tracking Server. (MaintenanceInProgress, MaintenanceComplete, MaintenanceFailed)
tracking_server_namestringThe name of the described tracking server. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}</code>)
tracking_server_sizestringThe size of the described tracking server. (Small, Medium, Large)
tracking_server_statusstringThe current creation status of the described MLflow Tracking Server. (Creating, Created, CreateFailed, Updating, Updated, UpdateFailed, Deleting, DeleteFailed, Stopping, Stopped, StopFailed, Starting, Started, StartFailed, MaintenanceInProgress, MaintenanceComplete, MaintenanceFailed)
tracking_server_urlstringThe URL to connect to the MLflow user interface for the described tracking server.
weekly_maintenance_window_startstringThe day and time of the week when weekly maintenance occurs on the described tracking server. (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:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_mlflow_tracking_serverselectregionReturns information about an MLflow Tracking Server.
list_mlflow_tracking_serversselectregionLists all MLflow Tracking Servers.
create_mlflow_tracking_serverinsertregion, TrackingServerName, ArtifactStoreUri, RoleArnCreates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see Create an MLflow Tracking Server.
update_mlflow_tracking_serverupdateregion, TrackingServerNameUpdates properties of an existing MLflow Tracking Server.
delete_mlflow_tracking_serverdeleteregionDeletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Returns information about an MLflow Tracking Server.

SELECT
artifact_store_uri,
automatic_model_registration,
created_by,
creation_time,
is_active,
last_modified_by,
last_modified_time,
mlflow_version,
role_arn,
s3_bucket_owner_account_id,
s3_bucket_owner_verification,
tracking_server_arn,
tracking_server_maintenance_status,
tracking_server_name,
tracking_server_size,
tracking_server_status,
tracking_server_url,
weekly_maintenance_window_start
FROM aws.sagemaker.mlflow_tracking_servers
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see Create an MLflow Tracking Server.

INSERT INTO aws.sagemaker.mlflow_tracking_servers (
TrackingServerName,
ArtifactStoreUri,
TrackingServerSize,
MlflowVersion,
RoleArn,
AutomaticModelRegistration,
WeeklyMaintenanceWindowStart,
Tags,
S3BucketOwnerAccountId,
S3BucketOwnerVerification,
region
)
SELECT 
'{{ TrackingServerName }}' /* required */,
'{{ ArtifactStoreUri }}' /* required */,
'{{ TrackingServerSize }}',
'{{ MlflowVersion }}',
'{{ RoleArn }}' /* required */,
{{ AutomaticModelRegistration }},
'{{ WeeklyMaintenanceWindowStart }}',
'{{ Tags }}',
'{{ S3BucketOwnerAccountId }}',
{{ S3BucketOwnerVerification }},
'{{ region }}'
RETURNING
tracking_server_arn
;

UPDATE examples​

Updates properties of an existing MLflow Tracking Server.

UPDATE aws.sagemaker.mlflow_tracking_servers
SET 
TrackingServerName = '{{ TrackingServerName }}',
ArtifactStoreUri = '{{ ArtifactStoreUri }}',
TrackingServerSize = '{{ TrackingServerSize }}',
AutomaticModelRegistration = {{ AutomaticModelRegistration }},
WeeklyMaintenanceWindowStart = '{{ WeeklyMaintenanceWindowStart }}',
S3BucketOwnerAccountId = '{{ S3BucketOwnerAccountId }}',
S3BucketOwnerVerification = {{ S3BucketOwnerVerification }}
WHERE 
region = '{{ region }}' --required
AND TrackingServerName = '{{ TrackingServerName }}' --required
RETURNING
tracking_server_arn;

DELETE examples​

Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.

DELETE FROM aws.sagemaker.mlflow_tracking_servers
WHERE region = '{{ region }}' --required
;
Last updated on