1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::list_training_jobs::_list_training_jobs_input::ListTrainingJobsInputBuilder;
pub use crate::operation::list_training_jobs::_list_training_jobs_output::ListTrainingJobsOutputBuilder;
impl crate::operation::list_training_jobs::builders::ListTrainingJobsInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::list_training_jobs::ListTrainingJobsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::list_training_jobs::ListTrainingJobsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.list_training_jobs();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `ListTrainingJobs`.
///
/// <p>Lists training jobs.</p><note>
/// <p>When <code>StatusEquals</code> and <code>MaxResults</code> are set at the same time, the <code>MaxResults</code> number of training jobs are first retrieved ignoring the <code>StatusEquals</code> parameter and then they are filtered by the <code>StatusEquals</code> parameter, which is returned as a response.</p>
/// <p>For example, if <code>ListTrainingJobs</code> is invoked with the following parameters:</p>
/// <p><code>{ ... MaxResults: 100, StatusEquals: InProgress ... }</code></p>
/// <p>First, 100 trainings jobs with any status, including those other than <code>InProgress</code>, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of <code>InProgress</code> are returned.</p>
/// <p>You can quickly test the API using the following Amazon Web Services CLI code.</p>
/// <p><code>aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress</code></p>
/// </note>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ListTrainingJobsFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::list_training_jobs::builders::ListTrainingJobsInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::list_training_jobs::ListTrainingJobsOutput,
crate::operation::list_training_jobs::ListTrainingJobsError,
> for ListTrainingJobsFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::list_training_jobs::ListTrainingJobsOutput,
crate::operation::list_training_jobs::ListTrainingJobsError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl ListTrainingJobsFluentBuilder {
/// Creates a new `ListTrainingJobsFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the ListTrainingJobs as a reference.
pub fn as_input(&self) -> &crate::operation::list_training_jobs::builders::ListTrainingJobsInputBuilder {
&self.inner
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::list_training_jobs::ListTrainingJobsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::list_training_jobs::ListTrainingJobsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::list_training_jobs::ListTrainingJobs::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::list_training_jobs::ListTrainingJobs::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::list_training_jobs::ListTrainingJobsOutput,
crate::operation::list_training_jobs::ListTrainingJobsError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::operation::list_training_jobs::paginator::ListTrainingJobsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
pub fn into_paginator(self) -> crate::operation::list_training_jobs::paginator::ListTrainingJobsPaginator {
crate::operation::list_training_jobs::paginator::ListTrainingJobsPaginator::new(self.handle, self.inner)
}
/// <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>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <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>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_next_token()
}
/// <p>The maximum number of training jobs to return in the response.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of training jobs to return in the response.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>The maximum number of training jobs to return in the response.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
self.inner.get_max_results()
}
/// <p>A filter that returns only training jobs created after the specified time (timestamp).</p>
pub fn creation_time_after(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.creation_time_after(input);
self
}
/// <p>A filter that returns only training jobs created after the specified time (timestamp).</p>
pub fn set_creation_time_after(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_creation_time_after(input);
self
}
/// <p>A filter that returns only training jobs created after the specified time (timestamp).</p>
pub fn get_creation_time_after(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_creation_time_after()
}
/// <p>A filter that returns only training jobs created before the specified time (timestamp).</p>
pub fn creation_time_before(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.creation_time_before(input);
self
}
/// <p>A filter that returns only training jobs created before the specified time (timestamp).</p>
pub fn set_creation_time_before(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_creation_time_before(input);
self
}
/// <p>A filter that returns only training jobs created before the specified time (timestamp).</p>
pub fn get_creation_time_before(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_creation_time_before()
}
/// <p>A filter that returns only training jobs modified after the specified time (timestamp).</p>
pub fn last_modified_time_after(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.last_modified_time_after(input);
self
}
/// <p>A filter that returns only training jobs modified after the specified time (timestamp).</p>
pub fn set_last_modified_time_after(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_last_modified_time_after(input);
self
}
/// <p>A filter that returns only training jobs modified after the specified time (timestamp).</p>
pub fn get_last_modified_time_after(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_last_modified_time_after()
}
/// <p>A filter that returns only training jobs modified before the specified time (timestamp).</p>
pub fn last_modified_time_before(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.last_modified_time_before(input);
self
}
/// <p>A filter that returns only training jobs modified before the specified time (timestamp).</p>
pub fn set_last_modified_time_before(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_last_modified_time_before(input);
self
}
/// <p>A filter that returns only training jobs modified before the specified time (timestamp).</p>
pub fn get_last_modified_time_before(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_last_modified_time_before()
}
/// <p>A string in the training job name. This filter returns only training jobs whose name contains the specified string.</p>
pub fn name_contains(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.name_contains(input.into());
self
}
/// <p>A string in the training job name. This filter returns only training jobs whose name contains the specified string.</p>
pub fn set_name_contains(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_name_contains(input);
self
}
/// <p>A string in the training job name. This filter returns only training jobs whose name contains the specified string.</p>
pub fn get_name_contains(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_name_contains()
}
/// <p>A filter that retrieves only training jobs with a specific status.</p>
pub fn status_equals(mut self, input: crate::types::TrainingJobStatus) -> Self {
self.inner = self.inner.status_equals(input);
self
}
/// <p>A filter that retrieves only training jobs with a specific status.</p>
pub fn set_status_equals(mut self, input: ::std::option::Option<crate::types::TrainingJobStatus>) -> Self {
self.inner = self.inner.set_status_equals(input);
self
}
/// <p>A filter that retrieves only training jobs with a specific status.</p>
pub fn get_status_equals(&self) -> &::std::option::Option<crate::types::TrainingJobStatus> {
self.inner.get_status_equals()
}
/// <p>The field to sort results by. The default is <code>CreationTime</code>.</p>
pub fn sort_by(mut self, input: crate::types::SortBy) -> Self {
self.inner = self.inner.sort_by(input);
self
}
/// <p>The field to sort results by. The default is <code>CreationTime</code>.</p>
pub fn set_sort_by(mut self, input: ::std::option::Option<crate::types::SortBy>) -> Self {
self.inner = self.inner.set_sort_by(input);
self
}
/// <p>The field to sort results by. The default is <code>CreationTime</code>.</p>
pub fn get_sort_by(&self) -> &::std::option::Option<crate::types::SortBy> {
self.inner.get_sort_by()
}
/// <p>The sort order for results. The default is <code>Ascending</code>.</p>
pub fn sort_order(mut self, input: crate::types::SortOrder) -> Self {
self.inner = self.inner.sort_order(input);
self
}
/// <p>The sort order for results. The default is <code>Ascending</code>.</p>
pub fn set_sort_order(mut self, input: ::std::option::Option<crate::types::SortOrder>) -> Self {
self.inner = self.inner.set_sort_order(input);
self
}
/// <p>The sort order for results. The default is <code>Ascending</code>.</p>
pub fn get_sort_order(&self) -> &::std::option::Option<crate::types::SortOrder> {
self.inner.get_sort_order()
}
/// <p>A filter that retrieves only training jobs with a specific warm pool status.</p>
pub fn warm_pool_status_equals(mut self, input: crate::types::WarmPoolResourceStatus) -> Self {
self.inner = self.inner.warm_pool_status_equals(input);
self
}
/// <p>A filter that retrieves only training jobs with a specific warm pool status.</p>
pub fn set_warm_pool_status_equals(mut self, input: ::std::option::Option<crate::types::WarmPoolResourceStatus>) -> Self {
self.inner = self.inner.set_warm_pool_status_equals(input);
self
}
/// <p>A filter that retrieves only training jobs with a specific warm pool status.</p>
pub fn get_warm_pool_status_equals(&self) -> &::std::option::Option<crate::types::WarmPoolResourceStatus> {
self.inner.get_warm_pool_status_equals()
}
/// <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>
pub fn training_plan_arn_equals(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.training_plan_arn_equals(input.into());
self
}
/// <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>
pub fn set_training_plan_arn_equals(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_training_plan_arn_equals(input);
self
}
/// <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>
pub fn get_training_plan_arn_equals(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_training_plan_arn_equals()
}
}