CostOptimizationHub / Client / list_enrollment_statuses

list_enrollment_statuses#

CostOptimizationHub.Client.list_enrollment_statuses(**kwargs)#

Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.

Request Syntax

response = client.list_enrollment_statuses(
    includeOrganizationInfo=True|False,
    accountId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

includeOrganizationInfo (boolean) – Indicates whether to return the enrollment status for the organization.
accountId (string) – The account ID of a member account in the organization.
nextToken (string) – The token to retrieve the next set of results.
maxResults (integer) – The maximum number of objects that are returned for the request.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'accountId': 'string',
            'status': 'Active'|'Inactive',
            'lastUpdatedTimestamp': datetime(2015, 1, 1),
            'createdTimestamp': datetime(2015, 1, 1)
        },
    ],
    'includeMemberAccounts': True|False,
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The enrollment status of a specific account ID, including creation and last updated timestamps.
  - (dict) –
    
    Describes the enrollment status of an organization’s member accounts in Cost Optimization Hub.
    - accountId (string) –
      
      The Amazon Web Services account ID.
    - status (string) –
      
      The account enrollment status.
    - lastUpdatedTimestamp (datetime) –
      
      The time when the account enrollment status was last updated.
    - createdTimestamp (datetime) –
      
      The time when the account enrollment status was created.
- includeMemberAccounts (boolean) –
  
  The enrollment status of all member accounts in the organization if the account is the management account or delegated administrator.
- nextToken (string) –
  
  The token to retrieve the next set of results.

Exceptions

CostOptimizationHub.Client.exceptions.ValidationException
CostOptimizationHub.Client.exceptions.InternalServerException
CostOptimizationHub.Client.exceptions.AccessDeniedException
CostOptimizationHub.Client.exceptions.ThrottlingException