Update Enrollment Status

computeoptimizer_update_enrollment_status

R 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.

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.

Usage

computeoptimizer_update_enrollment_status(status, includeMemberAccounts)

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.

Value

A list with the following syntax:

list(
  status = "Active"|"Inactive"|"Pending"|"Failed",
  statusReason = "string"
)

Request syntax

svc$update_enrollment_status(
  status = "Active"|"Inactive"|"Pending"|"Failed",
  includeMemberAccounts = TRUE|FALSE
)