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

PolicyTargetSummary

Contains information about a root, OU, or account that a policy is attached to.

Contents

Arn

The Amazon Resource Name (ARN) of the policy target.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

Type: String

Pattern: ^arn:aws:organizations::.+:.+

Required: No

Name

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

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

TargetId

The unique identifier (ID) of the policy target.

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.

Type: String

Pattern: ^(r-[0-9a-z]{4,32})|(\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$

Required: No

Type

The type of the policy target.

Type: String

Valid Values: ACCOUNT | ORGANIZATIONAL_UNIT | ROOT

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: