Network.AWS.Organizations.ListRoots

Lists the roots that are defined in the current organization.

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

This operation returns paginated results.

Creating a Request

listRoots :: ListRoots

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

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

• lrNextToken - 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.
• lrMaxResults - (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.

data ListRoots

See: listRoots smart constructor.

Instances

Eq ListRoots

Methods

(==) :: ListRoots -> ListRoots -> Bool

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

Data ListRoots

Methods

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

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

toConstr :: ListRoots -> Constr

dataTypeOf :: ListRoots -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListRoots

Methods

readsPrec :: Int -> ReadS ListRoots

readList :: ReadS [ListRoots]

readPrec :: ReadPrec ListRoots

readListPrec :: ReadPrec [ListRoots]

Show ListRoots

Methods

showsPrec :: Int -> ListRoots -> ShowS

show :: ListRoots -> String

showList :: [ListRoots] -> ShowS

Generic ListRoots

Associated Types

type Rep ListRoots :: * -> *

Methods

from :: ListRoots -> Rep ListRoots x

to :: Rep ListRoots x -> ListRoots

Hashable ListRoots

Methods

hashWithSalt :: Int -> ListRoots -> Int

hash :: ListRoots -> Int

ToJSON ListRoots

Methods

toJSON :: ListRoots -> Value

toEncoding :: ListRoots -> Encoding

toJSONList :: [ListRoots] -> Value

toEncodingList :: [ListRoots] -> Encoding

NFData ListRoots

Methods

rnf :: ListRoots -> ()

AWSPager ListRoots

Methods

page :: ListRoots -> Rs ListRoots -> Maybe ListRoots

AWSRequest ListRoots

Associated Types

type Rs ListRoots :: *

Methods

request :: ListRoots -> Request ListRoots

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

ToHeaders ListRoots

Methods

toHeaders :: ListRoots -> [Header]

ToPath ListRoots

Methods

toPath :: ListRoots -> ByteString

ToQuery ListRoots

Methods

toQuery :: ListRoots -> QueryString

type Rep ListRoots

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

type Rs ListRoots

type Rs ListRoots = ListRootsResponse

Request Lenses

lrNextToken :: Lens' ListRoots (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.

lrMaxResults :: Lens' ListRoots (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.

Destructuring the Response

listRootsResponse

Arguments

:: Int

lrrsResponseStatus

-> ListRootsResponse

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

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

• lrrsRoots - A list of roots that are defined in an organization.
• lrrsNextToken - 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 .
• lrrsResponseStatus - -- | The response status code.

data ListRootsResponse

See: listRootsResponse smart constructor.

Instances

Eq ListRootsResponse

Methods

(==) :: ListRootsResponse -> ListRootsResponse -> Bool

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

Data ListRootsResponse

Methods

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

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

toConstr :: ListRootsResponse -> Constr

dataTypeOf :: ListRootsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListRootsResponse

Methods

readsPrec :: Int -> ReadS ListRootsResponse

readList :: ReadS [ListRootsResponse]

readPrec :: ReadPrec ListRootsResponse

readListPrec :: ReadPrec [ListRootsResponse]

Show ListRootsResponse

Methods

showsPrec :: Int -> ListRootsResponse -> ShowS

show :: ListRootsResponse -> String

showList :: [ListRootsResponse] -> ShowS

Generic ListRootsResponse

Associated Types

type Rep ListRootsResponse :: * -> *

Methods

from :: ListRootsResponse -> Rep ListRootsResponse x

to :: Rep ListRootsResponse x -> ListRootsResponse

NFData ListRootsResponse

Methods

rnf :: ListRootsResponse -> ()

type Rep ListRootsResponse

type Rep ListRootsResponse = D1 * (MetaData "ListRootsResponse" "Network.AWS.Organizations.ListRoots" "amazonka-organizations-1.6.0-rHxjcIb8Bn6XT7VgZWDi9" False) (C1 * (MetaCons "ListRootsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lrrsRoots") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Root]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lrrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lrrsRoots :: Lens' ListRootsResponse [Root]

A list of roots that are defined in an organization.

lrrsNextToken :: Lens' ListRootsResponse (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 .

lrrsResponseStatus :: Lens' ListRootsResponse Int

• - | The response status code.