Table Of Contents

Feedback

User Guide

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

[ aws . organizations ]

update-policy

Description

Updates an existing policy with a new name, description, or content. If any parameter is not supplied, that value remains unchanged. Note that you cannot change a policy's type.

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

See also: AWS API Documentation

Synopsis

  update-policy
--policy-id <value>
[--name <value>]
[--description <value>]
[--content <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--policy-id (string)

The unique identifier (ID) of the policy that you want to update.

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

--name (string)

If provided, the new name for the policy.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

--description (string)

If provided, the new description for the policy.

--content (string)

If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see Service Control Policy Syntax in the AWS Organizations User Guide .

--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.

--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.

Examples

Example 1: To rename a policy

The following example shows you how to rename a policy and give it a new description:

aws organizations update-policy --policy-id p-examplepolicyid111 --name Renamed-Policy --description "This description replaces the original."

The output shows the new name and description:

{
        "Policy": {
                "Content": "{\n  \"Version\":\"2012-10-17\",\n  \"Statement\":{\n    \"Effect\":\"Allow\",\n    \"Action\":\"ec2:*\",\n    \"Resource\":\"*\"\n  }\n}\n",
                "PolicySummary": {
                        "Id": "p-examplepolicyid111",
                        "AwsManaged": false,
                        "Arn":"arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
                        "Description": "This description replaces the original.",
                        "Name": "Renamed-Policy",
                        "Type": "SERVICE_CONTROL_POLICY"
                }
        }
}

Example 2: To replace a policy's JSON text content

The following example shows you how to replace the JSON text of the SCP in the previous example with a new JSON policy text string that allows S3 instead of EC2:

aws organizations --policy-id p-examplepolicyid111, --content "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}"

The output shows the new content:

{
        "Policy": {
                "Content": "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"s3:*\", \"Resource\": \"*\" } }",
                "PolicySummary": {
                        "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
                        "AwsManaged": false;
                        "Description": "This description replaces the original.",
                        "Id": "p-examplepolicyid111",
                        "Name": "Renamed-Policy",
                        "Type": "SERVICE_CONTROL_POLICY"
                }
        }
}

Output

Policy -> (structure)

A structure that contains details about the updated policy, showing the requested changes.

PolicySummary -> (structure)

A structure that contains additional details about the policy.

Id -> (string)

The unique identifier (ID) of the policy.

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

Arn -> (string)

The Amazon Resource Name (ARN) of the policy.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide .

Name -> (string)

The friendly name of the policy.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

Description -> (string)

The description of the policy.

Type -> (string)

The type of policy.

AwsManaged -> (boolean)

A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

Content -> (string)

The text content of the policy.