Network.AWS.Organizations.ListAccountsForParent

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 are not 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 ListAccounts operation.

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

This operation returns paginated results.

Creating a Request

listAccountsForParent

Arguments

:: Text

lafpParentId

-> ListAccountsForParent

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

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

• lafpNextToken - 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.
• lafpMaxResults - (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.
• lafpParentId - The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list.

data ListAccountsForParent

See: listAccountsForParent smart constructor.

Instances

Eq ListAccountsForParent

Methods

(==) :: ListAccountsForParent -> ListAccountsForParent -> Bool

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

Data ListAccountsForParent

Methods

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

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

toConstr :: ListAccountsForParent -> Constr

dataTypeOf :: ListAccountsForParent -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListAccountsForParent

Methods

readsPrec :: Int -> ReadS ListAccountsForParent

readList :: ReadS [ListAccountsForParent]

readPrec :: ReadPrec ListAccountsForParent

readListPrec :: ReadPrec [ListAccountsForParent]

Show ListAccountsForParent

Methods

showsPrec :: Int -> ListAccountsForParent -> ShowS

show :: ListAccountsForParent -> String

showList :: [ListAccountsForParent] -> ShowS

Generic ListAccountsForParent

Associated Types

type Rep ListAccountsForParent :: * -> *

Methods

from :: ListAccountsForParent -> Rep ListAccountsForParent x

to :: Rep ListAccountsForParent x -> ListAccountsForParent

Hashable ListAccountsForParent

Methods

hashWithSalt :: Int -> ListAccountsForParent -> Int

hash :: ListAccountsForParent -> Int

ToJSON ListAccountsForParent

Methods

toJSON :: ListAccountsForParent -> Value

toEncoding :: ListAccountsForParent -> Encoding

toJSONList :: [ListAccountsForParent] -> Value

toEncodingList :: [ListAccountsForParent] -> Encoding

NFData ListAccountsForParent

Methods

rnf :: ListAccountsForParent -> ()

AWSPager ListAccountsForParent

Methods

page :: ListAccountsForParent -> Rs ListAccountsForParent -> Maybe ListAccountsForParent

AWSRequest ListAccountsForParent

Associated Types

type Rs ListAccountsForParent :: *

Methods

request :: ListAccountsForParent -> Request ListAccountsForParent

response :: MonadResource m => Logger -> Service -> Proxy * ListAccountsForParent -> ClientResponse -> m (Response ListAccountsForParent)

ToQuery ListAccountsForParent

Methods

toQuery :: ListAccountsForParent -> QueryString

ToPath ListAccountsForParent

Methods

toPath :: ListAccountsForParent -> ByteString

ToHeaders ListAccountsForParent

Methods

toHeaders :: ListAccountsForParent -> [Header]

type Rep ListAccountsForParent

type Rep ListAccountsForParent = D1 (MetaData "ListAccountsForParent" "Network.AWS.Organizations.ListAccountsForParent" "amazonka-organizations-1.5.0-9d9i18lsT75IlwObP60hiK" False) (C1 (MetaCons "ListAccountsForParent'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lafpNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lafpMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_lafpParentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs ListAccountsForParent

type Rs ListAccountsForParent = ListAccountsForParentResponse

Request Lenses

lafpNextToken :: Lens' ListAccountsForParent (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.

lafpMaxResults :: Lens' ListAccountsForParent (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.

lafpParentId :: Lens' ListAccountsForParent Text

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

Destructuring the Response

listAccountsForParentResponse

Arguments

:: Int

lafprsResponseStatus

-> ListAccountsForParentResponse

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

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

• lafprsAccounts - A list of the accounts in the specified root or OU.
• lafprsNextToken - 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 .
• lafprsResponseStatus - -- | The response status code.

data ListAccountsForParentResponse

See: listAccountsForParentResponse smart constructor.

Instances

Eq ListAccountsForParentResponse

Methods

(==) :: ListAccountsForParentResponse -> ListAccountsForParentResponse -> Bool

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

Data ListAccountsForParentResponse

Methods

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

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

toConstr :: ListAccountsForParentResponse -> Constr

dataTypeOf :: ListAccountsForParentResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Show ListAccountsForParentResponse

Methods

showsPrec :: Int -> ListAccountsForParentResponse -> ShowS

show :: ListAccountsForParentResponse -> String

showList :: [ListAccountsForParentResponse] -> ShowS

Generic ListAccountsForParentResponse

Associated Types

type Rep ListAccountsForParentResponse :: * -> *

Methods

from :: ListAccountsForParentResponse -> Rep ListAccountsForParentResponse x

to :: Rep ListAccountsForParentResponse x -> ListAccountsForParentResponse

NFData ListAccountsForParentResponse

Methods

rnf :: ListAccountsForParentResponse -> ()

type Rep ListAccountsForParentResponse

type Rep ListAccountsForParentResponse = D1 (MetaData "ListAccountsForParentResponse" "Network.AWS.Organizations.ListAccountsForParent" "amazonka-organizations-1.5.0-9d9i18lsT75IlwObP60hiK" False) (C1 (MetaCons "ListAccountsForParentResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lafprsAccounts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Account]))) ((:*:) (S1 (MetaSel (Just Symbol "_lafprsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lafprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

lafprsAccounts :: Lens' ListAccountsForParentResponse [Account]

A list of the accounts in the specified root or OU.

lafprsNextToken :: Lens' ListAccountsForParentResponse (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 .

lafprsResponseStatus :: Lens' ListAccountsForParentResponse Int

• - | The response status code.