aws_sdk_computeoptimizer/client/

update_enrollment_status.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateEnrollmentStatus`](crate::operation::update_enrollment_status::builders::UpdateEnrollmentStatusFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`status(Status)`](crate::operation::update_enrollment_status::builders::UpdateEnrollmentStatusFluentBuilder::status) / [`set_status(Option<Status>)`](crate::operation::update_enrollment_status::builders::UpdateEnrollmentStatusFluentBuilder::set_status):<br>required: **true**<br><p>The new enrollment status of the account.</p> <p>The following status options are available:</p> <ul>  <li>   <p><code>Active</code> - Opts in your account to the Compute Optimizer service. Compute Optimizer begins analyzing the configuration and utilization metrics of your Amazon Web Services resources after you opt in. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html">Metrics analyzed by Compute Optimizer</a> in the <i>Compute Optimizer User Guide</i>.</p></li>  <li>   <p><code>Inactive</code> - Opts out your account from the Compute Optimizer service. Your account's recommendations and related metrics data will be deleted from Compute Optimizer after you opt out.</p></li> </ul><note>  <p>The <code>Pending</code> and <code>Failed</code> options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.</p> </note><br>
    ///   - [`include_member_accounts(bool)`](crate::operation::update_enrollment_status::builders::UpdateEnrollmentStatusFluentBuilder::include_member_accounts) / [`set_include_member_accounts(Option<bool>)`](crate::operation::update_enrollment_status::builders::UpdateEnrollmentStatusFluentBuilder::set_include_member_accounts):<br>required: **false**<br><p>Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.</p><br>
    /// - On success, responds with [`UpdateEnrollmentStatusOutput`](crate::operation::update_enrollment_status::UpdateEnrollmentStatusOutput) with field(s):
    ///   - [`status(Option<Status>)`](crate::operation::update_enrollment_status::UpdateEnrollmentStatusOutput::status): <p>The enrollment status of the account.</p>
    ///   - [`status_reason(Option<String>)`](crate::operation::update_enrollment_status::UpdateEnrollmentStatusOutput::status_reason): <p>The reason for the enrollment status of the account. For example, an account might show a status of <code>Pending</code> because member accounts of an organization require more time to be enrolled in the service.</p>
    /// - On failure, responds with [`SdkError<UpdateEnrollmentStatusError>`](crate::operation::update_enrollment_status::UpdateEnrollmentStatusError)
    pub fn update_enrollment_status(&self) -> crate::operation::update_enrollment_status::builders::UpdateEnrollmentStatusFluentBuilder {
        crate::operation::update_enrollment_status::builders::UpdateEnrollmentStatusFluentBuilder::new(self.handle.clone())
    }
}