Network.AWS.Organizations.ListPolicies

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.

Creating a Request

listPolicies

Arguments

:: PolicyType

lpFilter

-> ListPolicies

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

See: listPolicies smart constructor.

Instances

Eq ListPolicies

Methods

(==) :: ListPolicies -> ListPolicies -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS ListPolicies

readList :: ReadS [ListPolicies]

readPrec :: ReadPrec ListPolicies

readListPrec :: ReadPrec [ListPolicies]

Show ListPolicies

Methods

showsPrec :: Int -> ListPolicies -> ShowS

show :: ListPolicies -> String

showList :: [ListPolicies] -> ShowS

Generic ListPolicies

Associated Types

type Rep ListPolicies :: * -> *

Methods

from :: ListPolicies -> Rep ListPolicies x

to :: Rep ListPolicies x -> ListPolicies

Hashable ListPolicies

Methods

hashWithSalt :: Int -> ListPolicies -> Int

hash :: ListPolicies -> Int

ToJSON ListPolicies

Methods

toJSON :: ListPolicies -> Value

toEncoding :: ListPolicies -> Encoding

toJSONList :: [ListPolicies] -> Value

toEncodingList :: [ListPolicies] -> Encoding

NFData ListPolicies

Methods

rnf :: ListPolicies -> ()

AWSPager ListPolicies

Methods

page :: ListPolicies -> Rs ListPolicies -> Maybe ListPolicies

AWSRequest ListPolicies

Associated Types

type Rs ListPolicies :: *

Methods

request :: ListPolicies -> Request ListPolicies

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

ToQuery ListPolicies

Methods

toQuery :: ListPolicies -> QueryString

ToPath ListPolicies

Methods

toPath :: ListPolicies -> ByteString

ToHeaders ListPolicies

Methods

toHeaders :: ListPolicies -> [Header]

type Rep ListPolicies

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

type Rs ListPolicies

type Rs ListPolicies = ListPoliciesResponse

Request Lenses

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

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

lpFilter :: Lens' ListPolicies PolicyType

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

Destructuring the Response

listPoliciesResponse

Arguments

:: Int

lprsResponseStatus

-> ListPoliciesResponse

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

See: listPoliciesResponse smart constructor.

Instances

Eq ListPoliciesResponse

Methods

(==) :: ListPoliciesResponse -> ListPoliciesResponse -> Bool

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

Data ListPoliciesResponse

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

Methods

readsPrec :: Int -> ReadS ListPoliciesResponse

readList :: ReadS [ListPoliciesResponse]

readPrec :: ReadPrec ListPoliciesResponse

readListPrec :: ReadPrec [ListPoliciesResponse]

Show ListPoliciesResponse

Methods

showsPrec :: Int -> ListPoliciesResponse -> ShowS

show :: ListPoliciesResponse -> String

showList :: [ListPoliciesResponse] -> ShowS

Generic ListPoliciesResponse

Associated Types

type Rep ListPoliciesResponse :: * -> *

Methods

from :: ListPoliciesResponse -> Rep ListPoliciesResponse x

to :: Rep ListPoliciesResponse x -> ListPoliciesResponse

NFData ListPoliciesResponse

Methods

rnf :: ListPoliciesResponse -> ()

type Rep ListPoliciesResponse

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

Response Lenses

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

lprsPolicies :: Lens' ListPoliciesResponse [PolicySummary]

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

• - | The response status code.