Skip to content

UpdateEnrollmentStatusRequest

Source code in docs_src/capo_compute_optimizer/types/update_enrollment_status_request.py 
14
15
16
17
18
19
20
class UpdateEnrollmentStatusRequest(TypedDict, closed=True):
    status: "capo_compute_optimizer.types.status.Status"
    """<p>The new enrollment status of the account.</p> <p>The following status options are available:</p> <ul> <li> <p> <code>Active</code> - 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 <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html">Metrics analyzed by Compute Optimizer</a> in the <i>Compute Optimizer User Guide</i>.</p> </li> <li> <p> <code>Inactive</code> - 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.</p> </li> </ul> <note> <p>The <code>Pending</code> and <code>Failed</code> 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.</p> </note>"""
    include_member_accounts: (
        "capo_compute_optimizer.types.include_member_accounts.IncludeMemberAccounts"
    )
    """<p>Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.</p>"""

include_member_accounts instance-attribute 

include_member_accounts: IncludeMemberAccounts

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

status instance-attribute 

status: Status

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.