Describe Policy

organizations_describe_policy

R Documentation

Retrieves information about a policy¶

Description¶

Retrieves information about a policy.

You can only call this operation from the management account or a member account that is a delegated administrator.

Usage¶

organizations_describe_policy(PolicyId)

Arguments¶

PolicyId

[required] ID for the policy that you want details about. You can get the ID from the list_policies or list_policies_for_target operations.

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

Value¶

A list with the following syntax:

list(
  Policy = list(
    PolicySummary = list(
      Id = "string",
      Arn = "string",
      Name = "string",
      Description = "string",
      Type = "SERVICE_CONTROL_POLICY"|"RESOURCE_CONTROL_POLICY"|"TAG_POLICY"|"BACKUP_POLICY"|"AISERVICES_OPT_OUT_POLICY"|"CHATBOT_POLICY"|"DECLARATIVE_POLICY_EC2"|"SECURITYHUB_POLICY"|"INSPECTOR_POLICY"|"UPGRADE_ROLLOUT_POLICY"|"BEDROCK_POLICY"|"S3_POLICY"|"NETWORK_SECURITY_DIRECTOR_POLICY",
      AwsManaged = TRUE|FALSE
    ),
    Content = "string"
  )
)

Request syntax¶

svc$describe_policy(
  PolicyId = "string"
)

Examples¶

## Not run: 
# The following example shows how to request information about a
# policy:/n/n
svc$describe_policy(
  PolicyId = "p-examplepolicyid111"
)

## End(Not run)