SageMaker / Paginator / ListMlflowApps

ListMlflowApps

class SageMaker.Paginator.ListMlflowApps

paginator = client.get_paginator('list_mlflow_apps')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    Status='Creating'|'Created'|'CreateFailed'|'Updating'|'Updated'|'UpdateFailed'|'Deleting'|'DeleteFailed'|'Deleted',
    MlflowVersion='string',
    DefaultForDomainId='string',
    AccountDefaultStatus='ENABLED'|'DISABLED',
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

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

• Status (string) – Filter for Mlflow apps with a specific creation status.

• MlflowVersion (string) – Filter for Mlflow Apps with the specified version.

• DefaultForDomainId (string) – Filter for MLflow Apps with the specified default SageMaker Domain ID.

• AccountDefaultStatus (string) – Filter for MLflow Apps with the specified AccountDefaultStatus.

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

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

• 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

{
    'Summaries': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Status': 'Creating'|'Created'|'CreateFailed'|'Updating'|'Updated'|'UpdateFailed'|'Deleting'|'DeleteFailed'|'Deleted',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'MlflowVersion': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Summaries (list) –

    A list of MLflow Apps according to chosen filters.

    • (dict) –

      The summary of the Mlflow App to list.

      • Arn (string) –

        The ARN of a listed MLflow App.

      • Name (string) –

        The name of the MLflow App.

      • Status (string) –

        The status of the MLflow App.

      • CreationTime (datetime) –

        The creation time of a listed MLflow App.

      • LastModifiedTime (datetime) –

        The last modified time of a listed MLflow App.

      • MlflowVersion (string) –

        The version of a listed MLflow App.