Skip to main content

aws_sdk_simpledbv2/client/
start_domain_export.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`StartDomainExport`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`client_token(impl Into<String>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::set_client_token):<br>required: **false**<br>Providing a ClientToken makes the call to StartDomainExport API idempotent, meaning that multiple identical calls have the same effect as one single call. A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent. If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, a ConflictException will be returned.<br>
7    ///   - [`domain_name(impl Into<String>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::set_domain_name):<br>required: **true**<br>The name of the domain to export.<br>
8    ///   - [`s3_bucket(impl Into<String>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::s3_bucket) / [`set_s3_bucket(Option<String>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::set_s3_bucket):<br>required: **true**<br>The name of the S3 bucket where the domain data will be exported.<br>
9    ///   - [`s3_key_prefix(impl Into<String>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::s3_key_prefix) / [`set_s3_key_prefix(Option<String>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::set_s3_key_prefix):<br>required: **false**<br>The prefix string to be used to generate the S3 object keys for export artifacts.<br>
10    ///   - [`s3_sse_algorithm(S3SseAlgorithm)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::s3_sse_algorithm) / [`set_s3_sse_algorithm(Option<S3SseAlgorithm>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::set_s3_sse_algorithm):<br>required: **false**<br>The server-side encryption algorithm to use for the exported data in S3. Valid values are: AES256 (SSE-S3) and KMS (SSE-KMS). If not specified, bucket's default encryption will apply.<br>
11    ///   - [`s3_sse_kms_key_id(impl Into<String>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::s3_sse_kms_key_id) / [`set_s3_sse_kms_key_id(Option<String>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::set_s3_sse_kms_key_id):<br>required: **false**<br>The KMS key ID to use for server-side encryption with AWS KMS-managed keys (SSE-KMS). This parameter is only expected with KMS as the S3 SSE algorithm.<br>
12    ///   - [`s3_bucket_owner(impl Into<String>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::s3_bucket_owner) / [`set_s3_bucket_owner(Option<String>)`](crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::set_s3_bucket_owner):<br>required: **false**<br>The ID of the AWS account that owns the bucket the export will be stored in.<br>
13    /// - On success, responds with [`StartDomainExportOutput`](crate::operation::start_domain_export::StartDomainExportOutput) with field(s):
14    ///   - [`client_token(String)`](crate::operation::start_domain_export::StartDomainExportOutput::client_token): The client token that was provided in the request.
15    ///   - [`export_arn(String)`](crate::operation::start_domain_export::StartDomainExportOutput::export_arn): Unique ARN identifier of the export.
16    ///   - [`requested_at(DateTime)`](crate::operation::start_domain_export::StartDomainExportOutput::requested_at): Timestamp when the export request was received by the service.
17    /// - On failure, responds with [`SdkError<StartDomainExportError>`](crate::operation::start_domain_export::StartDomainExportError)
18    pub fn start_domain_export(&self) -> crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder {
19        crate::operation::start_domain_export::builders::StartDomainExportFluentBuilder::new(self.handle.clone())
20    }
21}