list_ai_recommendation_jobs async ¶

async def list_ai_recommendation_jobs(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    name_contains: Optional[
        "capo_sagemaker.types.name_contains.NameContains"
    ] = None,
    status_equals: Optional[
        "capo_sagemaker.types.ai_recommendation_job_status.AIRecommendationJobStatus"
    ] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    sort_by: Optional[
        "capo_sagemaker.types.list_ai_recommendation_jobs_sort_by.ListAIRecommendationJobsSortBy"
    ] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
) -> "capo_sagemaker.types.list_ai_recommendation_jobs_response.ListAIRecommendationJobsResponse":
    """<p>Returns a list of AI recommendation jobs in your account. You can filter the results by name, status, and creation time, and sort the results. The response is paginated.</p>

    Args:
        max_results: <p>The maximum number of recommendation jobs to return in the response.</p>
        next_token: <p>If the previous call to <code>ListAIRecommendationJobs</code> didn't return the full set of jobs, the call returns a token for getting the next set.</p>
        name_contains: <p>A string in the job name. This filter returns only jobs whose name contains the specified string.</p>
        status_equals: <p>A filter that returns only recommendation jobs with the specified status.</p>
        creation_time_after: <p>A filter that returns only jobs created after the specified time.</p>
        creation_time_before: <p>A filter that returns only jobs created before the specified time.</p>
        sort_by: <p>The field to sort results by. The default is <code>CreationTime</code>.</p>
        sort_order: <p>The sort order for results. The default is <code>Descending</code>.</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_ai_recommendation_jobs_request.ListAIRecommendationJobsRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.list_ai_recommendation_jobs_response.ListAIRecommendationJobsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_ai_recommendation_jobs

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAIRecommendationJobs")
    )
    input_: capo_sagemaker.types.list_ai_recommendation_jobs_request.ListAIRecommendationJobsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if name_contains is not None:
        input_["name_contains"] = name_contains
    if status_equals is not None:
        input_["status_equals"] = status_equals
    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 sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order

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