Struct aws_sdk_sagemaker::client::fluent_builders::ListTrainingJobs

pub struct ListTrainingJobs { /* private fields */ }

Fluent builder constructing a request to ListTrainingJobs.

Lists training jobs.

When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

For example, if ListTrainingJobs is invoked with the following parameters:

{ ... MaxResults: 100, StatusEquals: InProgress ... }

First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

You can quickly test the API using the following Amazon Web Services CLI code.

aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

Implementations

impl ListTrainingJobs

pub async fn customize(
    self
) -> Result<CustomizableOperation<ListTrainingJobs, AwsResponseRetryClassifier>, SdkError<ListTrainingJobsError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<ListTrainingJobsOutput, SdkError<ListTrainingJobsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> ListTrainingJobsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn next_token(self, input: impl Into<String>) -> Self

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

pub fn set_next_token(self, input: Option<String>) -> Self

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

pub fn max_results(self, input: i32) -> Self

The maximum number of training jobs to return in the response.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of training jobs to return in the response.

pub fn creation_time_after(self, input: DateTime) -> Self

A filter that returns only training jobs created after the specified time (timestamp).

pub fn set_creation_time_after(self, input: Option<DateTime>) -> Self

A filter that returns only training jobs created after the specified time (timestamp).

pub fn creation_time_before(self, input: DateTime) -> Self

A filter that returns only training jobs created before the specified time (timestamp).

pub fn set_creation_time_before(self, input: Option<DateTime>) -> Self

A filter that returns only training jobs created before the specified time (timestamp).

pub fn last_modified_time_after(self, input: DateTime) -> Self

A filter that returns only training jobs modified after the specified time (timestamp).

pub fn set_last_modified_time_after(self, input: Option<DateTime>) -> Self

A filter that returns only training jobs modified after the specified time (timestamp).

pub fn last_modified_time_before(self, input: DateTime) -> Self

A filter that returns only training jobs modified before the specified time (timestamp).

pub fn set_last_modified_time_before(self, input: Option<DateTime>) -> Self

A filter that returns only training jobs modified before the specified time (timestamp).

pub fn name_contains(self, input: impl Into<String>) -> Self

A string in the training job name. This filter returns only training jobs whose name contains the specified string.

pub fn set_name_contains(self, input: Option<String>) -> Self

A string in the training job name. This filter returns only training jobs whose name contains the specified string.

pub fn status_equals(self, input: TrainingJobStatus) -> Self

A filter that retrieves only training jobs with a specific status.

pub fn set_status_equals(self, input: Option<TrainingJobStatus>) -> Self

A filter that retrieves only training jobs with a specific status.

pub fn sort_by(self, input: SortBy) -> Self

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

pub fn set_sort_by(self, input: Option<SortBy>) -> Self

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

pub fn sort_order(self, input: SortOrder) -> Self

The sort order for results. The default is Ascending.

pub fn set_sort_order(self, input: Option<SortOrder>) -> Self

The sort order for results. The default is Ascending.

pub fn warm_pool_status_equals(self, input: WarmPoolResourceStatus) -> Self

A filter that retrieves only training jobs with a specific warm pool status.

pub fn set_warm_pool_status_equals(
    self,
    input: Option<WarmPoolResourceStatus>
) -> Self

A filter that retrieves only training jobs with a specific warm pool status.

Trait Implementations

impl Clone for ListTrainingJobs

fn clone(&self) -> ListTrainingJobs

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListTrainingJobs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.