DescribeMlflowTrackingServer - Amazon SageMaker

DescribeMlflowTrackingServer

Returns information about an MLflow Tracking Server.

Request Syntax

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

TrackingServerName

The name of the MLflow Tracking Server to describe.

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

Response Syntax

{ "ArtifactStoreUri": "string", "AutomaticModelRegistration": boolean, "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "IsActive": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "MlflowVersion": "string", "RoleArn": "string", "TrackingServerArn": "string", "TrackingServerName": "string", "TrackingServerSize": "string", "TrackingServerStatus": "string", "TrackingServerUrl": "string", "WeeklyMaintenanceWindowStart": "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.

ArtifactStoreUri

The S3 URI of the general purpose bucket used as the MLflow Tracking Server artifact store.

Type: String

Length Constraints: Maximum length of 1024.

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

AutomaticModelRegistration

Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.

Type: Boolean

CreatedBy

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

Type: UserContext object

CreationTime

The timestamp of when the described MLflow Tracking Server was created.

Type: Timestamp

IsActive

Whether the described MLflow Tracking Server is currently active.

Type: String

Valid Values: Active | Inactive

LastModifiedBy

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

Type: UserContext object

LastModifiedTime

The timestamp of when the described MLflow Tracking Server was last modified.

Type: Timestamp

MlflowVersion

The MLflow version used for the described tracking server.

Type: String

Length Constraints: Maximum length of 16.

Pattern: ^[0-9]*.[0-9]*.[0-9]*

RoleArn

The 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.

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+=,.@\-_/]+$

TrackingServerArn

The ARN of the described tracking server.

Type: String

Length Constraints: Maximum length of 2048.

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

TrackingServerName

The name of the described tracking server.

Type: String

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

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

TrackingServerSize

The size of the described tracking server.

Type: String

Valid Values: Small | Medium | Large

TrackingServerStatus

The current creation status of the described MLflow Tracking Server.

Type: String

Valid Values: Creating | Created | CreateFailed | Updating | Updated | UpdateFailed | Deleting | DeleteFailed | Stopping | Stopped | StopFailed | Starting | Started | StartFailed | MaintenanceInProgress | MaintenanceComplete | MaintenanceFailed

TrackingServerUrl

The URL to connect to the MLflow user interface for the described tracking server.

Type: String

Length Constraints: Maximum length of 2048.

WeeklyMaintenanceWindowStart

The day and time of the week when weekly maintenance occurs on the described tracking server.

Type: String

Length Constraints: Maximum length of 9.

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

Errors

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

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: