ComputeOptimizerAutomation / Paginator / ListAccounts

ListAccounts

class ComputeOptimizerAutomation.Paginator.ListAccounts
paginator = client.get_paginator('list_accounts')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ComputeOptimizerAutomation.Client.list_accounts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'accounts': [
        {
            'accountId': 'string',
            'status': 'Active'|'Inactive'|'Pending'|'Failed',
            'organizationRuleMode': 'AnyAllowed'|'NoneAllowed',
            'statusReason': 'string',
            'lastUpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • accounts (list) –

      The list of accounts in your organization enrolled in Compute Optimizer

      • (dict) –

        Contains information about an Amazon Web Services account’s enrollment and association status with Compute Optimizer Automation.

        • accountId (string) –

          The ID of the Amazon Web Services account.

        • status (string) –

          The enrollment status of the account: Active, Inactive, Pending, or Failed.

        • organizationRuleMode (string) –

          Specifies whether the management account can create Automation rules that implement optimization actions for this account.

        • statusReason (string) –

          The reason for the current Automation enrollment status.

        • lastUpdatedTimestamp (datetime) –

          The timestamp when the account’s Automation enrollment status was last updated.

    • NextToken (string) –

      A token to resume pagination.