aws-sdk-simpledbv2 1.5.0

AWS SDK for Amazon SimpleDB v2
Documentation
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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
// 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 GetExportOutput {
    /// Unique ARN identifier of the export.
    pub export_arn: ::std::string::String,
    /// The client token provided for this export.
    pub client_token: ::std::string::String,
    /// The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error.
    pub export_status: crate::types::ExportStatus,
    /// The name of the domain that was exported.
    pub domain_name: ::std::string::String,
    /// Timestamp when the export request was received by the service.
    pub requested_at: ::aws_smithy_types::DateTime,
    /// The name of the S3 bucket for this export.
    pub s3_bucket: ::std::string::String,
    /// The S3 key prefix provided in the corresponding StartDomainExport request.
    pub s3_key_prefix: ::std::option::Option<::std::string::String>,
    /// The S3 SSE encryption algorithm for this export.
    pub s3_sse_algorithm: ::std::option::Option<crate::types::S3SseAlgorithm>,
    /// The KMS key ID for this export.
    pub s3_sse_kms_key_id: ::std::option::Option<::std::string::String>,
    /// The S3 bucket owner account ID for this export.
    pub s3_bucket_owner: ::std::option::Option<::std::string::String>,
    /// Failure code for the result of the failed export.
    pub failure_code: ::std::option::Option<::std::string::String>,
    /// Export failure reason description.
    pub failure_message: ::std::option::Option<::std::string::String>,
    /// The name of the manifest summary file for the export.
    pub export_manifest: ::std::option::Option<::std::string::String>,
    /// Total number of exported items.
    pub items_count: ::std::option::Option<i64>,
    /// The timestamp indicating the cutoff point for data inclusion in the export. All data inserted or modified before this time will be present in the exported data. Data insertions or modifications after this timestamp may or may not be present in the export.
    pub export_data_cutoff_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    _request_id: Option<String>,
}
impl GetExportOutput {
    /// Unique ARN identifier of the export.
    pub fn export_arn(&self) -> &str {
        use std::ops::Deref;
        self.export_arn.deref()
    }
    /// The client token provided for this export.
    pub fn client_token(&self) -> &str {
        use std::ops::Deref;
        self.client_token.deref()
    }
    /// The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error.
    pub fn export_status(&self) -> &crate::types::ExportStatus {
        &self.export_status
    }
    /// The name of the domain that was exported.
    pub fn domain_name(&self) -> &str {
        use std::ops::Deref;
        self.domain_name.deref()
    }
    /// Timestamp when the export request was received by the service.
    pub fn requested_at(&self) -> &::aws_smithy_types::DateTime {
        &self.requested_at
    }
    /// The name of the S3 bucket for this export.
    pub fn s3_bucket(&self) -> &str {
        use std::ops::Deref;
        self.s3_bucket.deref()
    }
    /// The S3 key prefix provided in the corresponding StartDomainExport request.
    pub fn s3_key_prefix(&self) -> ::std::option::Option<&str> {
        self.s3_key_prefix.as_deref()
    }
    /// The S3 SSE encryption algorithm for this export.
    pub fn s3_sse_algorithm(&self) -> ::std::option::Option<&crate::types::S3SseAlgorithm> {
        self.s3_sse_algorithm.as_ref()
    }
    /// The KMS key ID for this export.
    pub fn s3_sse_kms_key_id(&self) -> ::std::option::Option<&str> {
        self.s3_sse_kms_key_id.as_deref()
    }
    /// The S3 bucket owner account ID for this export.
    pub fn s3_bucket_owner(&self) -> ::std::option::Option<&str> {
        self.s3_bucket_owner.as_deref()
    }
    /// Failure code for the result of the failed export.
    pub fn failure_code(&self) -> ::std::option::Option<&str> {
        self.failure_code.as_deref()
    }
    /// Export failure reason description.
    pub fn failure_message(&self) -> ::std::option::Option<&str> {
        self.failure_message.as_deref()
    }
    /// The name of the manifest summary file for the export.
    pub fn export_manifest(&self) -> ::std::option::Option<&str> {
        self.export_manifest.as_deref()
    }
    /// Total number of exported items.
    pub fn items_count(&self) -> ::std::option::Option<i64> {
        self.items_count
    }
    /// The timestamp indicating the cutoff point for data inclusion in the export. All data inserted or modified before this time will be present in the exported data. Data insertions or modifications after this timestamp may or may not be present in the export.
    pub fn export_data_cutoff_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.export_data_cutoff_time.as_ref()
    }
}
impl ::aws_types::request_id::RequestId for GetExportOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl GetExportOutput {
    /// Creates a new builder-style object to manufacture [`GetExportOutput`](crate::operation::get_export::GetExportOutput).
    pub fn builder() -> crate::operation::get_export::builders::GetExportOutputBuilder {
        crate::operation::get_export::builders::GetExportOutputBuilder::default()
    }
}

/// A builder for [`GetExportOutput`](crate::operation::get_export::GetExportOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetExportOutputBuilder {
    pub(crate) export_arn: ::std::option::Option<::std::string::String>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
    pub(crate) export_status: ::std::option::Option<crate::types::ExportStatus>,
    pub(crate) domain_name: ::std::option::Option<::std::string::String>,
    pub(crate) requested_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) s3_bucket: ::std::option::Option<::std::string::String>,
    pub(crate) s3_key_prefix: ::std::option::Option<::std::string::String>,
    pub(crate) s3_sse_algorithm: ::std::option::Option<crate::types::S3SseAlgorithm>,
    pub(crate) s3_sse_kms_key_id: ::std::option::Option<::std::string::String>,
    pub(crate) s3_bucket_owner: ::std::option::Option<::std::string::String>,
    pub(crate) failure_code: ::std::option::Option<::std::string::String>,
    pub(crate) failure_message: ::std::option::Option<::std::string::String>,
    pub(crate) export_manifest: ::std::option::Option<::std::string::String>,
    pub(crate) items_count: ::std::option::Option<i64>,
    pub(crate) export_data_cutoff_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    _request_id: Option<String>,
}
impl GetExportOutputBuilder {
    /// Unique ARN identifier of the export.
    /// This field is required.
    pub fn export_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.export_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// Unique ARN identifier of the export.
    pub fn set_export_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.export_arn = input;
        self
    }
    /// Unique ARN identifier of the export.
    pub fn get_export_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.export_arn
    }
    /// The client token provided for this export.
    /// This field is required.
    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
    }
    /// The client token provided for this export.
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_token = input;
        self
    }
    /// The client token provided for this export.
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error.
    /// This field is required.
    pub fn export_status(mut self, input: crate::types::ExportStatus) -> Self {
        self.export_status = ::std::option::Option::Some(input);
        self
    }
    /// The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error.
    pub fn set_export_status(mut self, input: ::std::option::Option<crate::types::ExportStatus>) -> Self {
        self.export_status = input;
        self
    }
    /// The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error.
    pub fn get_export_status(&self) -> &::std::option::Option<crate::types::ExportStatus> {
        &self.export_status
    }
    /// The name of the domain that was exported.
    /// This field is required.
    pub fn domain_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.domain_name = ::std::option::Option::Some(input.into());
        self
    }
    /// The name of the domain that was exported.
    pub fn set_domain_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.domain_name = input;
        self
    }
    /// The name of the domain that was exported.
    pub fn get_domain_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.domain_name
    }
    /// Timestamp when the export request was received by the service.
    /// This field is required.
    pub fn requested_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.requested_at = ::std::option::Option::Some(input);
        self
    }
    /// Timestamp when the export request was received by the service.
    pub fn set_requested_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.requested_at = input;
        self
    }
    /// Timestamp when the export request was received by the service.
    pub fn get_requested_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.requested_at
    }
    /// The name of the S3 bucket for this export.
    /// This field is required.
    pub fn s3_bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.s3_bucket = ::std::option::Option::Some(input.into());
        self
    }
    /// The name of the S3 bucket for this export.
    pub fn set_s3_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.s3_bucket = input;
        self
    }
    /// The name of the S3 bucket for this export.
    pub fn get_s3_bucket(&self) -> &::std::option::Option<::std::string::String> {
        &self.s3_bucket
    }
    /// The S3 key prefix provided in the corresponding StartDomainExport request.
    pub fn s3_key_prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.s3_key_prefix = ::std::option::Option::Some(input.into());
        self
    }
    /// The S3 key prefix provided in the corresponding StartDomainExport request.
    pub fn set_s3_key_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.s3_key_prefix = input;
        self
    }
    /// The S3 key prefix provided in the corresponding StartDomainExport request.
    pub fn get_s3_key_prefix(&self) -> &::std::option::Option<::std::string::String> {
        &self.s3_key_prefix
    }
    /// The S3 SSE encryption algorithm for this export.
    pub fn s3_sse_algorithm(mut self, input: crate::types::S3SseAlgorithm) -> Self {
        self.s3_sse_algorithm = ::std::option::Option::Some(input);
        self
    }
    /// The S3 SSE encryption algorithm for this export.
    pub fn set_s3_sse_algorithm(mut self, input: ::std::option::Option<crate::types::S3SseAlgorithm>) -> Self {
        self.s3_sse_algorithm = input;
        self
    }
    /// The S3 SSE encryption algorithm for this export.
    pub fn get_s3_sse_algorithm(&self) -> &::std::option::Option<crate::types::S3SseAlgorithm> {
        &self.s3_sse_algorithm
    }
    /// The KMS key ID for this export.
    pub fn s3_sse_kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.s3_sse_kms_key_id = ::std::option::Option::Some(input.into());
        self
    }
    /// The KMS key ID for this export.
    pub fn set_s3_sse_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.s3_sse_kms_key_id = input;
        self
    }
    /// The KMS key ID for this export.
    pub fn get_s3_sse_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.s3_sse_kms_key_id
    }
    /// The S3 bucket owner account ID for this export.
    pub fn s3_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.s3_bucket_owner = ::std::option::Option::Some(input.into());
        self
    }
    /// The S3 bucket owner account ID for this export.
    pub fn set_s3_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.s3_bucket_owner = input;
        self
    }
    /// The S3 bucket owner account ID for this export.
    pub fn get_s3_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
        &self.s3_bucket_owner
    }
    /// Failure code for the result of the failed export.
    pub fn failure_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.failure_code = ::std::option::Option::Some(input.into());
        self
    }
    /// Failure code for the result of the failed export.
    pub fn set_failure_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.failure_code = input;
        self
    }
    /// Failure code for the result of the failed export.
    pub fn get_failure_code(&self) -> &::std::option::Option<::std::string::String> {
        &self.failure_code
    }
    /// Export failure reason description.
    pub fn failure_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.failure_message = ::std::option::Option::Some(input.into());
        self
    }
    /// Export failure reason description.
    pub fn set_failure_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.failure_message = input;
        self
    }
    /// Export failure reason description.
    pub fn get_failure_message(&self) -> &::std::option::Option<::std::string::String> {
        &self.failure_message
    }
    /// The name of the manifest summary file for the export.
    pub fn export_manifest(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.export_manifest = ::std::option::Option::Some(input.into());
        self
    }
    /// The name of the manifest summary file for the export.
    pub fn set_export_manifest(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.export_manifest = input;
        self
    }
    /// The name of the manifest summary file for the export.
    pub fn get_export_manifest(&self) -> &::std::option::Option<::std::string::String> {
        &self.export_manifest
    }
    /// Total number of exported items.
    pub fn items_count(mut self, input: i64) -> Self {
        self.items_count = ::std::option::Option::Some(input);
        self
    }
    /// Total number of exported items.
    pub fn set_items_count(mut self, input: ::std::option::Option<i64>) -> Self {
        self.items_count = input;
        self
    }
    /// Total number of exported items.
    pub fn get_items_count(&self) -> &::std::option::Option<i64> {
        &self.items_count
    }
    /// The timestamp indicating the cutoff point for data inclusion in the export. All data inserted or modified before this time will be present in the exported data. Data insertions or modifications after this timestamp may or may not be present in the export.
    pub fn export_data_cutoff_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.export_data_cutoff_time = ::std::option::Option::Some(input);
        self
    }
    /// The timestamp indicating the cutoff point for data inclusion in the export. All data inserted or modified before this time will be present in the exported data. Data insertions or modifications after this timestamp may or may not be present in the export.
    pub fn set_export_data_cutoff_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.export_data_cutoff_time = input;
        self
    }
    /// The timestamp indicating the cutoff point for data inclusion in the export. All data inserted or modified before this time will be present in the exported data. Data insertions or modifications after this timestamp may or may not be present in the export.
    pub fn get_export_data_cutoff_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.export_data_cutoff_time
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`GetExportOutput`](crate::operation::get_export::GetExportOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`export_arn`](crate::operation::get_export::builders::GetExportOutputBuilder::export_arn)
    /// - [`client_token`](crate::operation::get_export::builders::GetExportOutputBuilder::client_token)
    /// - [`export_status`](crate::operation::get_export::builders::GetExportOutputBuilder::export_status)
    /// - [`domain_name`](crate::operation::get_export::builders::GetExportOutputBuilder::domain_name)
    /// - [`requested_at`](crate::operation::get_export::builders::GetExportOutputBuilder::requested_at)
    /// - [`s3_bucket`](crate::operation::get_export::builders::GetExportOutputBuilder::s3_bucket)
    pub fn build(self) -> ::std::result::Result<crate::operation::get_export::GetExportOutput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::get_export::GetExportOutput {
            export_arn: self.export_arn.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "export_arn",
                    "export_arn was not specified but it is required when building GetExportOutput",
                )
            })?,
            client_token: self.client_token.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "client_token",
                    "client_token was not specified but it is required when building GetExportOutput",
                )
            })?,
            export_status: self.export_status.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "export_status",
                    "export_status was not specified but it is required when building GetExportOutput",
                )
            })?,
            domain_name: self.domain_name.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "domain_name",
                    "domain_name was not specified but it is required when building GetExportOutput",
                )
            })?,
            requested_at: self.requested_at.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "requested_at",
                    "requested_at was not specified but it is required when building GetExportOutput",
                )
            })?,
            s3_bucket: self.s3_bucket.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "s3_bucket",
                    "s3_bucket was not specified but it is required when building GetExportOutput",
                )
            })?,
            s3_key_prefix: self.s3_key_prefix,
            s3_sse_algorithm: self.s3_sse_algorithm,
            s3_sse_kms_key_id: self.s3_sse_kms_key_id,
            s3_bucket_owner: self.s3_bucket_owner,
            failure_code: self.failure_code,
            failure_message: self.failure_message,
            export_manifest: self.export_manifest,
            items_count: self.items_count,
            export_data_cutoff_time: self.export_data_cutoff_time,
            _request_id: self._request_id,
        })
    }
}