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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb

Overview

Note:

When making an API call, you may pass UpdateEnrollmentStatusRequest data as a hash:

{
  status: "Active", # required, accepts Active, Inactive, Pending, Failed
  include_member_accounts: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#include_member_accountsBoolean

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

Returns:

  • (Boolean)


3063
3064
3065
3066
3067
3068
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 3063

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

#statusString

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.

Returns:

  • (String)


3063
3064
3065
3066
3067
3068
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 3063

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