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
// 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 CreateJobInput {
/// <p>The Amazon Web Services account ID that creates the job.</p>
pub account_id: ::std::option::Option<::std::string::String>,
/// <p>Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.</p>
pub confirmation_required: ::std::option::Option<bool>,
/// <p>The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html">Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
pub operation: ::std::option::Option<crate::types::JobOperation>,
/// <p>Configuration parameters for the optional job-completion report.</p>
pub report: ::std::option::Option<crate::types::JobReport>,
/// <p>An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.</p>
pub client_request_token: ::std::option::Option<::std::string::String>,
/// <p>Configuration parameters for the manifest.</p>
pub manifest: ::std::option::Option<crate::types::JobManifest>,
/// <p>A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The numerical priority for this job. Higher numbers indicate higher priority.</p>
pub priority: ::std::option::Option<i32>,
/// <p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.</p>
pub role_arn: ::std::option::Option<::std::string::String>,
/// <p>A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::S3Tag>>,
/// <p>The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.</p>
pub manifest_generator: ::std::option::Option<crate::types::JobManifestGenerator>,
}
impl CreateJobInput {
/// <p>The Amazon Web Services account ID that creates the job.</p>
pub fn account_id(&self) -> ::std::option::Option<&str> {
self.account_id.as_deref()
}
/// <p>Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.</p>
pub fn confirmation_required(&self) -> ::std::option::Option<bool> {
self.confirmation_required
}
/// <p>The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html">Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn operation(&self) -> ::std::option::Option<&crate::types::JobOperation> {
self.operation.as_ref()
}
/// <p>Configuration parameters for the optional job-completion report.</p>
pub fn report(&self) -> ::std::option::Option<&crate::types::JobReport> {
self.report.as_ref()
}
/// <p>An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.</p>
pub fn client_request_token(&self) -> ::std::option::Option<&str> {
self.client_request_token.as_deref()
}
/// <p>Configuration parameters for the manifest.</p>
pub fn manifest(&self) -> ::std::option::Option<&crate::types::JobManifest> {
self.manifest.as_ref()
}
/// <p>A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The numerical priority for this job. Higher numbers indicate higher priority.</p>
pub fn priority(&self) -> ::std::option::Option<i32> {
self.priority
}
/// <p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.</p>
pub fn role_arn(&self) -> ::std::option::Option<&str> {
self.role_arn.as_deref()
}
/// <p>A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.</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 `.tags.is_none()`.
pub fn tags(&self) -> &[crate::types::S3Tag] {
self.tags.as_deref().unwrap_or_default()
}
/// <p>The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.</p>
pub fn manifest_generator(&self) -> ::std::option::Option<&crate::types::JobManifestGenerator> {
self.manifest_generator.as_ref()
}
}
impl CreateJobInput {
/// Creates a new builder-style object to manufacture [`CreateJobInput`](crate::operation::create_job::CreateJobInput).
pub fn builder() -> crate::operation::create_job::builders::CreateJobInputBuilder {
crate::operation::create_job::builders::CreateJobInputBuilder::default()
}
}
/// A builder for [`CreateJobInput`](crate::operation::create_job::CreateJobInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateJobInputBuilder {
pub(crate) account_id: ::std::option::Option<::std::string::String>,
pub(crate) confirmation_required: ::std::option::Option<bool>,
pub(crate) operation: ::std::option::Option<crate::types::JobOperation>,
pub(crate) report: ::std::option::Option<crate::types::JobReport>,
pub(crate) client_request_token: ::std::option::Option<::std::string::String>,
pub(crate) manifest: ::std::option::Option<crate::types::JobManifest>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) priority: ::std::option::Option<i32>,
pub(crate) role_arn: ::std::option::Option<::std::string::String>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::S3Tag>>,
pub(crate) manifest_generator: ::std::option::Option<crate::types::JobManifestGenerator>,
}
impl CreateJobInputBuilder {
/// <p>The Amazon Web Services account ID that creates the job.</p>
/// This field is required.
pub fn account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.account_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Web Services account ID that creates the job.</p>
pub fn set_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.account_id = input;
self
}
/// <p>The Amazon Web Services account ID that creates the job.</p>
pub fn get_account_id(&self) -> &::std::option::Option<::std::string::String> {
&self.account_id
}
/// <p>Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.</p>
pub fn confirmation_required(mut self, input: bool) -> Self {
self.confirmation_required = ::std::option::Option::Some(input);
self
}
/// <p>Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.</p>
pub fn set_confirmation_required(mut self, input: ::std::option::Option<bool>) -> Self {
self.confirmation_required = input;
self
}
/// <p>Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.</p>
pub fn get_confirmation_required(&self) -> &::std::option::Option<bool> {
&self.confirmation_required
}
/// <p>The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html">Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
/// This field is required.
pub fn operation(mut self, input: crate::types::JobOperation) -> Self {
self.operation = ::std::option::Option::Some(input);
self
}
/// <p>The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html">Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn set_operation(mut self, input: ::std::option::Option<crate::types::JobOperation>) -> Self {
self.operation = input;
self
}
/// <p>The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html">Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn get_operation(&self) -> &::std::option::Option<crate::types::JobOperation> {
&self.operation
}
/// <p>Configuration parameters for the optional job-completion report.</p>
/// This field is required.
pub fn report(mut self, input: crate::types::JobReport) -> Self {
self.report = ::std::option::Option::Some(input);
self
}
/// <p>Configuration parameters for the optional job-completion report.</p>
pub fn set_report(mut self, input: ::std::option::Option<crate::types::JobReport>) -> Self {
self.report = input;
self
}
/// <p>Configuration parameters for the optional job-completion report.</p>
pub fn get_report(&self) -> &::std::option::Option<crate::types::JobReport> {
&self.report
}
/// <p>An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.</p>
/// This field is required.
pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.client_request_token = ::std::option::Option::Some(input.into());
self
}
/// <p>An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.</p>
pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.client_request_token = input;
self
}
/// <p>An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.</p>
pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
&self.client_request_token
}
/// <p>Configuration parameters for the manifest.</p>
pub fn manifest(mut self, input: crate::types::JobManifest) -> Self {
self.manifest = ::std::option::Option::Some(input);
self
}
/// <p>Configuration parameters for the manifest.</p>
pub fn set_manifest(mut self, input: ::std::option::Option<crate::types::JobManifest>) -> Self {
self.manifest = input;
self
}
/// <p>Configuration parameters for the manifest.</p>
pub fn get_manifest(&self) -> &::std::option::Option<crate::types::JobManifest> {
&self.manifest
}
/// <p>A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The numerical priority for this job. Higher numbers indicate higher priority.</p>
/// This field is required.
pub fn priority(mut self, input: i32) -> Self {
self.priority = ::std::option::Option::Some(input);
self
}
/// <p>The numerical priority for this job. Higher numbers indicate higher priority.</p>
pub fn set_priority(mut self, input: ::std::option::Option<i32>) -> Self {
self.priority = input;
self
}
/// <p>The numerical priority for this job. Higher numbers indicate higher priority.</p>
pub fn get_priority(&self) -> &::std::option::Option<i32> {
&self.priority
}
/// <p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.</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) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.</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) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.</p>
pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.role_arn
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.</p>
pub fn tags(mut self, input: crate::types::S3Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::S3Tag>>) -> Self {
self.tags = input;
self
}
/// <p>A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::S3Tag>> {
&self.tags
}
/// <p>The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.</p>
pub fn manifest_generator(mut self, input: crate::types::JobManifestGenerator) -> Self {
self.manifest_generator = ::std::option::Option::Some(input);
self
}
/// <p>The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.</p>
pub fn set_manifest_generator(mut self, input: ::std::option::Option<crate::types::JobManifestGenerator>) -> Self {
self.manifest_generator = input;
self
}
/// <p>The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.</p>
pub fn get_manifest_generator(&self) -> &::std::option::Option<crate::types::JobManifestGenerator> {
&self.manifest_generator
}
/// Consumes the builder and constructs a [`CreateJobInput`](crate::operation::create_job::CreateJobInput).
pub fn build(self) -> ::std::result::Result<crate::operation::create_job::CreateJobInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_job::CreateJobInput {
account_id: self.account_id,
confirmation_required: self.confirmation_required,
operation: self.operation,
report: self.report,
client_request_token: self.client_request_token,
manifest: self.manifest,
description: self.description,
priority: self.priority,
role_arn: self.role_arn,
tags: self.tags,
manifest_generator: self.manifest_generator,
})
}
}