Network.AWS.Organizations.ListPoliciesForTarget

Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.

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

This operation returns paginated results.

Creating a Request

listPoliciesForTarget

Arguments

:: Text

lpftTargetId

-> PolicyType

lpftFilter

-> ListPoliciesForTarget

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

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

• lpftNextToken - 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.
• lpftMaxResults - (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.
• lpftTargetId - The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list. The regex pattern for a target 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. * Account: a string that consists of exactly 12 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.
• lpftFilter - The type of policy that you want to include in the returned list.

data ListPoliciesForTarget

See: listPoliciesForTarget smart constructor.

Instances

Eq ListPoliciesForTarget

Methods

(==) :: ListPoliciesForTarget -> ListPoliciesForTarget -> Bool

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

Data ListPoliciesForTarget

Methods

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

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

toConstr :: ListPoliciesForTarget -> Constr

dataTypeOf :: ListPoliciesForTarget -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListPoliciesForTarget

Methods

readsPrec :: Int -> ReadS ListPoliciesForTarget

readList :: ReadS [ListPoliciesForTarget]

readPrec :: ReadPrec ListPoliciesForTarget

readListPrec :: ReadPrec [ListPoliciesForTarget]

Show ListPoliciesForTarget

Methods

showsPrec :: Int -> ListPoliciesForTarget -> ShowS

show :: ListPoliciesForTarget -> String

showList :: [ListPoliciesForTarget] -> ShowS

Generic ListPoliciesForTarget

Associated Types

type Rep ListPoliciesForTarget :: * -> *

Methods

from :: ListPoliciesForTarget -> Rep ListPoliciesForTarget x

to :: Rep ListPoliciesForTarget x -> ListPoliciesForTarget

Hashable ListPoliciesForTarget

Methods

hashWithSalt :: Int -> ListPoliciesForTarget -> Int

hash :: ListPoliciesForTarget -> Int

ToJSON ListPoliciesForTarget

Methods

toJSON :: ListPoliciesForTarget -> Value

toEncoding :: ListPoliciesForTarget -> Encoding

toJSONList :: [ListPoliciesForTarget] -> Value

toEncodingList :: [ListPoliciesForTarget] -> Encoding

NFData ListPoliciesForTarget

Methods

rnf :: ListPoliciesForTarget -> ()

AWSPager ListPoliciesForTarget

Methods

page :: ListPoliciesForTarget -> Rs ListPoliciesForTarget -> Maybe ListPoliciesForTarget

AWSRequest ListPoliciesForTarget

Associated Types

type Rs ListPoliciesForTarget :: *

Methods

request :: ListPoliciesForTarget -> Request ListPoliciesForTarget

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

ToQuery ListPoliciesForTarget

Methods

toQuery :: ListPoliciesForTarget -> QueryString

ToPath ListPoliciesForTarget

Methods

toPath :: ListPoliciesForTarget -> ByteString

ToHeaders ListPoliciesForTarget

Methods

toHeaders :: ListPoliciesForTarget -> [Header]

type Rep ListPoliciesForTarget

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

type Rs ListPoliciesForTarget

type Rs ListPoliciesForTarget = ListPoliciesForTargetResponse

Request Lenses

lpftNextToken :: Lens' ListPoliciesForTarget (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.

lpftMaxResults :: Lens' ListPoliciesForTarget (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.

lpftTargetId :: Lens' ListPoliciesForTarget Text

The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list. The regex pattern for a target 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. * Account: a string that consists of exactly 12 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.

lpftFilter :: Lens' ListPoliciesForTarget PolicyType

The type of policy that you want to include in the returned list.

Destructuring the Response

listPoliciesForTargetResponse

Arguments

:: Int

lpftrsResponseStatus

-> ListPoliciesForTargetResponse

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

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

• lpftrsNextToken - 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 .
• lpftrsPolicies - The list of policies that match the criteria in the request.
• lpftrsResponseStatus - -- | The response status code.

data ListPoliciesForTargetResponse

See: listPoliciesForTargetResponse smart constructor.

Instances

Eq ListPoliciesForTargetResponse

Methods

(==) :: ListPoliciesForTargetResponse -> ListPoliciesForTargetResponse -> Bool

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

Data ListPoliciesForTargetResponse

Methods

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

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

toConstr :: ListPoliciesForTargetResponse -> Constr

dataTypeOf :: ListPoliciesForTargetResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListPoliciesForTargetResponse

Methods

readsPrec :: Int -> ReadS ListPoliciesForTargetResponse

readList :: ReadS [ListPoliciesForTargetResponse]

readPrec :: ReadPrec ListPoliciesForTargetResponse

readListPrec :: ReadPrec [ListPoliciesForTargetResponse]

Show ListPoliciesForTargetResponse

Methods

showsPrec :: Int -> ListPoliciesForTargetResponse -> ShowS

show :: ListPoliciesForTargetResponse -> String

showList :: [ListPoliciesForTargetResponse] -> ShowS

Generic ListPoliciesForTargetResponse

Associated Types

type Rep ListPoliciesForTargetResponse :: * -> *

Methods

from :: ListPoliciesForTargetResponse -> Rep ListPoliciesForTargetResponse x

to :: Rep ListPoliciesForTargetResponse x -> ListPoliciesForTargetResponse

NFData ListPoliciesForTargetResponse

Methods

rnf :: ListPoliciesForTargetResponse -> ()

type Rep ListPoliciesForTargetResponse

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

Response Lenses

lpftrsNextToken :: Lens' ListPoliciesForTargetResponse (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 .

lpftrsPolicies :: Lens' ListPoliciesForTargetResponse [PolicySummary]

The list of policies that match the criteria in the request.

lpftrsResponseStatus :: Lens' ListPoliciesForTargetResponse Int

• - | The response status code.