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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
// 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 CreateProfileJobInput {
/// <p>The name of the dataset that this job is to act upon.</p>
pub dataset_name: ::std::option::Option<::std::string::String>,
/// <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.</p>
pub encryption_key_arn: ::std::option::Option<::std::string::String>,
/// <p>The encryption mode for the job, which can be one of the following:</p>
/// <ul>
/// <li>
/// <p><code>SSE-KMS</code> - <code>SSE-KMS</code> - Server-side encryption with KMS-managed keys.</p></li>
/// <li>
/// <p><code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p></li>
/// </ul>
pub encryption_mode: ::std::option::Option<crate::types::EncryptionMode>,
/// <p>The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>
pub log_subscription: ::std::option::Option<crate::types::LogSubscription>,
/// <p>The maximum number of nodes that DataBrew can use when the job processes data.</p>
pub max_capacity: ::std::option::Option<i32>,
/// <p>The maximum number of times to retry the job after a job run fails.</p>
pub max_retries: ::std::option::Option<i32>,
/// <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.</p>
pub output_location: ::std::option::Option<crate::types::S3Location>,
/// <p>Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.</p>
pub configuration: ::std::option::Option<crate::types::ProfileConfiguration>,
/// <p>List of validation configurations that are applied to the profile job.</p>
pub validation_configurations: ::std::option::Option<::std::vec::Vec<crate::types::ValidationConfiguration>>,
/// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>
pub role_arn: ::std::option::Option<::std::string::String>,
/// <p>Metadata tags to apply to this job.</p>
pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>
pub timeout: ::std::option::Option<i32>,
/// <p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>
pub job_sample: ::std::option::Option<crate::types::JobSample>,
}
impl CreateProfileJobInput {
/// <p>The name of the dataset that this job is to act upon.</p>
pub fn dataset_name(&self) -> ::std::option::Option<&str> {
self.dataset_name.as_deref()
}
/// <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.</p>
pub fn encryption_key_arn(&self) -> ::std::option::Option<&str> {
self.encryption_key_arn.as_deref()
}
/// <p>The encryption mode for the job, which can be one of the following:</p>
/// <ul>
/// <li>
/// <p><code>SSE-KMS</code> - <code>SSE-KMS</code> - Server-side encryption with KMS-managed keys.</p></li>
/// <li>
/// <p><code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p></li>
/// </ul>
pub fn encryption_mode(&self) -> ::std::option::Option<&crate::types::EncryptionMode> {
self.encryption_mode.as_ref()
}
/// <p>The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>
pub fn log_subscription(&self) -> ::std::option::Option<&crate::types::LogSubscription> {
self.log_subscription.as_ref()
}
/// <p>The maximum number of nodes that DataBrew can use when the job processes data.</p>
pub fn max_capacity(&self) -> ::std::option::Option<i32> {
self.max_capacity
}
/// <p>The maximum number of times to retry the job after a job run fails.</p>
pub fn max_retries(&self) -> ::std::option::Option<i32> {
self.max_retries
}
/// <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.</p>
pub fn output_location(&self) -> ::std::option::Option<&crate::types::S3Location> {
self.output_location.as_ref()
}
/// <p>Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.</p>
pub fn configuration(&self) -> ::std::option::Option<&crate::types::ProfileConfiguration> {
self.configuration.as_ref()
}
/// <p>List of validation configurations that are applied to the profile job.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.validation_configurations.is_none()`.
pub fn validation_configurations(&self) -> &[crate::types::ValidationConfiguration] {
self.validation_configurations.as_deref().unwrap_or_default()
}
/// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>
pub fn role_arn(&self) -> ::std::option::Option<&str> {
self.role_arn.as_deref()
}
/// <p>Metadata tags to apply to this job.</p>
pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.tags.as_ref()
}
/// <p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>
pub fn timeout(&self) -> ::std::option::Option<i32> {
self.timeout
}
/// <p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>
pub fn job_sample(&self) -> ::std::option::Option<&crate::types::JobSample> {
self.job_sample.as_ref()
}
}
impl CreateProfileJobInput {
/// Creates a new builder-style object to manufacture [`CreateProfileJobInput`](crate::operation::create_profile_job::CreateProfileJobInput).
pub fn builder() -> crate::operation::create_profile_job::builders::CreateProfileJobInputBuilder {
crate::operation::create_profile_job::builders::CreateProfileJobInputBuilder::default()
}
}
/// A builder for [`CreateProfileJobInput`](crate::operation::create_profile_job::CreateProfileJobInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateProfileJobInputBuilder {
pub(crate) dataset_name: ::std::option::Option<::std::string::String>,
pub(crate) encryption_key_arn: ::std::option::Option<::std::string::String>,
pub(crate) encryption_mode: ::std::option::Option<crate::types::EncryptionMode>,
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) log_subscription: ::std::option::Option<crate::types::LogSubscription>,
pub(crate) max_capacity: ::std::option::Option<i32>,
pub(crate) max_retries: ::std::option::Option<i32>,
pub(crate) output_location: ::std::option::Option<crate::types::S3Location>,
pub(crate) configuration: ::std::option::Option<crate::types::ProfileConfiguration>,
pub(crate) validation_configurations: ::std::option::Option<::std::vec::Vec<crate::types::ValidationConfiguration>>,
pub(crate) role_arn: ::std::option::Option<::std::string::String>,
pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) timeout: ::std::option::Option<i32>,
pub(crate) job_sample: ::std::option::Option<crate::types::JobSample>,
}
impl CreateProfileJobInputBuilder {
/// <p>The name of the dataset that this job is to act upon.</p>
/// This field is required.
pub fn dataset_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.dataset_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the dataset that this job is to act upon.</p>
pub fn set_dataset_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.dataset_name = input;
self
}
/// <p>The name of the dataset that this job is to act upon.</p>
pub fn get_dataset_name(&self) -> &::std::option::Option<::std::string::String> {
&self.dataset_name
}
/// <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.</p>
pub fn encryption_key_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.encryption_key_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.</p>
pub fn set_encryption_key_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.encryption_key_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.</p>
pub fn get_encryption_key_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.encryption_key_arn
}
/// <p>The encryption mode for the job, which can be one of the following:</p>
/// <ul>
/// <li>
/// <p><code>SSE-KMS</code> - <code>SSE-KMS</code> - Server-side encryption with KMS-managed keys.</p></li>
/// <li>
/// <p><code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p></li>
/// </ul>
pub fn encryption_mode(mut self, input: crate::types::EncryptionMode) -> Self {
self.encryption_mode = ::std::option::Option::Some(input);
self
}
/// <p>The encryption mode for the job, which can be one of the following:</p>
/// <ul>
/// <li>
/// <p><code>SSE-KMS</code> - <code>SSE-KMS</code> - Server-side encryption with KMS-managed keys.</p></li>
/// <li>
/// <p><code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p></li>
/// </ul>
pub fn set_encryption_mode(mut self, input: ::std::option::Option<crate::types::EncryptionMode>) -> Self {
self.encryption_mode = input;
self
}
/// <p>The encryption mode for the job, which can be one of the following:</p>
/// <ul>
/// <li>
/// <p><code>SSE-KMS</code> - <code>SSE-KMS</code> - Server-side encryption with KMS-managed keys.</p></li>
/// <li>
/// <p><code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p></li>
/// </ul>
pub fn get_encryption_mode(&self) -> &::std::option::Option<crate::types::EncryptionMode> {
&self.encryption_mode
}
/// <p>The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>
/// This field is required.
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>
pub fn log_subscription(mut self, input: crate::types::LogSubscription) -> Self {
self.log_subscription = ::std::option::Option::Some(input);
self
}
/// <p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>
pub fn set_log_subscription(mut self, input: ::std::option::Option<crate::types::LogSubscription>) -> Self {
self.log_subscription = input;
self
}
/// <p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>
pub fn get_log_subscription(&self) -> &::std::option::Option<crate::types::LogSubscription> {
&self.log_subscription
}
/// <p>The maximum number of nodes that DataBrew can use when the job processes data.</p>
pub fn max_capacity(mut self, input: i32) -> Self {
self.max_capacity = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of nodes that DataBrew can use when the job processes data.</p>
pub fn set_max_capacity(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_capacity = input;
self
}
/// <p>The maximum number of nodes that DataBrew can use when the job processes data.</p>
pub fn get_max_capacity(&self) -> &::std::option::Option<i32> {
&self.max_capacity
}
/// <p>The maximum number of times to retry the job after a job run fails.</p>
pub fn max_retries(mut self, input: i32) -> Self {
self.max_retries = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of times to retry the job after a job run fails.</p>
pub fn set_max_retries(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_retries = input;
self
}
/// <p>The maximum number of times to retry the job after a job run fails.</p>
pub fn get_max_retries(&self) -> &::std::option::Option<i32> {
&self.max_retries
}
/// <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.</p>
/// This field is required.
pub fn output_location(mut self, input: crate::types::S3Location) -> Self {
self.output_location = ::std::option::Option::Some(input);
self
}
/// <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.</p>
pub fn set_output_location(mut self, input: ::std::option::Option<crate::types::S3Location>) -> Self {
self.output_location = input;
self
}
/// <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.</p>
pub fn get_output_location(&self) -> &::std::option::Option<crate::types::S3Location> {
&self.output_location
}
/// <p>Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.</p>
pub fn configuration(mut self, input: crate::types::ProfileConfiguration) -> Self {
self.configuration = ::std::option::Option::Some(input);
self
}
/// <p>Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.</p>
pub fn set_configuration(mut self, input: ::std::option::Option<crate::types::ProfileConfiguration>) -> Self {
self.configuration = input;
self
}
/// <p>Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.</p>
pub fn get_configuration(&self) -> &::std::option::Option<crate::types::ProfileConfiguration> {
&self.configuration
}
/// Appends an item to `validation_configurations`.
///
/// To override the contents of this collection use [`set_validation_configurations`](Self::set_validation_configurations).
///
/// <p>List of validation configurations that are applied to the profile job.</p>
pub fn validation_configurations(mut self, input: crate::types::ValidationConfiguration) -> Self {
let mut v = self.validation_configurations.unwrap_or_default();
v.push(input);
self.validation_configurations = ::std::option::Option::Some(v);
self
}
/// <p>List of validation configurations that are applied to the profile job.</p>
pub fn set_validation_configurations(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ValidationConfiguration>>) -> Self {
self.validation_configurations = input;
self
}
/// <p>List of validation configurations that are applied to the profile job.</p>
pub fn get_validation_configurations(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ValidationConfiguration>> {
&self.validation_configurations
}
/// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>
/// This field is required.
pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>
pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.role_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>
pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.role_arn
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>Metadata tags to apply to this job.</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>Metadata tags to apply to this job.</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>Metadata tags to apply to this job.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.tags
}
/// <p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>
pub fn timeout(mut self, input: i32) -> Self {
self.timeout = ::std::option::Option::Some(input);
self
}
/// <p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>
pub fn set_timeout(mut self, input: ::std::option::Option<i32>) -> Self {
self.timeout = input;
self
}
/// <p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>
pub fn get_timeout(&self) -> &::std::option::Option<i32> {
&self.timeout
}
/// <p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>
pub fn job_sample(mut self, input: crate::types::JobSample) -> Self {
self.job_sample = ::std::option::Option::Some(input);
self
}
/// <p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>
pub fn set_job_sample(mut self, input: ::std::option::Option<crate::types::JobSample>) -> Self {
self.job_sample = input;
self
}
/// <p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>
pub fn get_job_sample(&self) -> &::std::option::Option<crate::types::JobSample> {
&self.job_sample
}
/// Consumes the builder and constructs a [`CreateProfileJobInput`](crate::operation::create_profile_job::CreateProfileJobInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_profile_job::CreateProfileJobInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_profile_job::CreateProfileJobInput {
dataset_name: self.dataset_name,
encryption_key_arn: self.encryption_key_arn,
encryption_mode: self.encryption_mode,
name: self.name,
log_subscription: self.log_subscription,
max_capacity: self.max_capacity,
max_retries: self.max_retries,
output_location: self.output_location,
configuration: self.configuration,
validation_configurations: self.validation_configurations,
role_arn: self.role_arn,
tags: self.tags,
timeout: self.timeout,
job_sample: self.job_sample,
})
}
}