Struct aws_sdk_computeoptimizer::client::fluent_builders::UpdateEnrollmentStatus

pub struct UpdateEnrollmentStatus { /* private fields */ }

Fluent builder constructing a request to UpdateEnrollmentStatus.

Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.

If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.

You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.

When you opt in, Compute Optimizer automatically creates a service-linked role in your account to access its data. For more information, see Using Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.

Implementations

impl UpdateEnrollmentStatus

pub async fn send(
    self
) -> Result<UpdateEnrollmentStatusOutput, SdkError<UpdateEnrollmentStatusError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn status(self, input: Status) -> Self

The new enrollment status of the account.

The following status options are available:

• Active - 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 Metrics analyzed by Compute Optimizer in the Compute Optimizer User Guide.

• Inactive - 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.

The Pending and Failed 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.

pub fn set_status(self, input: Option<Status>) -> Self

The new enrollment status of the account.

The following status options are available:

• Active - 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 Metrics analyzed by Compute Optimizer in the Compute Optimizer User Guide.

• Inactive - 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.

The Pending and Failed 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.

pub fn include_member_accounts(self, input: bool) -> Self

Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.

pub fn set_include_member_accounts(self, input: Option<bool>) -> Self

Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.

Trait Implementations

impl Clone for UpdateEnrollmentStatus

fn clone(&self) -> UpdateEnrollmentStatus

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateEnrollmentStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.