Organizations.Client.
list_targets_for_policy
(**kwargs)¶Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.
Note
Always check the NextToken
response parameter for a null
value when calling a List*
operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken
response parameter value is null
only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
See also: AWS API Documentation
Request Syntax
response = client.list_targets_for_policy(
PolicyId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The unique identifier (ID) of the policy whose attachments you want to know.
The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
NextToken
response in a previous request. A NextToken
response indicates that more output is available. Set this parameter to the value of the previous call's NextToken
response to indicate where the output should continue from.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.dict
Response Syntax
{
'Targets': [
{
'TargetId': 'string',
'Arn': 'string',
'Name': 'string',
'Type': 'ACCOUNT'|'ORGANIZATIONAL_UNIT'|'ROOT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Targets (list) --
A list of structures, each of which contains details about one of the entities to which the specified policy is attached.
(dict) --
Contains information about a root, OU, or account that a policy is attached to.
TargetId (string) --
The unique identifier (ID) of the policy target.
The regex pattern for a target ID string requires one of the following:
Arn (string) --
The Amazon Resource Name (ARN) of the policy target.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .
Name (string) --
The friendly name of the policy target.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
Type (string) --
The type of the policy target.
NextToken (string) --
If present, indicates that more output is 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
.
Exceptions
Organizations.Client.exceptions.AccessDeniedException
Organizations.Client.exceptions.AWSOrganizationsNotInUseException
Organizations.Client.exceptions.InvalidInputException
Organizations.Client.exceptions.PolicyNotFoundException
Organizations.Client.exceptions.ServiceException
Organizations.Client.exceptions.TooManyRequestsException
Organizations.Client.exceptions.UnsupportedAPIEndpointException
Examples
The following example shows how to get the list of roots, OUs, and accounts to which the specified policy is attached:/n/n
response = client.list_targets_for_policy(
PolicyId='p-FullAWSAccess',
)
print(response)
Expected Output:
{
'Targets': [
{
'Arn': 'arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111',
'Name': 'Root',
'TargetId': 'r-examplerootid111',
'Type': 'ROOT',
},
{
'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333;',
'Name': 'Developer Test Account',
'TargetId': '333333333333',
'Type': 'ACCOUNT',
},
{
'Arn': 'arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111',
'Name': 'Accounting',
'TargetId': 'ou-examplerootid111-exampleouid111',
'Type': 'ORGANIZATIONAL_UNIT',
},
],
'ResponseMetadata': {
'...': '...',
},
}