ComputeOptimizer / Client / get_enrollment_status

get_enrollment_status#

ComputeOptimizer.Client.get_enrollment_status()#

Returns the enrollment (opt in) status of an account to the 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.

Request Syntax

response = client.get_enrollment_status()

Return type:

dict

Returns:

Response Syntax

{
    'status': 'Active'|'Inactive'|'Pending'|'Failed',
    'statusReason': 'string',
    'memberAccountsEnrolled': True|False,
    'lastUpdatedTimestamp': datetime(2015, 1, 1),
    'numberOfMemberAccountsOptedIn': 123
}

Response Structure

(dict) –
- status (string) –
  
  The enrollment status of the account.
- statusReason (string) –
  
  The reason for the enrollment status of the account.
  
  For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.
- memberAccountsEnrolled (boolean) –
  
  Confirms the enrollment status of member accounts of the organization, if the account is a management account of an organization.
- lastUpdatedTimestamp (datetime) –
  
  The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.
- numberOfMemberAccountsOptedIn (integer) –
  
  The count of organization member accounts that are opted in to the service, if your account is an organization management account.

Exceptions

ComputeOptimizer.Client.exceptions.InternalServerException
ComputeOptimizer.Client.exceptions.ServiceUnavailableException
ComputeOptimizer.Client.exceptions.AccessDeniedException
ComputeOptimizer.Client.exceptions.InvalidParameterValueException
ComputeOptimizer.Client.exceptions.MissingAuthenticationToken
ComputeOptimizer.Client.exceptions.ThrottlingException