List Accounts

organizations_list_accounts

R Documentation

Lists all the accounts in the organization¶

Description¶

Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the list_accounts_for_parent operation instead.

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

You can only call this operation from the management account or a member account that is a delegated administrator.

Usage¶

organizations_list_accounts(NextToken, MaxResults)

Arguments¶

NextToken

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

MaxResults

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

Value¶

A list with the following syntax:

list(
  Accounts = list(
    list(
      Id = "string",
      Arn = "string",
      Email = "string",
      Name = "string",
      Status = "ACTIVE"|"SUSPENDED"|"PENDING_CLOSURE",
      State = "PENDING_ACTIVATION"|"ACTIVE"|"SUSPENDED"|"PENDING_CLOSURE"|"CLOSED",
      Paths = list(
        "string"
      ),
      JoinedMethod = "INVITED"|"CREATED",
      JoinedTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_accounts(
  NextToken = "string",
  MaxResults = 123
)

Examples¶

## Not run: 
# The following example shows you how to request a list of the accounts in
# an organization:
svc$list_accounts()

## End(Not run)