GetEnrollmentStatus
Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service.
If the account is the management account of an organization, this action also confirms the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information about the enrollment status of member accounts of an organization.
Response Syntax
{
"lastUpdatedTimestamp": number,
"memberAccountsEnrolled": boolean,
"numberOfMemberAccountsOptedIn": number,
"status": "string",
"statusReason": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- lastUpdatedTimestamp
-
The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.
Type: Timestamp
- memberAccountsEnrolled
-
Confirms the enrollment status of member accounts of the organization, if the account is a management account of an organization.
Type: Boolean
- numberOfMemberAccountsOptedIn
-
The count of organization member accounts that are opted in to the service, if your account is an organization management account.
Type: Integer
- status
-
The enrollment status of the account.
Type: String
Valid Values:
Active | Inactive | Pending | Failed - statusReason
-
The reason for the enrollment status of the account.
For example, an account might show a status of
Pendingbecause member accounts of an organization require more time to be enrolled in the service.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- InternalServerException
-
An internal error has occurred. Try your call again.
HTTP Status Code: 500
- InvalidParameterValueException
-
The value supplied for the input parameter is out of range or not valid.
HTTP Status Code: 400
- MissingAuthenticationToken
-
The request must contain either a valid (registered) AWS access key ID or X.509 certificate.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed due to a temporary failure of the server.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
