Class: Aws::ComputeOptimizer::Types::UpdateEnrollmentStatusRequest

Inherits:

Struct

Object
Struct
Aws::ComputeOptimizer::Types::UpdateEnrollmentStatusRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-computeoptimizer/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#include_member_accounts ⇒ Boolean

Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.
#status ⇒ String

The new enrollment status of the account.

Instance Attribute Details

#include_member_accounts ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 7203

class UpdateEnrollmentStatusRequest < Struct.new(
  :status,
  :include_member_accounts)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

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.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html