Skip to content

list_mlflow_apps async

list_mlflow_apps(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    created_after: Optional[Timestamp] = None,
    created_before: Optional[Timestamp] = None,
    status: Optional[MlflowAppStatus] = None,
    mlflow_version: Optional[MlflowVersion] = None,
    default_for_domain_id: Optional[String] = None,
    account_default_status: Optional[AccountDefaultStatus] = None,
    sort_by: Optional[SortMlflowAppBy] = None,
    sort_order: Optional[SortOrder] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListMlflowAppsResponse

Lists all MLflow Apps

Parameters:

  • created_after (Optional[Timestamp], default: None ) –

    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.

  • created_before (Optional[Timestamp], default: None ) –

    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 (Optional[MlflowAppStatus], default: None ) –

    Filter for Mlflow apps with a specific creation status.

  • mlflow_version (Optional[MlflowVersion], default: None ) –

    Filter for Mlflow Apps with the specified version.

  • default_for_domain_id (Optional[String], default: None ) –

    Filter for MLflow Apps with the specified default SageMaker Domain ID.

  • account_default_status (Optional[AccountDefaultStatus], default: None ) –

    Filter for MLflow Apps with the specified AccountDefaultStatus.

  • sort_by (Optional[SortMlflowAppBy], default: None ) –

    Filter for MLflow Apps sorting by name, creation time, or creation status.

  • sort_order (Optional[SortOrder], default: None ) –

    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.

  • next_token (Optional[NextToken], default: None ) –

    If the previous response was truncated, use this token in your next request to receive the next set of results.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of MLflow Apps to list.

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def list_mlflow_apps(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    created_after: Optional["capo_sagemaker.types.timestamp.Timestamp"] = None,
    created_before: Optional["capo_sagemaker.types.timestamp.Timestamp"] = None,
    status: Optional[
        "capo_sagemaker.types.mlflow_app_status.MlflowAppStatus"
    ] = None,
    mlflow_version: Optional[
        "capo_sagemaker.types.mlflow_version.MlflowVersion"
    ] = None,
    default_for_domain_id: Optional["capo_sagemaker.types.string.String"] = None,
    account_default_status: Optional[
        "capo_sagemaker.types.account_default_status.AccountDefaultStatus"
    ] = None,
    sort_by: Optional[
        "capo_sagemaker.types.sort_mlflow_app_by.SortMlflowAppBy"
    ] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
) -> "capo_sagemaker.types.list_mlflow_apps_response.ListMlflowAppsResponse":
    """<p>Lists all MLflow Apps</p>

    Args:
        created_after: <p>Use the <code>CreatedAfter</code> 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 <code>"2024-03-16T01:46:56+00:00"</code>. The <code>CreatedAfter</code> parameter takes in a Unix timestamp.</p>
        created_before: <p>Use the <code>CreatedBefore</code> 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 <code>"2024-03-16T01:46:56+00:00"</code>. The <code>CreatedAfter</code> parameter takes in a Unix timestamp.</p>
        status: <p>Filter for Mlflow apps with a specific creation status.</p>
        mlflow_version: <p>Filter for Mlflow Apps with the specified version.</p>
        default_for_domain_id: <p>Filter for MLflow Apps with the specified default SageMaker Domain ID.</p>
        account_default_status: <p>Filter for MLflow Apps with the specified <code>AccountDefaultStatus</code>.</p>
        sort_by: <p>Filter for MLflow Apps sorting by name, creation time, or creation status.</p>
        sort_order: <p>Change the order of the listed MLflow Apps. By default, MLflow Apps are listed in <code>Descending</code> order by creation time. To change the list order, specify <code>SortOrder</code> to be <code>Ascending</code>.</p>
        next_token: <p>If the previous response was truncated, use this token in your next request to receive the next set of results.</p>
        max_results: <p>The maximum number of MLflow Apps to list.</p>

    Raises:
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.list_mlflow_apps_request.ListMlflowAppsRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.list_mlflow_apps_response.ListMlflowAppsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_mlflow_apps

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.list_mlflow_apps.async_list_mlflow_apps(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMlflowApps")
    )
    input_: capo_sagemaker.types.list_mlflow_apps_request.ListMlflowAppsRequest = {}
    if created_after is not None:
        input_["created_after"] = created_after
    if created_before is not None:
        input_["created_before"] = created_before
    if status is not None:
        input_["status"] = status
    if mlflow_version is not None:
        input_["mlflow_version"] = mlflow_version
    if default_for_domain_id is not None:
        input_["default_for_domain_id"] = default_for_domain_id
    if account_default_status is not None:
        input_["account_default_status"] = account_default_status
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output