aws_sdk_databasemigration/client/
start_replication_task_assessment_run.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartReplicationTaskAssessmentRun`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`replication_task_arn(impl Into<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::replication_task_arn) / [`set_replication_task_arn(Option<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::set_replication_task_arn):<br>required: **true**<br><p>Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.</p><br>
    ///   - [`service_access_role_arn(impl Into<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::service_access_role_arn) / [`set_service_access_role_arn(Option<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::set_service_access_role_arn):<br>required: **true**<br><p>ARN of the service role needed to start the assessment run. The role must allow the <code>iam:PassRole</code> action.</p><br>
    ///   - [`result_location_bucket(impl Into<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::result_location_bucket) / [`set_result_location_bucket(Option<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::set_result_location_bucket):<br>required: **true**<br><p>Amazon S3 bucket where you want DMS to store the results of this assessment run.</p><br>
    ///   - [`result_location_folder(impl Into<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::result_location_folder) / [`set_result_location_folder(Option<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::set_result_location_folder):<br>required: **false**<br><p>Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.</p><br>
    ///   - [`result_encryption_mode(impl Into<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::result_encryption_mode) / [`set_result_encryption_mode(Option<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::set_result_encryption_mode):<br>required: **false**<br><p>Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:</p> <ul>  <li>   <p><code>"SSE_S3"</code> – The server-side encryption provided as a default by Amazon S3.</p></li>  <li>   <p><code>"SSE_KMS"</code> – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.</p></li> </ul><br>
    ///   - [`result_kms_key_arn(impl Into<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::result_kms_key_arn) / [`set_result_kms_key_arn(Option<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::set_result_kms_key_arn):<br>required: **false**<br><p>ARN of a custom KMS encryption key that you specify when you set <code>ResultEncryptionMode</code> to <code>"SSE_KMS</code>".</p><br>
    ///   - [`assessment_run_name(impl Into<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::assessment_run_name) / [`set_assessment_run_name(Option<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::set_assessment_run_name):<br>required: **true**<br><p>Unique name to identify the assessment run.</p><br>
    ///   - [`include_only(impl Into<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::include_only) / [`set_include_only(Option<Vec::<String>>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::set_include_only):<br>required: **false**<br><p>Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by <code>ReplicationTaskArn</code>.</p><note>  <p>You can't set a value for <code>IncludeOnly</code> if you also set a value for <code>Exclude</code> in the API operation.</p>  <p>To identify the names of the default individual assessments that DMS supports for the associated migration task, run the <code>DescribeApplicableIndividualAssessments</code> operation using its own <code>ReplicationTaskArn</code> request parameter.</p> </note><br>
    ///   - [`exclude(impl Into<String>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::exclude) / [`set_exclude(Option<Vec::<String>>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::set_exclude):<br>required: **false**<br><p>Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by <code>ReplicationTaskArn</code>.</p><note>  <p>You can't set a value for <code>Exclude</code> if you also set a value for <code>IncludeOnly</code> in the API operation.</p>  <p>To identify the names of the default individual assessments that DMS supports for the associated migration task, run the <code>DescribeApplicableIndividualAssessments</code> operation using its own <code>ReplicationTaskArn</code> request parameter.</p> </note><br>
    ///   - [`tags(Tag)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::set_tags):<br>required: **false**<br><p>One or more tags to be assigned to the premigration assessment run that you want to start.</p><br>
    /// - On success, responds with [`StartReplicationTaskAssessmentRunOutput`](crate::operation::start_replication_task_assessment_run::StartReplicationTaskAssessmentRunOutput) with field(s):
    ///   - [`replication_task_assessment_run(Option<ReplicationTaskAssessmentRun>)`](crate::operation::start_replication_task_assessment_run::StartReplicationTaskAssessmentRunOutput::replication_task_assessment_run): <p>The premigration assessment run that was started.</p>
    /// - On failure, responds with [`SdkError<StartReplicationTaskAssessmentRunError>`](crate::operation::start_replication_task_assessment_run::StartReplicationTaskAssessmentRunError)
    pub fn start_replication_task_assessment_run(
        &self,
    ) -> crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder {
        crate::operation::start_replication_task_assessment_run::builders::StartReplicationTaskAssessmentRunFluentBuilder::new(self.handle.clone())
    }
}