Menu
AWS Organizations API Reference
API Reference (API Version 2016-11-28)

ListTargetsForPolicy

Lists all the roots, OUs, and accounts to which the specified policy is attached.

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

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

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 20.

Required: No

NextToken

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.

Type: String

Required: No

PolicyId

The unique identifier (ID) of the policy for which you want to know its attachments.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.

Type: String

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

Type: String

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 is not 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:

  • INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

  • INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.

  • INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

  • INVALID_ENUM: You specified a value that is not valid for that parameter.

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

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

  • IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.

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

  • INPUT_REQUIRED: You must include a value for all required parameters.

  • INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

  • MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

  • MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

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: 400

TooManyRequestsException

You've sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

HTTP Status Code: 400

Example

The following example shows how to get the list of roots, OUs, and accounts to which the specified policy is attached:

Sample Request

POST / HTTP/1.1
Host: organizations.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 31
X-Amz-Target: AWSOrganizationsV20161128.ListTargetsForPolicy
X-Amz-Date: 20161216T191821Z
User-Agent: aws-cli/1.11.13 Python/2.7.8 Linux/3.2.45-0.6.wd.865.49.315.metal1.x86_64 botocore/1.4.70
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
  Credential=AKIAIOSFODNN7EXAMPLE/20161216/us-east-1/organizations/aws4_request,
  SignedHeaders=content-type;host;x-amz-date;x-amz-target,
  Signature=EXAMPLESIGabcdef1234567890abcdef1234567890abcdef123456EXAMPLESIG

{ "PolicyId": "p-FullAWSAccess" }

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: EXAMPLE8-90ab-cdef-fedc-ba987EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 720
Date: Fri, 16 Dec 2016 19:18:22 GMT

{
  "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: