libZSservicesZSamazonka-organizationsZSamazonka-organizations
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Organizations.ListChildren

Description

Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root.

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.

This operation returns paginated results.

Synopsis

Creating a Request

data ListChildren Source #

See: newListChildren smart constructor.

Constructors

ListChildren' 

Fields

  • nextToken :: Maybe Text

    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 :: Maybe Natural

    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.

  • parentId :: Text

    The unique identifier (ID) for the parent root or OU whose children you want to list.

    The regex pattern for a parent ID string requires one of the following:

    • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
    • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
  • childType :: ChildType

    Filters the output to include only the specified child type.

Instances

Instances details
Eq ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

Read ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

Show ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

Generic ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

Associated Types

type Rep ListChildren :: Type -> Type #

NFData ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

Methods

rnf :: ListChildren -> () #

Hashable ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

ToJSON ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

AWSPager ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

AWSRequest ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

Associated Types

type AWSResponse ListChildren #

ToHeaders ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

ToPath ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

ToQuery ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

type Rep ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

type Rep ListChildren = D1 ('MetaData "ListChildren" "Amazonka.Organizations.ListChildren" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "ListChildren'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "parentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "childType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChildType))))
type AWSResponse ListChildren Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

newListChildren Source #

Create a value of ListChildren with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListChildren', listChildren_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.

$sel:maxResults:ListChildren', listChildren_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.

$sel:parentId:ListChildren', listChildren_parentId - The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

$sel:childType:ListChildren', listChildren_childType - Filters the output to include only the specified child type.

Request Lenses

listChildren_nextToken :: Lens' ListChildren (Maybe Text) Source #

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.

listChildren_maxResults :: Lens' ListChildren (Maybe Natural) Source #

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.

listChildren_parentId :: Lens' ListChildren Text Source #

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

listChildren_childType :: Lens' ListChildren ChildType Source #

Filters the output to include only the specified child type.

Destructuring the Response

data ListChildrenResponse Source #

See: newListChildrenResponse smart constructor.

Constructors

ListChildrenResponse' 

Fields

  • children :: Maybe [Child]

    The list of children of the specified parent container.

  • nextToken :: Maybe Text

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListChildrenResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

Read ListChildrenResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

Show ListChildrenResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

Generic ListChildrenResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

Associated Types

type Rep ListChildrenResponse :: Type -> Type #

NFData ListChildrenResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

Methods

rnf :: ListChildrenResponse -> () #

type Rep ListChildrenResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListChildren

type Rep ListChildrenResponse = D1 ('MetaData "ListChildrenResponse" "Amazonka.Organizations.ListChildren" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "ListChildrenResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "children") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Child])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListChildrenResponse Source #

Create a value of ListChildrenResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:children:ListChildrenResponse', listChildrenResponse_children - The list of children of the specified parent container.

$sel:nextToken:ListChildren', listChildrenResponse_nextToken - If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

$sel:httpStatus:ListChildrenResponse', listChildrenResponse_httpStatus - The response's http status code.

Response Lenses

listChildrenResponse_children :: Lens' ListChildrenResponse (Maybe [Child]) Source #

The list of children of the specified parent container.

listChildrenResponse_nextToken :: Lens' ListChildrenResponse (Maybe Text) Source #

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.