Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListMlflowApps

Lists all MLflow Apps

Request Syntax


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

Filter for MLflow Apps with the specified AccountDefaultStatus.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

CreatedAfter

Use the CreatedAfter filter to only list MLflow Apps created after a specific date and time. Listed MLflow Apps are shown with a date and time such as "2024-03-16T01:46:56+00:00". The CreatedAfter parameter takes in a Unix timestamp.

Type: Timestamp

Required: No

CreatedBefore

Use the CreatedBefore filter to only list MLflow Apps created before a specific date and time. Listed MLflow Apps are shown with a date and time such as "2024-03-16T01:46:56+00:00". The CreatedAfter parameter takes in a Unix timestamp.

Type: Timestamp

Required: No

DefaultForDomainId

Filter for MLflow Apps with the specified default SageMaker Domain ID.

Type: String

Required: No

MaxResults

The maximum number of MLflow Apps to list.

Type: Integer

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

Required: No

MlflowVersion

Filter for Mlflow Apps with the specified version.

Type: String

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

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

Required: No

NextToken

If the previous response was truncated, use this token in your next request to receive the next set of results.

Type: String

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

Pattern: .*

Required: No

SortBy

Filter for MLflow Apps sorting by name, creation time, or creation status.

Type: String

Valid Values: Name | CreationTime | Status

Required: No

SortOrder

Change the order of the listed MLflow Apps. By default, MLflow Apps are listed in Descending order by creation time. To change the list order, specify SortOrder to be Ascending.

Type: String

Valid Values: Ascending | Descending

Required: No

Status

Filter for Mlflow apps with a specific creation status.

Type: String

Required: No

Response Syntax


{
   "NextToken": "string",
   "Summaries": [ 
      { 
         "Arn": "string",
         "CreationTime": number,
         "LastModifiedTime": number,
         "MlflowVersion": "string",
         "Name": "string",
         "Status": "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: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Summaries

A list of MLflow Apps according to chosen filters.

Type: Array of MlflowAppSummary 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.