UpdateEnrollmentStatusRequest is a JSON Structure definition published by Amazon Compute Optimizer, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-compute-optimizer/refs/heads/main/json-structure/compute-optimizer-update-enrollment-status-request-structure.json",
"name": "UpdateEnrollmentStatusRequest",
"description": "UpdateEnrollmentStatusRequest schema",
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/Status"
},
{
"description": "<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>"
}
]
},
"includeMemberAccounts": {
"allOf": [
{
"$ref": "#/components/schemas/IncludeMemberAccounts"
},
{
"description": "Indicates whether to enroll member accounts of the organization if the account is the management account of an organization."
}
]
}
},
"required": [
"status"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.