List Accounts For Parent

organizations_list_accounts_for_parent

R Documentation

Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU)¶

Description¶

Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that aren't in any OU. If you specify an OU, you get a list of all the accounts in only that OU and not in any child OUs. To get a list of all accounts in the organization, use the list_accounts operation.

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_for_parent(ParentId, NextToken, MaxResults)

Arguments¶

ParentId

[required] The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list.

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_for_parent(
  ParentId = "string",
  NextToken = "string",
  MaxResults = 123
)

Examples¶

## Not run: 
# The following example shows how to request a list of the accounts in an
# OU:/n/n
svc$list_accounts_for_parent(
  ParentId = "ou-examplerootid111-exampleouid111"
)

## End(Not run)