ListMlflowTrackingServers - Amazon SageMaker

ListMlflowTrackingServers

Lists all MLflow Tracking Servers.

Request Syntax

{ "CreatedAfter": number, "CreatedBefore": number, "MaxResults": number, "MlflowVersion": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "TrackingServerStatus": "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.

CreatedAfter

Use the CreatedAfter filter to only list tracking servers created after a specific date and time. Listed tracking servers are shown with a date and time such as "2024-03-16T01:46:56+00:00". The CreatedAfter parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

Type: Timestamp

Required: No

CreatedBefore

Use the CreatedBefore filter to only list tracking servers created before a specific date and time. Listed tracking servers are shown with a date and time such as "2024-03-16T01:46:56+00:00". The CreatedBefore parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

Type: Timestamp

Required: No

MaxResults

The maximum number of tracking servers to list.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

MlflowVersion

Filter for tracking servers using the specified MLflow version.

Type: String

Length Constraints: Maximum length of 16.

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

Required: No

NextToken

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

Filter for trackings servers sorting by name, creation time, or creation status.

Type: String

Valid Values: Name | CreationTime | Status

Required: No

SortOrder

Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time. To change the list order, you can specify SortOrder to be Ascending.

Type: String

Valid Values: Ascending | Descending

Required: No

TrackingServerStatus

Filter for tracking servers with a specified creation status.

Type: String

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

Required: No

Response Syntax

{ "NextToken": "string", "TrackingServerSummaries": [ { "CreationTime": number, "IsActive": "string", "LastModifiedTime": number, "MlflowVersion": "string", "TrackingServerArn": "string", "TrackingServerName": "string", "TrackingServerStatus": "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.

NextToken

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

TrackingServerSummaries

A list of tracking servers according to chosen filters.

Type: Array of TrackingServerSummary objects

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

Errors

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: