SageMaker / Client / describe_mlflow_tracking_server

describe_mlflow_tracking_server#

SageMaker.Client.describe_mlflow_tracking_server(**kwargs)#

Returns information about an MLflow Tracking Server.

See also: AWS API Documentation

Request Syntax

response = client.describe_mlflow_tracking_server(
    TrackingServerName='string'
)
Parameters:

TrackingServerName (string) –

[REQUIRED]

The name of the MLflow Tracking Server to describe.

Return type:

dict

Returns:

Response Syntax

{
    'TrackingServerArn': 'string',
    'TrackingServerName': 'string',
    'ArtifactStoreUri': 'string',
    'TrackingServerSize': 'Small'|'Medium'|'Large',
    'MlflowVersion': 'string',
    'RoleArn': 'string',
    'TrackingServerStatus': 'Creating'|'Created'|'CreateFailed'|'Updating'|'Updated'|'UpdateFailed'|'Deleting'|'DeleteFailed'|'Stopping'|'Stopped'|'StopFailed'|'Starting'|'Started'|'StartFailed'|'MaintenanceInProgress'|'MaintenanceComplete'|'MaintenanceFailed',
    'IsActive': 'Active'|'Inactive',
    'TrackingServerUrl': 'string',
    'WeeklyMaintenanceWindowStart': 'string',
    'AutomaticModelRegistration': True|False,
    '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'
        }
    }
}

Response Structure

  • (dict) –

    • TrackingServerArn (string) –

      The ARN of the described tracking server.

    • TrackingServerName (string) –

      The name of the described tracking server.

    • ArtifactStoreUri (string) –

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

    • TrackingServerSize (string) –

      The size of the described tracking server.

    • MlflowVersion (string) –

      The MLflow version used for the described tracking server.

    • RoleArn (string) –

      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.

    • TrackingServerStatus (string) –

      The current creation status of the described MLflow Tracking Server.

    • IsActive (string) –

      Whether the described MLflow Tracking Server is currently active.

    • TrackingServerUrl (string) –

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

    • WeeklyMaintenanceWindowStart (string) –

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

    • AutomaticModelRegistration (boolean) –

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

    • CreationTime (datetime) –

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

    • CreatedBy (dict) –

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

      • 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 of when the described MLflow Tracking Server was last modified.

    • LastModifiedBy (dict) –

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

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

Exceptions