DescribeMlflowApp
Returns information about an MLflow App.
Request Syntax
{
"Arn": "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.
- Arn
-
The ARN of the MLflow App for which to get information.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-app/.*Required: Yes
Response Syntax
{
"AccountDefaultStatus": "string",
"Arn": "string",
"ArtifactStoreUri": "string",
"CreatedBy": {
"DomainId": "string",
"IamIdentity": {
"Arn": "string",
"PrincipalId": "string",
"SourceIdentity": "string"
},
"UserProfileArn": "string",
"UserProfileName": "string"
},
"CreationTime": number,
"DefaultDomainIdList": [ "string" ],
"LastModifiedBy": {
"DomainId": "string",
"IamIdentity": {
"Arn": "string",
"PrincipalId": "string",
"SourceIdentity": "string"
},
"UserProfileArn": "string",
"UserProfileName": "string"
},
"LastModifiedTime": number,
"MaintenanceStatus": "string",
"MlflowVersion": "string",
"ModelRegistrationMode": "string",
"Name": "string",
"RoleArn": "string",
"Status": "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.
- AccountDefaultStatus
-
Indicates whether this MLflow app is the default for the entire account.
Type: String
Valid Values:
ENABLED | DISABLED - Arn
-
The ARN of the MLflow App.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-app/.* - ArtifactStoreUri
-
The S3 URI of the general purpose bucket used as the MLflow App artifact store.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
(https|s3)://([^/]+)/?(.*) - CreatedBy
-
Information about the user who created or modified a SageMaker resource.
Type: UserContext object
- CreationTime
-
The timestamp when the MLflow App was created.
Type: Timestamp
- DefaultDomainIdList
-
List of SageMaker Domain IDs for which this MLflow App is the default.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern:
d-(-*[a-z0-9]){1,61} - LastModifiedBy
-
Information about the user who created or modified a SageMaker resource.
Type: UserContext object
- LastModifiedTime
-
The timestamp when the MLflow App was last modified.
Type: Timestamp
- MaintenanceStatus
-
Current maintenance status of the MLflow App.
Type: String
Valid Values:
MaintenanceInProgress | MaintenanceComplete | MaintenanceFailed - MlflowVersion
-
The MLflow version used.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 16.
Pattern:
[0-9]*.[0-9]*.[0-9]* - ModelRegistrationMode
-
Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
Type: String
Valid Values:
AutoModelRegistrationEnabled | AutoModelRegistrationDisabled - Name
-
The name of the MLflow App.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255} - RoleArn
-
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.
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+=,.@\-_/]+ - Status
-
The current creation status of the described MLflow App.
Type: String
Valid Values:
Creating | Created | CreateFailed | Updating | Updated | UpdateFailed | Deleting | DeleteFailed | Deleted - WeeklyMaintenanceWindowStart
-
The day and time of the week when weekly maintenance occurs.
Type: String
Length Constraints: Minimum length of 0. 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:
