ComputeOptimizer / Client / get_enrollment_statuses_for_organization

get_enrollment_statuses_for_organization#

ComputeOptimizer.Client.get_enrollment_statuses_for_organization(**kwargs)#

Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.

To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.

Request Syntax

response = client.get_enrollment_statuses_for_organization(
    filters=[
        {
            'name': 'Status',
            'values': [
                'string',
            ]
        },
    ],
    nextToken='string',
    maxResults=123
)

Parameters:

filters (list) –
An array of objects to specify a filter that returns a more specific list of account enrollment statuses.
- (dict) –
  
  Describes a filter that returns a more specific list of account enrollment statuses. Use this filter with the GetEnrollmentStatusesForOrganization action.
  - name (string) –
    
    The name of the filter.
    
    Specify Status to return accounts with a specific enrollment status (for example, Active).
  - values (list) –
    
    The value of the filter.
    
    The valid values are Active, Inactive, Pending, and Failed.
    - (string) –
nextToken (string) – The token to advance to the next page of account enrollment statuses.
maxResults (integer) –
The maximum number of account enrollment statuses to return with a single request. You can specify up to 100 statuses to return with each request.

To retrieve the remaining results, make another request with the returned nextToken value.

Return type:

dict

Returns:

Response Syntax

{
    'accountEnrollmentStatuses': [
        {
            'accountId': 'string',
            'status': 'Active'|'Inactive'|'Pending'|'Failed',
            'statusReason': 'string',
            'lastUpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- accountEnrollmentStatuses (list) –
  
  An array of objects that describe the enrollment statuses of organization member accounts.
  - (dict) –
    
    Describes the enrollment status of an organization’s member accounts in Compute Optimizer.
    - accountId (string) –
      
      The Amazon Web Services account ID.
    - status (string) –
      
      The account enrollment status.
    - statusReason (string) –
      
      The reason for the account enrollment status.
      
      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.
    - lastUpdatedTimestamp (datetime) –
      
      The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.
- nextToken (string) –
  
  The token to use to advance to the next page of account enrollment statuses.
  
  This value is null when there are no more pages of account enrollment statuses to return.

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