Skip to content

list_auto_ml_jobs async

list_auto_ml_jobs(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    creation_time_after: Optional[Timestamp] = None,
    creation_time_before: Optional[Timestamp] = None,
    last_modified_time_after: Optional[Timestamp] = None,
    last_modified_time_before: Optional[Timestamp] = None,
    name_contains: Optional[AutoMLNameContains] = None,
    status_equals: Optional[AutoMLJobStatus] = None,
    sort_order: Optional[AutoMLSortOrder] = None,
    sort_by: Optional[AutoMLSortBy] = None,
    max_results: Optional[AutoMLMaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListAutoMLJobsResponse

Request a list of jobs.

Parameters:

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

    Request a list of jobs, using a filter for time.

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

    Request a list of jobs, using a filter for time.

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

    Request a list of jobs, using a filter for time.

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

    Request a list of jobs, using a filter for time.

  • name_contains (Optional[AutoMLNameContains], default: None ) –

    Request a list of jobs, using a search filter for name.

  • status_equals (Optional[AutoMLJobStatus], default: None ) –

    Request a list of jobs, using a filter for status.

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

    The sort order for the results. The default is Descending.

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

    The parameter by which to sort the results. The default is Name.

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

    Request a list of jobs up to a specified limit.

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

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

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def list_auto_ml_jobs(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    last_modified_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    last_modified_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    name_contains: Optional[
        "capo_sagemaker.types.auto_ml_name_contains.AutoMLNameContains"
    ] = None,
    status_equals: Optional[
        "capo_sagemaker.types.auto_ml_job_status.AutoMLJobStatus"
    ] = None,
    sort_order: Optional[
        "capo_sagemaker.types.auto_ml_sort_order.AutoMLSortOrder"
    ] = None,
    sort_by: Optional["capo_sagemaker.types.auto_ml_sort_by.AutoMLSortBy"] = None,
    max_results: Optional[
        "capo_sagemaker.types.auto_ml_max_results.AutoMLMaxResults"
    ] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
) -> "capo_sagemaker.types.list_auto_ml_jobs_response.ListAutoMLJobsResponse":
    """<p>Request a list of jobs.</p>

    Args:
        creation_time_after: <p>Request a list of jobs, using a filter for time.</p>
        creation_time_before: <p>Request a list of jobs, using a filter for time.</p>
        last_modified_time_after: <p>Request a list of jobs, using a filter for time.</p>
        last_modified_time_before: <p>Request a list of jobs, using a filter for time.</p>
        name_contains: <p>Request a list of jobs, using a search filter for name.</p>
        status_equals: <p>Request a list of jobs, using a filter for status.</p>
        sort_order: <p>The sort order for the results. The default is <code>Descending</code>.</p>
        sort_by: <p>The parameter by which to sort the results. The default is <code>Name</code>.</p>
        max_results: <p>Request a list of jobs up to a specified limit.</p>
        next_token: <p>If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.</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_auto_ml_jobs_request.ListAutoMLJobsRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.list_auto_ml_jobs_response.ListAutoMLJobsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_auto_ml_jobs

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAutoMLJobs")
    )
    input_: capo_sagemaker.types.list_auto_ml_jobs_request.ListAutoMLJobsRequest = {}
    if creation_time_after is not None:
        input_["creation_time_after"] = creation_time_after
    if creation_time_before is not None:
        input_["creation_time_before"] = creation_time_before
    if last_modified_time_after is not None:
        input_["last_modified_time_after"] = last_modified_time_after
    if last_modified_time_before is not None:
        input_["last_modified_time_before"] = last_modified_time_before
    if name_contains is not None:
        input_["name_contains"] = name_contains
    if status_equals is not None:
        input_["status_equals"] = status_equals
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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