computeoptimizer_update_enrollment_status: Updates the enrollment (opt in and opt out) status of an...

View source: R/computeoptimizer_operations.R

computeoptimizer_update_enrollment_statusR Documentation

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

Description

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

See https://www.paws-r-sdk.com/docs/computeoptimizer_update_enrollment_status/ for full documentation.

Usage

computeoptimizer_update_enrollment_status(status, includeMemberAccounts = NULL)

Arguments

status

[required] 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.

includeMemberAccounts

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


paws.compute documentation built on Sept. 12, 2023, 1:28 a.m.