organizations_list_accounts_for_parent: Lists the accounts in an organization that are contained by...

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

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.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.

Usage

1
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 total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
list(
  Accounts = list(
    list(
      Id = "string",
      Arn = "string",
      Email = "string",
      Name = "string",
      Status = "ACTIVE"|"SUSPENDED",
      JoinedMethod = "INVITED"|"CREATED",
      JoinedTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
5
svc$list_accounts_for_parent(
  ParentId = "string",
  NextToken = "string",
  MaxResults = 123
)

Examples

1
2
3
4
5
6
7
8
## 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)

paws.management documentation built on March 8, 2021, 1:07 a.m.