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.ListPolicies

Contents

Description

Retrieves the list of all policies in an organization of a specified type.

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

This operation returns paginated results.

Synopsis

Creating a Request

listPolicies Source #

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

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

  • lpNextToken - 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.
  • lpMaxResults - (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.
  • lpFilter - Specifies the type of policy that you want to include in the response.

data ListPolicies Source #

See: listPolicies smart constructor.

Instances
Eq ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Data ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Methods

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

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

toConstr :: ListPolicies -> Constr #

dataTypeOf :: ListPolicies -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListPolicies) #

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

gmapT :: (forall b. Data b => b -> b) -> ListPolicies -> ListPolicies #

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

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

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

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

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

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

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

Read ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Show ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Generic ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Associated Types

type Rep ListPolicies :: Type -> Type #

Hashable ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

ToJSON ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

AWSPager ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

AWSRequest ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Associated Types

type Rs ListPolicies :: Type #

ToHeaders ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

ToPath ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

ToQuery ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

NFData ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Methods

rnf :: ListPolicies -> () #

type Rep ListPolicies Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

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

Defined in Network.AWS.Organizations.ListPolicies

Request Lenses

lpNextToken :: Lens' ListPolicies (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.

lpMaxResults :: Lens' ListPolicies (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.

lpFilter :: Lens' ListPolicies PolicyType Source #

Specifies the type of policy that you want to include in the response.

Destructuring the Response

listPoliciesResponse Source #

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

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

  • lprsNextToken - 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 .
  • lprsPolicies - A list of policies that match the filter criteria in the request. The output list does not include the policy contents. To see the content for a policy, see DescribePolicy .
  • lprsResponseStatus - -- | The response status code.

data ListPoliciesResponse Source #

See: listPoliciesResponse smart constructor.

Instances
Eq ListPoliciesResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Data ListPoliciesResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Methods

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

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

toConstr :: ListPoliciesResponse -> Constr #

dataTypeOf :: ListPoliciesResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListPoliciesResponse) #

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

gmapT :: (forall b. Data b => b -> b) -> ListPoliciesResponse -> ListPoliciesResponse #

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

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

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

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

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

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

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

Read ListPoliciesResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Show ListPoliciesResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Generic ListPoliciesResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Associated Types

type Rep ListPoliciesResponse :: Type -> Type #

NFData ListPoliciesResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

Methods

rnf :: ListPoliciesResponse -> () #

type Rep ListPoliciesResponse Source # 
Instance details

Defined in Network.AWS.Organizations.ListPolicies

type Rep ListPoliciesResponse = D1 (MetaData "ListPoliciesResponse" "Network.AWS.Organizations.ListPolicies" "amazonka-organizations-1.6.1-AXMOvAV6jebLVZPNUpIjqF" False) (C1 (MetaCons "ListPoliciesResponse'" PrefixI True) (S1 (MetaSel (Just "_lprsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lprsPolicies") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PolicySummary])) :*: S1 (MetaSel (Just "_lprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lprsNextToken :: Lens' ListPoliciesResponse (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 .

lprsPolicies :: Lens' ListPoliciesResponse [PolicySummary] Source #

A list of policies that match the filter criteria in the request. The output list does not include the policy contents. To see the content for a policy, see DescribePolicy .

lprsResponseStatus :: Lens' ListPoliciesResponse Int Source #

  • - | The response status code.