organizations_update_policy: Updates an existing policy with a new name, description, or...

View source: R/organizations_operations.R

organizations_update_policyR Documentation

Updates an existing policy with a new name, description, or content

Description

Updates an existing policy with a new name, description, or content. If you don't supply any parameter, that value remains unchanged. You can't change a policy's type.

See https://www.paws-r-sdk.com/docs/organizations_update_policy/ for full documentation.

Usage

organizations_update_policy(
  PolicyId,
  Name = NULL,
  Description = NULL,
  Content = NULL
)

Arguments

PolicyId

[required] 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 lowercase or uppercase letters, digits, or the underscore character (_).

Name

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

If provided, the new description for the policy.

Content

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 SCP syntax in the Organizations User Guide.

The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide.


paws.management documentation built on Sept. 12, 2024, 6:19 a.m.