Network.AWS.Organizations.ListOrganizationalUnitsForParent

Lists the organizational units (OUs) in a parent organizational unit or root.

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

This operation returns paginated results.

Creating a Request

listOrganizationalUnitsForParent

Arguments

:: Text

loufpParentId

-> ListOrganizationalUnitsForParent

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

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

• loufpNextToken - 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.
• loufpMaxResults - (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.
• loufpParentId - The unique identifier (ID) of the root or OU whose child OUs 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.

data ListOrganizationalUnitsForParent

See: listOrganizationalUnitsForParent smart constructor.

Instances

Eq ListOrganizationalUnitsForParent

Methods

(==) :: ListOrganizationalUnitsForParent -> ListOrganizationalUnitsForParent -> Bool

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

Data ListOrganizationalUnitsForParent

Methods

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

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

toConstr :: ListOrganizationalUnitsForParent -> Constr

dataTypeOf :: ListOrganizationalUnitsForParent -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListOrganizationalUnitsForParent

Methods

readsPrec :: Int -> ReadS ListOrganizationalUnitsForParent

readList :: ReadS [ListOrganizationalUnitsForParent]

readPrec :: ReadPrec ListOrganizationalUnitsForParent

readListPrec :: ReadPrec [ListOrganizationalUnitsForParent]

Show ListOrganizationalUnitsForParent

Methods

showsPrec :: Int -> ListOrganizationalUnitsForParent -> ShowS

show :: ListOrganizationalUnitsForParent -> String

showList :: [ListOrganizationalUnitsForParent] -> ShowS

Generic ListOrganizationalUnitsForParent

Associated Types

type Rep ListOrganizationalUnitsForParent :: * -> *

Methods

from :: ListOrganizationalUnitsForParent -> Rep ListOrganizationalUnitsForParent x

to :: Rep ListOrganizationalUnitsForParent x -> ListOrganizationalUnitsForParent

Hashable ListOrganizationalUnitsForParent

Methods

hashWithSalt :: Int -> ListOrganizationalUnitsForParent -> Int

hash :: ListOrganizationalUnitsForParent -> Int

ToJSON ListOrganizationalUnitsForParent

Methods

toJSON :: ListOrganizationalUnitsForParent -> Value

toEncoding :: ListOrganizationalUnitsForParent -> Encoding

toJSONList :: [ListOrganizationalUnitsForParent] -> Value

toEncodingList :: [ListOrganizationalUnitsForParent] -> Encoding

NFData ListOrganizationalUnitsForParent

Methods

rnf :: ListOrganizationalUnitsForParent -> ()

AWSPager ListOrganizationalUnitsForParent

Methods

page :: ListOrganizationalUnitsForParent -> Rs ListOrganizationalUnitsForParent -> Maybe ListOrganizationalUnitsForParent

AWSRequest ListOrganizationalUnitsForParent

Associated Types

type Rs ListOrganizationalUnitsForParent :: *

Methods

request :: ListOrganizationalUnitsForParent -> Request ListOrganizationalUnitsForParent

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

ToHeaders ListOrganizationalUnitsForParent

Methods

toHeaders :: ListOrganizationalUnitsForParent -> [Header]

ToPath ListOrganizationalUnitsForParent

Methods

toPath :: ListOrganizationalUnitsForParent -> ByteString

ToQuery ListOrganizationalUnitsForParent

Methods

toQuery :: ListOrganizationalUnitsForParent -> QueryString

type Rep ListOrganizationalUnitsForParent

type Rep ListOrganizationalUnitsForParent = D1 * (MetaData "ListOrganizationalUnitsForParent" "Network.AWS.Organizations.ListOrganizationalUnitsForParent" "amazonka-organizations-1.6.0-rHxjcIb8Bn6XT7VgZWDi9" False) (C1 * (MetaCons "ListOrganizationalUnitsForParent'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_loufpNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_loufpMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_loufpParentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs ListOrganizationalUnitsForParent

type Rs ListOrganizationalUnitsForParent = ListOrganizationalUnitsForParentResponse

Request Lenses

loufpNextToken :: Lens' ListOrganizationalUnitsForParent (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.

loufpMaxResults :: Lens' ListOrganizationalUnitsForParent (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.

loufpParentId :: Lens' ListOrganizationalUnitsForParent Text

The unique identifier (ID) of the root or OU whose child OUs 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.

Destructuring the Response

listOrganizationalUnitsForParentResponse

Arguments

:: Int

loufprsResponseStatus

-> ListOrganizationalUnitsForParentResponse

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

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

• loufprsNextToken - 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 .
• loufprsOrganizationalUnits - A list of the OUs in the specified root or parent OU.
• loufprsResponseStatus - -- | The response status code.

data ListOrganizationalUnitsForParentResponse

See: listOrganizationalUnitsForParentResponse smart constructor.

Instances

Eq ListOrganizationalUnitsForParentResponse

Methods

(==) :: ListOrganizationalUnitsForParentResponse -> ListOrganizationalUnitsForParentResponse -> Bool

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

Data ListOrganizationalUnitsForParentResponse

Methods

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

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

toConstr :: ListOrganizationalUnitsForParentResponse -> Constr

dataTypeOf :: ListOrganizationalUnitsForParentResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListOrganizationalUnitsForParentResponse

Methods

readsPrec :: Int -> ReadS ListOrganizationalUnitsForParentResponse

readList :: ReadS [ListOrganizationalUnitsForParentResponse]

readPrec :: ReadPrec ListOrganizationalUnitsForParentResponse

readListPrec :: ReadPrec [ListOrganizationalUnitsForParentResponse]

Show ListOrganizationalUnitsForParentResponse

Methods

showsPrec :: Int -> ListOrganizationalUnitsForParentResponse -> ShowS

show :: ListOrganizationalUnitsForParentResponse -> String

showList :: [ListOrganizationalUnitsForParentResponse] -> ShowS

Generic ListOrganizationalUnitsForParentResponse

Associated Types

type Rep ListOrganizationalUnitsForParentResponse :: * -> *

Methods

from :: ListOrganizationalUnitsForParentResponse -> Rep ListOrganizationalUnitsForParentResponse x

to :: Rep ListOrganizationalUnitsForParentResponse x -> ListOrganizationalUnitsForParentResponse

NFData ListOrganizationalUnitsForParentResponse

Methods

rnf :: ListOrganizationalUnitsForParentResponse -> ()

type Rep ListOrganizationalUnitsForParentResponse

type Rep ListOrganizationalUnitsForParentResponse = D1 * (MetaData "ListOrganizationalUnitsForParentResponse" "Network.AWS.Organizations.ListOrganizationalUnitsForParent" "amazonka-organizations-1.6.0-rHxjcIb8Bn6XT7VgZWDi9" False) (C1 * (MetaCons "ListOrganizationalUnitsForParentResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_loufprsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_loufprsOrganizationalUnits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [OrganizationalUnit]))) (S1 * (MetaSel (Just Symbol "_loufprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

loufprsNextToken :: Lens' ListOrganizationalUnitsForParentResponse (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 .

loufprsOrganizationalUnits :: Lens' ListOrganizationalUnitsForParentResponse [OrganizationalUnit]

A list of the OUs in the specified root or parent OU.

loufprsResponseStatus :: Lens' ListOrganizationalUnitsForParentResponse Int

• - | The response status code.