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
293
294
295
296
297
298
299
300
301
302
303
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct SubmitServiceJobInput {
/// <p>The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>
pub job_name: ::std::option::Option<::std::string::String>,
/// <p>The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type <code>SAGEMAKER_TRAINING</code>.</p>
pub job_queue: ::std::option::Option<::std::string::String>,
/// <p>The retry strategy to use for failed service jobs that are submitted with this service job request.</p>
pub retry_strategy: ::std::option::Option<crate::types::ServiceJobRetryStrategy>,
/// <p>The scheduling priority of the service job. Valid values are integers between 0 and 9999.</p>
pub scheduling_priority: ::std::option::Option<i32>,
/// <p>The request, in JSON, for the service that the SubmitServiceJob operation is queueing.</p>
pub service_request_payload: ::std::option::Option<::std::string::String>,
/// <p>The type of service job. For SageMaker Training jobs, specify <code>SAGEMAKER_TRAINING</code>.</p>
pub service_job_type: ::std::option::Option<crate::types::ServiceJobType>,
/// <p>The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.</p>
pub share_identifier: ::std::option::Option<::std::string::String>,
/// <p>The quota share for the service job. Don't specify this parameter if the job queue doesn't have a quota share scheduling policy. If the job queue has a quota share scheduling policy, then this parameter must be specified.</p>
pub quota_share_name: ::std::option::Option<::std::string::String>,
/// <p>Specifies the service job behavior when preempted.</p>
pub preemption_configuration: ::std::option::Option<crate::types::ServiceJobPreemptionConfiguration>,
/// <p>The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.</p>
pub timeout_config: ::std::option::Option<crate::types::ServiceJobTimeout>,
/// <p>The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and <code>clientToken</code>s are received, these requests are considered the same request and the second request is rejected.</p>
pub client_token: ::std::option::Option<::std::string::String>,
}
impl SubmitServiceJobInput {
/// <p>The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>
pub fn job_name(&self) -> ::std::option::Option<&str> {
self.job_name.as_deref()
}
/// <p>The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type <code>SAGEMAKER_TRAINING</code>.</p>
pub fn job_queue(&self) -> ::std::option::Option<&str> {
self.job_queue.as_deref()
}
/// <p>The retry strategy to use for failed service jobs that are submitted with this service job request.</p>
pub fn retry_strategy(&self) -> ::std::option::Option<&crate::types::ServiceJobRetryStrategy> {
self.retry_strategy.as_ref()
}
/// <p>The scheduling priority of the service job. Valid values are integers between 0 and 9999.</p>
pub fn scheduling_priority(&self) -> ::std::option::Option<i32> {
self.scheduling_priority
}
/// <p>The request, in JSON, for the service that the SubmitServiceJob operation is queueing.</p>
pub fn service_request_payload(&self) -> ::std::option::Option<&str> {
self.service_request_payload.as_deref()
}
/// <p>The type of service job. For SageMaker Training jobs, specify <code>SAGEMAKER_TRAINING</code>.</p>
pub fn service_job_type(&self) -> ::std::option::Option<&crate::types::ServiceJobType> {
self.service_job_type.as_ref()
}
/// <p>The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.</p>
pub fn share_identifier(&self) -> ::std::option::Option<&str> {
self.share_identifier.as_deref()
}
/// <p>The quota share for the service job. Don't specify this parameter if the job queue doesn't have a quota share scheduling policy. If the job queue has a quota share scheduling policy, then this parameter must be specified.</p>
pub fn quota_share_name(&self) -> ::std::option::Option<&str> {
self.quota_share_name.as_deref()
}
/// <p>Specifies the service job behavior when preempted.</p>
pub fn preemption_configuration(&self) -> ::std::option::Option<&crate::types::ServiceJobPreemptionConfiguration> {
self.preemption_configuration.as_ref()
}
/// <p>The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.</p>
pub fn timeout_config(&self) -> ::std::option::Option<&crate::types::ServiceJobTimeout> {
self.timeout_config.as_ref()
}
/// <p>The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.tags.as_ref()
}
/// <p>A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and <code>clientToken</code>s are received, these requests are considered the same request and the second request is rejected.</p>
pub fn client_token(&self) -> ::std::option::Option<&str> {
self.client_token.as_deref()
}
}
impl SubmitServiceJobInput {
/// Creates a new builder-style object to manufacture [`SubmitServiceJobInput`](crate::operation::submit_service_job::SubmitServiceJobInput).
pub fn builder() -> crate::operation::submit_service_job::builders::SubmitServiceJobInputBuilder {
crate::operation::submit_service_job::builders::SubmitServiceJobInputBuilder::default()
}
}
/// A builder for [`SubmitServiceJobInput`](crate::operation::submit_service_job::SubmitServiceJobInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SubmitServiceJobInputBuilder {
pub(crate) job_name: ::std::option::Option<::std::string::String>,
pub(crate) job_queue: ::std::option::Option<::std::string::String>,
pub(crate) retry_strategy: ::std::option::Option<crate::types::ServiceJobRetryStrategy>,
pub(crate) scheduling_priority: ::std::option::Option<i32>,
pub(crate) service_request_payload: ::std::option::Option<::std::string::String>,
pub(crate) service_job_type: ::std::option::Option<crate::types::ServiceJobType>,
pub(crate) share_identifier: ::std::option::Option<::std::string::String>,
pub(crate) quota_share_name: ::std::option::Option<::std::string::String>,
pub(crate) preemption_configuration: ::std::option::Option<crate::types::ServiceJobPreemptionConfiguration>,
pub(crate) timeout_config: ::std::option::Option<crate::types::ServiceJobTimeout>,
pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl SubmitServiceJobInputBuilder {
/// <p>The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>
/// This field is required.
pub fn job_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.job_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>
pub fn set_job_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.job_name = input;
self
}
/// <p>The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>
pub fn get_job_name(&self) -> &::std::option::Option<::std::string::String> {
&self.job_name
}
/// <p>The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type <code>SAGEMAKER_TRAINING</code>.</p>
/// This field is required.
pub fn job_queue(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.job_queue = ::std::option::Option::Some(input.into());
self
}
/// <p>The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type <code>SAGEMAKER_TRAINING</code>.</p>
pub fn set_job_queue(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.job_queue = input;
self
}
/// <p>The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type <code>SAGEMAKER_TRAINING</code>.</p>
pub fn get_job_queue(&self) -> &::std::option::Option<::std::string::String> {
&self.job_queue
}
/// <p>The retry strategy to use for failed service jobs that are submitted with this service job request.</p>
pub fn retry_strategy(mut self, input: crate::types::ServiceJobRetryStrategy) -> Self {
self.retry_strategy = ::std::option::Option::Some(input);
self
}
/// <p>The retry strategy to use for failed service jobs that are submitted with this service job request.</p>
pub fn set_retry_strategy(mut self, input: ::std::option::Option<crate::types::ServiceJobRetryStrategy>) -> Self {
self.retry_strategy = input;
self
}
/// <p>The retry strategy to use for failed service jobs that are submitted with this service job request.</p>
pub fn get_retry_strategy(&self) -> &::std::option::Option<crate::types::ServiceJobRetryStrategy> {
&self.retry_strategy
}
/// <p>The scheduling priority of the service job. Valid values are integers between 0 and 9999.</p>
pub fn scheduling_priority(mut self, input: i32) -> Self {
self.scheduling_priority = ::std::option::Option::Some(input);
self
}
/// <p>The scheduling priority of the service job. Valid values are integers between 0 and 9999.</p>
pub fn set_scheduling_priority(mut self, input: ::std::option::Option<i32>) -> Self {
self.scheduling_priority = input;
self
}
/// <p>The scheduling priority of the service job. Valid values are integers between 0 and 9999.</p>
pub fn get_scheduling_priority(&self) -> &::std::option::Option<i32> {
&self.scheduling_priority
}
/// <p>The request, in JSON, for the service that the SubmitServiceJob operation is queueing.</p>
/// This field is required.
pub fn service_request_payload(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.service_request_payload = ::std::option::Option::Some(input.into());
self
}
/// <p>The request, in JSON, for the service that the SubmitServiceJob operation is queueing.</p>
pub fn set_service_request_payload(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.service_request_payload = input;
self
}
/// <p>The request, in JSON, for the service that the SubmitServiceJob operation is queueing.</p>
pub fn get_service_request_payload(&self) -> &::std::option::Option<::std::string::String> {
&self.service_request_payload
}
/// <p>The type of service job. For SageMaker Training jobs, specify <code>SAGEMAKER_TRAINING</code>.</p>
/// This field is required.
pub fn service_job_type(mut self, input: crate::types::ServiceJobType) -> Self {
self.service_job_type = ::std::option::Option::Some(input);
self
}
/// <p>The type of service job. For SageMaker Training jobs, specify <code>SAGEMAKER_TRAINING</code>.</p>
pub fn set_service_job_type(mut self, input: ::std::option::Option<crate::types::ServiceJobType>) -> Self {
self.service_job_type = input;
self
}
/// <p>The type of service job. For SageMaker Training jobs, specify <code>SAGEMAKER_TRAINING</code>.</p>
pub fn get_service_job_type(&self) -> &::std::option::Option<crate::types::ServiceJobType> {
&self.service_job_type
}
/// <p>The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.</p>
pub fn share_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.share_identifier = ::std::option::Option::Some(input.into());
self
}
/// <p>The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.</p>
pub fn set_share_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.share_identifier = input;
self
}
/// <p>The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.</p>
pub fn get_share_identifier(&self) -> &::std::option::Option<::std::string::String> {
&self.share_identifier
}
/// <p>The quota share for the service job. Don't specify this parameter if the job queue doesn't have a quota share scheduling policy. If the job queue has a quota share scheduling policy, then this parameter must be specified.</p>
pub fn quota_share_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.quota_share_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The quota share for the service job. Don't specify this parameter if the job queue doesn't have a quota share scheduling policy. If the job queue has a quota share scheduling policy, then this parameter must be specified.</p>
pub fn set_quota_share_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.quota_share_name = input;
self
}
/// <p>The quota share for the service job. Don't specify this parameter if the job queue doesn't have a quota share scheduling policy. If the job queue has a quota share scheduling policy, then this parameter must be specified.</p>
pub fn get_quota_share_name(&self) -> &::std::option::Option<::std::string::String> {
&self.quota_share_name
}
/// <p>Specifies the service job behavior when preempted.</p>
pub fn preemption_configuration(mut self, input: crate::types::ServiceJobPreemptionConfiguration) -> Self {
self.preemption_configuration = ::std::option::Option::Some(input);
self
}
/// <p>Specifies the service job behavior when preempted.</p>
pub fn set_preemption_configuration(mut self, input: ::std::option::Option<crate::types::ServiceJobPreemptionConfiguration>) -> Self {
self.preemption_configuration = input;
self
}
/// <p>Specifies the service job behavior when preempted.</p>
pub fn get_preemption_configuration(&self) -> &::std::option::Option<crate::types::ServiceJobPreemptionConfiguration> {
&self.preemption_configuration
}
/// <p>The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.</p>
pub fn timeout_config(mut self, input: crate::types::ServiceJobTimeout) -> Self {
self.timeout_config = ::std::option::Option::Some(input);
self
}
/// <p>The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.</p>
pub fn set_timeout_config(mut self, input: ::std::option::Option<crate::types::ServiceJobTimeout>) -> Self {
self.timeout_config = input;
self
}
/// <p>The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.</p>
pub fn get_timeout_config(&self) -> &::std::option::Option<crate::types::ServiceJobTimeout> {
&self.timeout_config
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut hash_map = self.tags.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.tags = ::std::option::Option::Some(hash_map);
self
}
/// <p>The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
self.tags = input;
self
}
/// <p>The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.tags
}
/// <p>A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and <code>clientToken</code>s are received, these requests are considered the same request and the second request is rejected.</p>
pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.client_token = ::std::option::Option::Some(input.into());
self
}
/// <p>A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and <code>clientToken</code>s are received, these requests are considered the same request and the second request is rejected.</p>
pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.client_token = input;
self
}
/// <p>A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and <code>clientToken</code>s are received, these requests are considered the same request and the second request is rejected.</p>
pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
&self.client_token
}
/// Consumes the builder and constructs a [`SubmitServiceJobInput`](crate::operation::submit_service_job::SubmitServiceJobInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::submit_service_job::SubmitServiceJobInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::submit_service_job::SubmitServiceJobInput {
job_name: self.job_name,
job_queue: self.job_queue,
retry_strategy: self.retry_strategy,
scheduling_priority: self.scheduling_priority,
service_request_payload: self.service_request_payload,
service_job_type: self.service_job_type,
share_identifier: self.share_identifier,
quota_share_name: self.quota_share_name,
preemption_configuration: self.preemption_configuration,
timeout_config: self.timeout_config,
tags: self.tags,
client_token: self.client_token,
})
}
}