amazonka-organizations-1.6.1: Amazon Organizations SDK.

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

Network.AWS.Organizations.ListOrganizationalUnitsForParent

Contents

Description

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.

Synopsis

Creating a Request

listOrganizationalUnitsForParent Source #

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 Source #

See: listOrganizationalUnitsForParent smart constructor.

Instances
Eq ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

Data ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.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 Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

Show ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

Generic ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

Associated Types

type Rep ListOrganizationalUnitsForParent :: Type -> Type #

Hashable ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

ToJSON ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

AWSPager ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

AWSRequest ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

Associated Types

type Rs ListOrganizationalUnitsForParent :: Type #

ToHeaders ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

ToPath ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

ToQuery ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

NFData ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

type Rep ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

type Rep ListOrganizationalUnitsForParent = D1 (MetaData "ListOrganizationalUnitsForParent" "Network.AWS.Organizations.ListOrganizationalUnitsForParent" "amazonka-organizations-1.6.1-AXMOvAV6jebLVZPNUpIjqF" False) (C1 (MetaCons "ListOrganizationalUnitsForParent'" PrefixI True) (S1 (MetaSel (Just "_loufpNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_loufpMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_loufpParentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs ListOrganizationalUnitsForParent Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

Request Lenses

loufpNextToken :: Lens' ListOrganizationalUnitsForParent (Maybe Text) Source #

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) Source #

(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 Source #

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 Source #

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 Source #

Instances
Eq ListOrganizationalUnitsForParentResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

Data ListOrganizationalUnitsForParentResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

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 Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

Show ListOrganizationalUnitsForParentResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

Generic ListOrganizationalUnitsForParentResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

NFData ListOrganizationalUnitsForParentResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

type Rep ListOrganizationalUnitsForParentResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListOrganizationalUnitsForParent

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

Response Lenses

loufprsNextToken :: Lens' ListOrganizationalUnitsForParentResponse (Maybe Text) Source #

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 .