AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the AttachPolicy operation. Attaches a policy to a root, an organizational unit, or an individual account. How the policy affects accounts depends on the type of policy:

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Organizations.AmazonOrganizationsRequest
      Amazon.Organizations.Model.AttachPolicyRequest

Namespace: Amazon.Organizations.Model
Assembly: AWSSDK.Organizations.dll
Version: 3.x.y.z

Syntax

C#
public class AttachPolicyRequest : AmazonOrganizationsRequest
         IAmazonWebServiceRequest

The AttachPolicyRequest type exposes the following members

Constructors

NameDescription
Public Method AttachPolicyRequest()

Properties

NameTypeDescription
Public Property PolicyId System.String

Gets and sets the property PolicyId.

The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the ListPolicies operation.

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

Public Property TargetId System.String

Gets and sets the property TargetId.

The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.

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.

Examples

The following example shows how to attach a service control policy (SCP) to an OU:

To attach a policy to an OU


var response = client.AttachPolicy(new AttachPolicyRequest 
{
    PolicyId = "p-examplepolicyid111",
    TargetId = "ou-examplerootid111-exampleouid111"
});


            

The following example shows how to attach a service control policy (SCP) to an account:

To attach a policy to an account


var response = client.AttachPolicy(new AttachPolicyRequest 
{
    PolicyId = "p-examplepolicyid111",
    TargetId = "333333333333"
});


            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms