SageMaker / Client / describe_mlflow_app

describe_mlflow_app¶

SageMaker.Client.describe_mlflow_app(**kwargs)¶

Returns information about an MLflow App.

Request Syntax

response = client.describe_mlflow_app(
    Arn='string'
)

Parameters:

Arn (string) –

[REQUIRED]

The ARN of the MLflow App for which to get information.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'ArtifactStoreUri': 'string',
    'MlflowVersion': 'string',
    'RoleArn': 'string',
    'Status': 'Creating'|'Created'|'CreateFailed'|'Updating'|'Updated'|'UpdateFailed'|'Deleting'|'DeleteFailed'|'Deleted',
    'ModelRegistrationMode': 'AutoModelRegistrationEnabled'|'AutoModelRegistrationDisabled',
    'AccountDefaultStatus': 'ENABLED'|'DISABLED',
    'DefaultDomainIdList': [
        'string',
    ],
    'CreationTime': datetime(2015, 1, 1),
    'CreatedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    },
    'LastModifiedTime': datetime(2015, 1, 1),
    'LastModifiedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    },
    'WeeklyMaintenanceWindowStart': 'string',
    'MaintenanceStatus': 'MaintenanceInProgress'|'MaintenanceComplete'|'MaintenanceFailed'
}

Response Structure

(dict) –
- Arn (string) –
  
  The ARN of the MLflow App.
- Name (string) –
  
  The name of the MLflow App.
- ArtifactStoreUri (string) –
  
  The S3 URI of the general purpose bucket used as the MLflow App artifact store.
- MlflowVersion (string) –
  
  The MLflow version used.
- RoleArn (string) –
  
  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.
- Status (string) –
  
  The current creation status of the described MLflow App.
- ModelRegistrationMode (string) –
  
  Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
- AccountDefaultStatus (string) –
  
  Indicates whether this MLflow app is the default for the entire account.
- DefaultDomainIdList (list) –
  
  List of SageMaker Domain IDs for which this MLflow App is the default.
  - (string) –
- CreationTime (datetime) –
  
  The timestamp when the MLflow App was created.
- CreatedBy (dict) –
  
  Information about the user who created or modified a SageMaker resource.
  - UserProfileArn (string) –
    
    The Amazon Resource Name (ARN) of the user’s profile.
  - UserProfileName (string) –
    
    The name of the user’s profile.
  - DomainId (string) –
    
    The domain associated with the user.
  - IamIdentity (dict) –
    
    The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the IAM identity.
    - PrincipalId (string) –
      
      The ID of the principal that assumes the IAM identity.
    - SourceIdentity (string) –
      
      The person or application which assumes the IAM identity.
- LastModifiedTime (datetime) –
  
  The timestamp when the MLflow App was last modified.
- LastModifiedBy (dict) –
  
  Information about the user who created or modified a SageMaker resource.
  - UserProfileArn (string) –
    
    The Amazon Resource Name (ARN) of the user’s profile.
  - UserProfileName (string) –
    
    The name of the user’s profile.
  - DomainId (string) –
    
    The domain associated with the user.
  - IamIdentity (dict) –
    
    The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the IAM identity.
    - PrincipalId (string) –
      
      The ID of the principal that assumes the IAM identity.
    - SourceIdentity (string) –
      
      The person or application which assumes the IAM identity.
- WeeklyMaintenanceWindowStart (string) –
  
  The day and time of the week when weekly maintenance occurs.
- MaintenanceStatus (string) –
  
  Current maintenance status of the MLflow App.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound