organizations_describe_policy: Retrieves information about a policy

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

Description

Retrieves information about a policy.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.

Usage

1

Arguments

PolicyId

[required] The unique identifier (ID) of 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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
list(
  Policy = list(
    PolicySummary = list(
      Id = "string",
      Arn = "string",
      Name = "string",
      Description = "string",
      Type = "SERVICE_CONTROL_POLICY"|"TAG_POLICY"|"BACKUP_POLICY"|"AISERVICES_OPT_OUT_POLICY",
      AwsManaged = TRUE|FALSE
    ),
    Content = "string"
  )
)

Request syntax

1
2
3
svc$describe_policy(
  PolicyId = "string"
)

Examples

1
2
3
4
5
6
7
8
## Not run: 
# The following example shows how to request information about a
# policy:/n/n
svc$describe_policy(
  PolicyId = "p-examplepolicyid111"
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.