Skip to content

list_compilation_jobs async

list_compilation_jobs(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    creation_time_after: Optional[CreationTime] = None,
    creation_time_before: Optional[CreationTime] = None,
    last_modified_time_after: Optional[LastModifiedTime] = None,
    last_modified_time_before: Optional[LastModifiedTime] = None,
    name_contains: Optional[NameContains] = None,
    status_equals: Optional[CompilationJobStatus] = None,
    sort_by: Optional[ListCompilationJobsSortBy] = None,
    sort_order: Optional[SortOrder] = None,
) -> ListCompilationJobsResponse

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

Parameters:

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

    If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

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

    The maximum number of model compilation jobs to return in the response.

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

    A filter that returns the model compilation jobs that were created after a specified time.

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

    A filter that returns the model compilation jobs that were created before a specified time.

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

    A filter that returns the model compilation jobs that were modified after a specified time.

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

    A filter that returns the model compilation jobs that were modified before a specified time.

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

    A filter that returns the model compilation jobs whose name contains a specified string.

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

    A filter that retrieves model compilation jobs with a specific CompilationJobStatus status.

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

    The field by which to sort results. The default is CreationTime.

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

    The sort order for results. The default is Ascending.

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def list_compilation_jobs(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.creation_time.CreationTime"
    ] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.creation_time.CreationTime"
    ] = None,
    last_modified_time_after: Optional[
        "capo_sagemaker.types.last_modified_time.LastModifiedTime"
    ] = None,
    last_modified_time_before: Optional[
        "capo_sagemaker.types.last_modified_time.LastModifiedTime"
    ] = None,
    name_contains: Optional[
        "capo_sagemaker.types.name_contains.NameContains"
    ] = None,
    status_equals: Optional[
        "capo_sagemaker.types.compilation_job_status.CompilationJobStatus"
    ] = None,
    sort_by: Optional[
        "capo_sagemaker.types.list_compilation_jobs_sort_by.ListCompilationJobsSortBy"
    ] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
) -> "capo_sagemaker.types.list_compilation_jobs_response.ListCompilationJobsResponse":
    """<p>Lists model compilation jobs that satisfy various filters.</p> <p>To create a model compilation job, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html">CreateCompilationJob</a>. To get information about a particular model compilation job you have created, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html">DescribeCompilationJob</a>.</p>

    Args:
        next_token: <p>If the result of the previous <code>ListCompilationJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of model compilation jobs, use the token in the next request.</p>
        max_results: <p>The maximum number of model compilation jobs to return in the response.</p>
        creation_time_after: <p>A filter that returns the model compilation jobs that were created after a specified time. </p>
        creation_time_before: <p>A filter that returns the model compilation jobs that were created before a specified time.</p>
        last_modified_time_after: <p>A filter that returns the model compilation jobs that were modified after a specified time.</p>
        last_modified_time_before: <p>A filter that returns the model compilation jobs that were modified before a specified time.</p>
        name_contains: <p>A filter that returns the model compilation jobs whose name contains a specified string.</p>
        status_equals: <p>A filter that retrieves model compilation jobs with a specific <code>CompilationJobStatus</code> status.</p>
        sort_by: <p>The field by which to sort results. The default is <code>CreationTime</code>.</p>
        sort_order: <p>The sort order for results. The default is <code>Ascending</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_compilation_jobs_request.ListCompilationJobsRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.list_compilation_jobs_response.ListCompilationJobsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_compilation_jobs

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCompilationJobs")
    )
    input_: capo_sagemaker.types.list_compilation_jobs_request.ListCompilationJobsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    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_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