Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . organizations ]

describe-effective-policy

Description

Returns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified type that the account inherits, plus any policy of that type that is directly attached to the account.

This operation applies only to policy types other than service control policies (SCPs).

For more information about policy inheritance, see How Policy Inheritance Works in the AWS Organizations User Guide .

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-effective-policy
--policy-type <value>
[--target-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--policy-type (string)

The type of policy that you want information about. You can specify one of the following values:

Possible values:

  • TAG_POLICY
  • BACKUP_POLICY

--target-id (string)

When you're signed in as the master account, specify the ID of the account that you want details about. Specifying an organization root or organizational unit (OU) as the target is not supported.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

EffectivePolicy -> (structure)

The contents of the effective policy.

PolicyContent -> (string)

The text content of the policy.

LastUpdatedTimestamp -> (timestamp)

The time of the last update to this policy.

TargetId -> (string)

The account ID of the policy target.

PolicyType -> (string)

The policy type.