Network.AWS.Organizations.ListChildren

Lists all of the 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.

This operation can be called only from the organization's master account.

This operation returns paginated results.

Creating a Request

listChildren

Arguments

:: Text

lcParentId

-> ChildType

lcChildType

-> ListChildren

Creates a value of ListChildren with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lcNextToken - Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
• lcMaxResults - (Optional) Use this to limit the number of results you want included in 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.
• lcParentId - 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 lower-case letters or digits. * Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
• lcChildType - Filters the output to include only the specified child type.

data ListChildren

See: listChildren smart constructor.

Instances

Eq ListChildren

Methods

(==) :: ListChildren -> ListChildren -> Bool

(/=) :: ListChildren -> ListChildren -> Bool

Data ListChildren

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListChildren -> c ListChildren

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListChildren

toConstr :: ListChildren -> Constr

dataTypeOf :: ListChildren -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListChildren)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListChildren)

gmapT :: (forall b. Data b => b -> b) -> ListChildren -> ListChildren

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListChildren -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListChildren -> r

gmapQ :: (forall d. Data d => d -> u) -> ListChildren -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListChildren -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListChildren -> m ListChildren

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListChildren -> m ListChildren

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListChildren -> m ListChildren

Read ListChildren

Methods

readsPrec :: Int -> ReadS ListChildren

readList :: ReadS [ListChildren]

readPrec :: ReadPrec ListChildren

readListPrec :: ReadPrec [ListChildren]

Show ListChildren

Methods

showsPrec :: Int -> ListChildren -> ShowS

show :: ListChildren -> String

showList :: [ListChildren] -> ShowS

Generic ListChildren

Associated Types

type Rep ListChildren :: * -> *

Methods

from :: ListChildren -> Rep ListChildren x

to :: Rep ListChildren x -> ListChildren

Hashable ListChildren

Methods

hashWithSalt :: Int -> ListChildren -> Int

hash :: ListChildren -> Int

ToJSON ListChildren

Methods

toJSON :: ListChildren -> Value

toEncoding :: ListChildren -> Encoding

toJSONList :: [ListChildren] -> Value

toEncodingList :: [ListChildren] -> Encoding

NFData ListChildren

Methods

rnf :: ListChildren -> ()

AWSPager ListChildren

Methods

page :: ListChildren -> Rs ListChildren -> Maybe ListChildren

AWSRequest ListChildren

Associated Types

type Rs ListChildren :: *

Methods

request :: ListChildren -> Request ListChildren

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListChildren -> ClientResponse -> m (Response ListChildren)

ToHeaders ListChildren

Methods

toHeaders :: ListChildren -> [Header]

ToPath ListChildren

Methods

toPath :: ListChildren -> ByteString

ToQuery ListChildren

Methods

toQuery :: ListChildren -> QueryString

type Rep ListChildren

type Rep ListChildren = D1 * (MetaData "ListChildren" "Network.AWS.Organizations.ListChildren" "amazonka-organizations-1.6.0-rHxjcIb8Bn6XT7VgZWDi9" False) (C1 * (MetaCons "ListChildren'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lcNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lcMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lcParentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_lcChildType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ChildType)))))

type Rs ListChildren

type Rs ListChildren = ListChildrenResponse

Request Lenses

lcNextToken :: Lens' ListChildren (Maybe Text)

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

lcMaxResults :: Lens' ListChildren (Maybe Natural)

(Optional) Use this to limit the number of results you want included in 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.

lcParentId :: Lens' ListChildren 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 lower-case letters or digits. * Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

lcChildType :: Lens' ListChildren ChildType

Filters the output to include only the specified child type.

Destructuring the Response

listChildrenResponse

Arguments

:: Int

lcrsResponseStatus

-> ListChildrenResponse

Creates a value of ListChildrenResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lcrsChildren - The list of children of the specified parent container.
• lcrsNextToken - If present, this value indicates that there is more output 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 .
• lcrsResponseStatus - -- | The response status code.

data ListChildrenResponse

See: listChildrenResponse smart constructor.

Instances

Eq ListChildrenResponse

Methods

(==) :: ListChildrenResponse -> ListChildrenResponse -> Bool

(/=) :: ListChildrenResponse -> ListChildrenResponse -> Bool

Data ListChildrenResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListChildrenResponse -> c ListChildrenResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListChildrenResponse

toConstr :: ListChildrenResponse -> Constr

dataTypeOf :: ListChildrenResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListChildrenResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListChildrenResponse)

gmapT :: (forall b. Data b => b -> b) -> ListChildrenResponse -> ListChildrenResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListChildrenResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListChildrenResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListChildrenResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListChildrenResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListChildrenResponse -> m ListChildrenResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListChildrenResponse -> m ListChildrenResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListChildrenResponse -> m ListChildrenResponse

Read ListChildrenResponse

Methods

readsPrec :: Int -> ReadS ListChildrenResponse

readList :: ReadS [ListChildrenResponse]

readPrec :: ReadPrec ListChildrenResponse

readListPrec :: ReadPrec [ListChildrenResponse]

Show ListChildrenResponse

Methods

showsPrec :: Int -> ListChildrenResponse -> ShowS

show :: ListChildrenResponse -> String

showList :: [ListChildrenResponse] -> ShowS

Generic ListChildrenResponse

Associated Types

type Rep ListChildrenResponse :: * -> *

Methods

from :: ListChildrenResponse -> Rep ListChildrenResponse x

to :: Rep ListChildrenResponse x -> ListChildrenResponse

NFData ListChildrenResponse

Methods

rnf :: ListChildrenResponse -> ()

type Rep ListChildrenResponse

type Rep ListChildrenResponse = D1 * (MetaData "ListChildrenResponse" "Network.AWS.Organizations.ListChildren" "amazonka-organizations-1.6.0-rHxjcIb8Bn6XT7VgZWDi9" False) (C1 * (MetaCons "ListChildrenResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lcrsChildren") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Child]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lcrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lcrsChildren :: Lens' ListChildrenResponse [Child]

The list of children of the specified parent container.

lcrsNextToken :: Lens' ListChildrenResponse (Maybe Text)

If present, this value indicates that there is more output 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 .

lcrsResponseStatus :: Lens' ListChildrenResponse Int

• - | The response status code.