ListTargetsForPolicy
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 AWS service.
Request Syntax
{
"MaxResults": number
,
"NextToken": "string
",
"PolicyId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
The total number of results that you want included on each page of 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 theNextToken
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 checkNextToken
after every operation to ensure that you receive all of the results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No
- NextToken
-
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
response to indicate where the output should continue from.Type: String
Length Constraints: Maximum length of 100000.
Pattern:
[\s\S]*
Required: No
- PolicyId
-
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 (_). Type: String
Length Constraints: Maximum length of 130.
Pattern:
^p-[0-9a-zA-Z_]{8,128}$
Required: Yes
Response Syntax
{
"NextToken": "string",
"Targets": [
{
"Arn": "string",
"Name": "string",
"TargetId": "string",
"Type": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
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 theNextToken
response element comes back asnull
.Type: String
Length Constraints: Maximum length of 100000.
Pattern:
[\s\S]*
- Targets
-
A list of structures, each of which contains details about one of the entities to which the specified policy is attached.
Type: Array of PolicyTargetSummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
HTTP Status Code: 400
- AWSOrganizationsNotInUseException
-
Your account isn't a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.
HTTP Status Code: 400
- InvalidInputException
-
The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:
Note
Some of the reasons in the following list might not be applicable to this specific API or operation.
-
DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.
-
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.
-
INPUT_REQUIRED: You must include a value for all required parameters.
-
INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.
-
INVALID_ENUM: You specified an invalid value.
-
INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.
-
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
-
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
-
INVALID_PAGINATION_TOKEN: Get the value for the
NextToken
parameter from the response to a previous call of the operation. -
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
-
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
-
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
-
INVALID_PRINCIPAL: You specified an invalid principal element in the policy.
-
INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix
AWSServiceRoleFor
. -
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.
-
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
-
INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.
-
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
-
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
-
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
-
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
-
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
-
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
-
NON_DETACHABLE_POLICY: You can't detach this AWS Managed Policy.
-
TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.
-
UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.
HTTP Status Code: 400
-
- PolicyNotFoundException
-
We can't find a policy with the
PolicyId
that you specified.HTTP Status Code: 400
- ServiceException
-
AWS Organizations can't complete your request because of an internal service error. Try again later.
HTTP Status Code: 500
- TooManyRequestsException
-
You have sent too many requests in too short a period of time. The quota helps protect against denial-of-service attacks. Try again later.
For information about quotas that affect AWS Organizations, see Quotas for AWS Organizations in the AWS Organizations User Guide.
HTTP Status Code: 400
- UnsupportedAPIEndpointException
-
This action isn't available in the current AWS Region.
HTTP Status Code: 400
Examples
Example
The following example shows how to get the list of roots, OUs, and accounts that the specified policy is attached to.
Sample Request
POST / HTTP/1.1
X-Amz-Target: AWSOrganizationsV20161128.ListTargetsForPolicy
{ "PolicyId": "p-FullAWSAccess" }
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"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"
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: