SageMaker / Paginator / ListMlflowTrackingServers

ListMlflowTrackingServers

class SageMaker.Paginator.ListMlflowTrackingServers

paginator = client.get_paginator('list_mlflow_tracking_servers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_mlflow_tracking_servers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    TrackingServerStatus='Creating'|'Created'|'CreateFailed'|'Updating'|'Updated'|'UpdateFailed'|'Deleting'|'DeleteFailed'|'Stopping'|'Stopped'|'StopFailed'|'Starting'|'Started'|'StartFailed'|'MaintenanceInProgress'|'MaintenanceComplete'|'MaintenanceFailed',
    MlflowVersion='string',
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• CreatedAfter (datetime) – 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.

• CreatedBefore (datetime) – 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.

• TrackingServerStatus (string) – Filter for tracking servers with a specified creation status.

• MlflowVersion (string) – Filter for tracking servers using the specified MLflow version.

• SortBy (string) – Filter for trackings servers sorting by name, creation time, or creation status.

• SortOrder (string) – 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'TrackingServerSummaries': [
        {
            'TrackingServerArn': 'string',
            'TrackingServerName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'TrackingServerStatus': 'Creating'|'Created'|'CreateFailed'|'Updating'|'Updated'|'UpdateFailed'|'Deleting'|'DeleteFailed'|'Stopping'|'Stopped'|'StopFailed'|'Starting'|'Started'|'StartFailed'|'MaintenanceInProgress'|'MaintenanceComplete'|'MaintenanceFailed',
            'IsActive': 'Active'|'Inactive',
            'MlflowVersion': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • TrackingServerSummaries (list) –

    A list of tracking servers according to chosen filters.

    • (dict) –

      The summary of the tracking server to list.

      • TrackingServerArn (string) –

        The ARN of a listed tracking server.

      • TrackingServerName (string) –

        The name of a listed tracking server.

      • CreationTime (datetime) –

        The creation time of a listed tracking server.

      • LastModifiedTime (datetime) –

        The last modified time of a listed tracking server.

      • TrackingServerStatus (string) –

        The creation status of a listed tracking server.

      • IsActive (string) –

        The activity status of a listed tracking server.

      • MlflowVersion (string) –

        The MLflow version used for a listed tracking server.