import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { UpdatePolicyRequest, UpdatePolicyResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link UpdatePolicyCommand}. */ export interface UpdatePolicyCommandInput extends UpdatePolicyRequest { } /** * @public * * The output of {@link UpdatePolicyCommand}. */ export interface UpdatePolicyCommandOutput extends UpdatePolicyResponse, __MetadataBearer { } declare const UpdatePolicyCommand_base: { new (input: UpdatePolicyCommandInput): import("@smithy/core/client").CommandImpl; new (input: UpdatePolicyCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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.

*

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { OrganizationsClient, UpdatePolicyCommand } from "@aws-sdk/client-organizations"; // ES Modules import * // const { OrganizationsClient, UpdatePolicyCommand } = require("@aws-sdk/client-organizations"); // CommonJS import * // import type { OrganizationsClientConfig } from "@aws-sdk/client-organizations"; * const config = {}; // type is OrganizationsClientConfig * const client = new OrganizationsClient(config); * const input = { // UpdatePolicyRequest * PolicyId: "STRING_VALUE", // required * Name: "STRING_VALUE", * Description: "STRING_VALUE", * Content: "STRING_VALUE", * }; * const command = new UpdatePolicyCommand(input); * const response = await client.send(command); * // { // UpdatePolicyResponse * // Policy: { // Policy * // PolicySummary: { // PolicySummary * // Id: "STRING_VALUE", * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // Description: "STRING_VALUE", * // 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_VALUE", * // }, * // }; * * ``` * * @param UpdatePolicyCommandInput - {@link UpdatePolicyCommandInput} * @returns {@link UpdatePolicyCommandOutput} * @see {@link UpdatePolicyCommandInput} for command's `input` shape. * @see {@link UpdatePolicyCommandOutput} for command's `response` shape. * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You don't have permissions to perform the requested operation. The user or role that * is making the request must have at least one IAM permissions policy attached that * grants the required permissions. For more information, see Access Management in the * IAM User Guide.

* * @throws {@link AWSOrganizationsNotInUseException} (client fault) *

Your account isn't a member of an organization. To make this request, you must use the * credentials of an account that belongs to an organization.

* * @throws {@link ConcurrentModificationException} (client fault) *

The target of the operation is currently being modified by a different request. Try * again later.

* * @throws {@link ConstraintViolationException} (client fault) *

Performing this operation violates a minimum or maximum value limit. For example, * attempting to remove the last service control policy (SCP) from an OU or root, inviting * or creating too many accounts to the organization, or attaching too many policies to an * account, OU, or root. This exception includes a reason that contains additional * information about the violated limit:

* *

Some of the reasons in the following list might not be applicable to this specific * API or operation.

* * * * @throws {@link DuplicatePolicyException} (client fault) *

A policy with the same name already exists.

* * @throws {@link InvalidInputException} (client fault) *

The requested operation failed because you provided invalid values for one or more of * the request parameters. This exception includes a reason that contains additional * information about the violated limit:

* *

Some of the reasons in the following list might not be applicable to this specific * API or operation.

* * * * @throws {@link MalformedPolicyDocumentException} (client fault) *

The provided policy document doesn't meet the requirements of the specified policy * type. For example, the syntax might be incorrect. For details about service control * policy syntax, see SCP syntax in the * Organizations User Guide.

* * @throws {@link PolicyChangesInProgressException} (client fault) *

Changes to the effective policy are in progress, and its contents can't be returned. * Try the operation again later.

* * @throws {@link PolicyNotFoundException} (client fault) *

We can't find a policy with the PolicyId that you specified.

* * @throws {@link ServiceException} (server fault) *

Organizations can't complete your request because of an internal service error. Try again * later.

* * @throws {@link TooManyRequestsException} (client fault) *

You have sent too many requests in too short a period of time. The quota helps protect * against denial-of-service attacks. Try again later.

*

For information about quotas that affect Organizations, see Quotas for Organizations in the * Organizations User Guide.

* * @throws {@link UnsupportedAPIEndpointException} (client fault) *

This action isn't available in the current Amazon Web Services Region.

* * @throws {@link OrganizationsServiceException} *

Base exception class for all service exceptions from Organizations service.

* * * @example To update the content of a policy * ```javascript * // The following example shows how to replace the JSON text of the SCP from the preceding example with a new JSON policy text string that allows S3 actions instead of EC2 actions:/n/n * const input = { * Content: `{ \"Version\": \"2012-10-17\", \"Statement\": {\"Effect\": \"Allow\", \"Action\": \"s3:*\", \"Resource\": \"*\" } }`, * PolicyId: "p-examplepolicyid111" * }; * const command = new UpdatePolicyCommand(input); * const response = await client.send(command); * /* response is * { * 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" * } * } * } * *\/ * ``` * * @example To update the details of a policy * ```javascript * // The following example shows how to rename a policy and give it a new description and new content. The output confirms the new name and description text:/n/n * const input = { * Description: "This description replaces the original.", * Name: "Renamed-Policy", * PolicyId: "p-examplepolicyid111" * }; * const command = new UpdatePolicyCommand(input); * const response = await client.send(command); * /* response is * { * Policy: { * Content: `{ "Version": "2012-10-17", "Statement": { "Effect": "Allow", "Action": "ec2:*", "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" * } * } * } * *\/ * ``` * * @public */ export declare class UpdatePolicyCommand extends UpdatePolicyCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdatePolicyRequest; output: UpdatePolicyResponse; }; sdk: { input: UpdatePolicyCommandInput; output: UpdatePolicyCommandOutput; }; }; }