aws_sdk_sagemaker/client/

list_training_jobs.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListTrainingJobs`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the result of the previous <code>ListTrainingJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of training jobs, use the token in the next request.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of training jobs to return in the response.</p><br>
    ///   - [`creation_time_after(DateTime)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::creation_time_after) / [`set_creation_time_after(Option<DateTime>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::set_creation_time_after):<br>required: **false**<br><p>A filter that returns only training jobs created after the specified time (timestamp).</p><br>
    ///   - [`creation_time_before(DateTime)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::creation_time_before) / [`set_creation_time_before(Option<DateTime>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::set_creation_time_before):<br>required: **false**<br><p>A filter that returns only training jobs created before the specified time (timestamp).</p><br>
    ///   - [`last_modified_time_after(DateTime)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::last_modified_time_after) / [`set_last_modified_time_after(Option<DateTime>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::set_last_modified_time_after):<br>required: **false**<br><p>A filter that returns only training jobs modified after the specified time (timestamp).</p><br>
    ///   - [`last_modified_time_before(DateTime)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::last_modified_time_before) / [`set_last_modified_time_before(Option<DateTime>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::set_last_modified_time_before):<br>required: **false**<br><p>A filter that returns only training jobs modified before the specified time (timestamp).</p><br>
    ///   - [`name_contains(impl Into<String>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::name_contains) / [`set_name_contains(Option<String>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::set_name_contains):<br>required: **false**<br><p>A string in the training job name. This filter returns only training jobs whose name contains the specified string.</p><br>
    ///   - [`status_equals(TrainingJobStatus)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::status_equals) / [`set_status_equals(Option<TrainingJobStatus>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::set_status_equals):<br>required: **false**<br><p>A filter that retrieves only training jobs with a specific status.</p><br>
    ///   - [`sort_by(SortBy)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::sort_by) / [`set_sort_by(Option<SortBy>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::set_sort_by):<br>required: **false**<br><p>The field to sort results by. The default is <code>CreationTime</code>.</p><br>
    ///   - [`sort_order(SortOrder)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for results. The default is <code>Ascending</code>.</p><br>
    ///   - [`warm_pool_status_equals(WarmPoolResourceStatus)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::warm_pool_status_equals) / [`set_warm_pool_status_equals(Option<WarmPoolResourceStatus>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::set_warm_pool_status_equals):<br>required: **false**<br><p>A filter that retrieves only training jobs with a specific warm pool status.</p><br>
    ///   - [`training_plan_arn_equals(impl Into<String>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::training_plan_arn_equals) / [`set_training_plan_arn_equals(Option<String>)`](crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::set_training_plan_arn_equals):<br>required: **false**<br><p>The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a> </code>.</p><br>
    /// - On success, responds with [`ListTrainingJobsOutput`](crate::operation::list_training_jobs::ListTrainingJobsOutput) with field(s):
    ///   - [`training_job_summaries(Option<Vec::<TrainingJobSummary>>)`](crate::operation::list_training_jobs::ListTrainingJobsOutput::training_job_summaries): <p>An array of <code>TrainingJobSummary</code> objects, each listing a training job.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_training_jobs::ListTrainingJobsOutput::next_token): <p>If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.</p>
    /// - On failure, responds with [`SdkError<ListTrainingJobsError>`](crate::operation::list_training_jobs::ListTrainingJobsError)
    pub fn list_training_jobs(&self) -> crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder {
        crate::operation::list_training_jobs::builders::ListTrainingJobsFluentBuilder::new(self.handle.clone())
    }
}