Skip to content

list_mlflow_tracking_servers async

list_mlflow_tracking_servers(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    created_after: Optional[Timestamp] = None,
    created_before: Optional[Timestamp] = None,
    tracking_server_status: Optional[TrackingServerStatus] = None,
    mlflow_version: Optional[MlflowVersion] = None,
    sort_by: Optional[SortTrackingServerBy] = None,
    sort_order: Optional[SortOrder] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListMlflowTrackingServersResponse

Lists all MLflow Tracking Servers.

Parameters:

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

    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.

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

    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.

  • tracking_server_status (Optional[TrackingServerStatus], default: None ) –

    Filter for tracking servers with a specified creation status.

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

    Filter for tracking servers using the specified MLflow version.

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

    Filter for trackings servers sorting by name, creation time, or creation status.

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

    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.

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

    If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

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

    The maximum number of tracking servers to list.

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def list_mlflow_tracking_servers(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    created_after: Optional["capo_sagemaker.types.timestamp.Timestamp"] = None,
    created_before: Optional["capo_sagemaker.types.timestamp.Timestamp"] = None,
    tracking_server_status: Optional[
        "capo_sagemaker.types.tracking_server_status.TrackingServerStatus"
    ] = None,
    mlflow_version: Optional[
        "capo_sagemaker.types.mlflow_version.MlflowVersion"
    ] = None,
    sort_by: Optional[
        "capo_sagemaker.types.sort_tracking_server_by.SortTrackingServerBy"
    ] = 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_tracking_servers_response.ListMlflowTrackingServersResponse":
    """<p>Lists all MLflow Tracking Servers.</p>

    Args:
        created_after: <p>Use the <code>CreatedAfter</code> 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 <code>"2024-03-16T01:46:56+00:00"</code>. The <code>CreatedAfter</code> parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see <a href="https://www.epochconverter.com/">EpochConverter</a>.</p>
        created_before: <p>Use the <code>CreatedBefore</code> 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 <code>"2024-03-16T01:46:56+00:00"</code>. The <code>CreatedBefore</code> parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see <a href="https://www.epochconverter.com/">EpochConverter</a>.</p>
        tracking_server_status: <p>Filter for tracking servers with a specified creation status.</p>
        mlflow_version: <p>Filter for tracking servers using the specified MLflow version.</p>
        sort_by: <p>Filter for trackings servers sorting by name, creation time, or creation status.</p>
        sort_order: <p>Change the order of the listed tracking servers. By default, tracking servers are listed in <code>Descending</code> order by creation time. To change the list order, you can specify <code>SortOrder</code> to be <code>Ascending</code>.</p>
        next_token: <p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>
        max_results: <p>The maximum number of tracking servers 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_tracking_servers_request.ListMlflowTrackingServersRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.list_mlflow_tracking_servers_response.ListMlflowTrackingServersResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_mlflow_tracking_servers

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMlflowTrackingServers")
    )
    input_: capo_sagemaker.types.list_mlflow_tracking_servers_request.ListMlflowTrackingServersRequest = {}
    if created_after is not None:
        input_["created_after"] = created_after
    if created_before is not None:
        input_["created_before"] = created_before
    if tracking_server_status is not None:
        input_["tracking_server_status"] = tracking_server_status
    if mlflow_version is not None:
        input_["mlflow_version"] = mlflow_version
    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