aws_sdk_sagemaker/client/
list_compilation_jobs.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListCompilationJobs`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::set_next_token):<br>required: **false**<br><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><br>
8    ///   - [`max_results(i32)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of model compilation jobs to return in the response.</p><br>
9    ///   - [`creation_time_after(DateTime)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::creation_time_after) / [`set_creation_time_after(Option<DateTime>)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::set_creation_time_after):<br>required: **false**<br><p>A filter that returns the model compilation jobs that were created after a specified time.</p><br>
10    ///   - [`creation_time_before(DateTime)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::creation_time_before) / [`set_creation_time_before(Option<DateTime>)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::set_creation_time_before):<br>required: **false**<br><p>A filter that returns the model compilation jobs that were created before a specified time.</p><br>
11    ///   - [`last_modified_time_after(DateTime)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::last_modified_time_after) / [`set_last_modified_time_after(Option<DateTime>)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::set_last_modified_time_after):<br>required: **false**<br><p>A filter that returns the model compilation jobs that were modified after a specified time.</p><br>
12    ///   - [`last_modified_time_before(DateTime)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::last_modified_time_before) / [`set_last_modified_time_before(Option<DateTime>)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::set_last_modified_time_before):<br>required: **false**<br><p>A filter that returns the model compilation jobs that were modified before a specified time.</p><br>
13    ///   - [`name_contains(impl Into<String>)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::name_contains) / [`set_name_contains(Option<String>)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::set_name_contains):<br>required: **false**<br><p>A filter that returns the model compilation jobs whose name contains a specified string.</p><br>
14    ///   - [`status_equals(CompilationJobStatus)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::status_equals) / [`set_status_equals(Option<CompilationJobStatus>)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::set_status_equals):<br>required: **false**<br><p>A filter that retrieves model compilation jobs with a specific <code>CompilationJobStatus</code> status.</p><br>
15    ///   - [`sort_by(ListCompilationJobsSortBy)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::sort_by) / [`set_sort_by(Option<ListCompilationJobsSortBy>)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::set_sort_by):<br>required: **false**<br><p>The field by which to sort results. The default is <code>CreationTime</code>.</p><br>
16    ///   - [`sort_order(SortOrder)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for results. The default is <code>Ascending</code>.</p><br>
17    /// - On success, responds with [`ListCompilationJobsOutput`](crate::operation::list_compilation_jobs::ListCompilationJobsOutput) with field(s):
18    ///   - [`compilation_job_summaries(Option<Vec::<CompilationJobSummary>>)`](crate::operation::list_compilation_jobs::ListCompilationJobsOutput::compilation_job_summaries): <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CompilationJobSummary.html">CompilationJobSummary</a> objects, each describing a model compilation job.</p>
19    ///   - [`next_token(Option<String>)`](crate::operation::list_compilation_jobs::ListCompilationJobsOutput::next_token): <p>If the response is truncated, Amazon SageMaker AI returns this <code>NextToken</code>. To retrieve the next set of model compilation jobs, use this token in the next request.</p>
20    /// - On failure, responds with [`SdkError<ListCompilationJobsError>`](crate::operation::list_compilation_jobs::ListCompilationJobsError)
21    pub fn list_compilation_jobs(&self) -> crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder {
22        crate::operation::list_compilation_jobs::builders::ListCompilationJobsFluentBuilder::new(self.handle.clone())
23    }
24}