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.

Retrieves information about a policy.

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

Note:

For PCL this operation is only available in asynchronous form. Please refer to DescribePolicyAsync.

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

Syntax

C#
public abstract DescribePolicyResponse DescribePolicy(
         DescribePolicyRequest request
)
Parameters
request
Type: Amazon.Organizations.Model.DescribePolicyRequest

Container for the necessary parameters to execute the DescribePolicy service method.

Return Value
The response from the DescribePolicy service method, as returned by Organizations.

Exceptions

ExceptionCondition
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.
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.
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: 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.
PolicyNotFoundException We can't find a policy with the PolicyId that you specified.
ServiceException AWS Organizations can't complete your request because of an internal service error. Try again later.
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.

Examples

The following example shows how to request information about a policy:/n/n

To get information about a policy


var response = client.DescribePolicy(new DescribePolicyRequest 
{
    PolicyId = "p-examplepolicyid111"
});

Policy policy = response.Policy;

            

Version Information

.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

See Also