UpdatePolicyTemplate
Updates the specified policy template. You can update only the description and the some elements of the policyBody.
Important
Changes you make to the policy template content are immediately (within the constraints of eventual consistency) reflected in authorization decisions that involve all template-linked policies instantiated from this template.
Note
Verified Permissions is
eventually consistent
Request Syntax
{
"description": "string
",
"policyStoreId": "string
",
"policyTemplateId": "string
",
"statement": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- policyStoreId
-
Specifies the ID of the policy store that contains the policy template that you want to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[a-zA-Z0-9-]*
Required: Yes
- policyTemplateId
-
Specifies the ID of the policy template that you want to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[a-zA-Z0-9-]*
Required: Yes
- statement
-
Specifies new statement content written in Cedar policy language to replace the current body of the policy template.
You can change only the following elements of the policy body:
-
The
action
referenced by the policy template. -
Any conditional clauses, such as
when
orunless
clauses.
You can't change the following elements:
-
The effect (
permit
orforbid
) of the policy template. -
The
principal
referenced by the policy template. -
The
resource
referenced by the policy template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10000.
Required: Yes
-
- description
-
Specifies a new description to apply to the policy template.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 150.
Required: No
Response Syntax
{
"createdDate": "string",
"lastUpdatedDate": "string",
"policyStoreId": "string",
"policyTemplateId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- createdDate
-
The date and time that the policy template was originally created.
Type: Timestamp
- lastUpdatedDate
-
The date and time that the policy template was most recently updated.
Type: Timestamp
- policyStoreId
-
The ID of the policy store that contains the updated policy template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[a-zA-Z0-9-]*
- policyTemplateId
-
The ID of the updated policy template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[a-zA-Z0-9-]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access to perform this action.
HTTP Status Code: 400
- ConflictException
-
The request failed because another request to modify a resource occurred at the same.
HTTP Status Code: 400
- InternalServerException
-
The request failed because of an internal error. Try your request again later
HTTP Status Code: 500
- ResourceNotFoundException
-
The request failed because it references a resource that doesn't exist.
HTTP Status Code: 400
- ThrottlingException
-
The request failed because it exceeded a throttling quota.
HTTP Status Code: 400
- ValidationException
-
The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.
The possible reasons include the following:
-
UnrecognizedEntityType
The policy includes an entity type that isn't found in the schema.
-
UnrecognizedActionId
The policy includes an action id that isn't found in the schema.
-
InvalidActionApplication
The policy includes an action that, according to the schema, doesn't support the specified principal and resource.
-
UnexpectedType
The policy included an operand that isn't a valid type for the specified operation.
-
IncompatibleTypes
The types of elements included in a
set
, or the types of expressions used in anif...then...else
clause aren't compatible in this context. -
MissingAttribute
The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator
in the Cedar Policy Language Guide. -
UnsafeOptionalAttributeAccess
The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator
in the Cedar Policy Language Guide. -
ImpossiblePolicy
Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.
-
WrongNumberArguments
The policy references an extension type with the wrong number of arguments.
-
FunctionArgumentValidationError
Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.
HTTP Status Code: 400
-
Examples
Example
The following example updates a policy template with both a new description and a new
policy body. The effect
, principal
, and
resource
are the same as the original policy template. Only the
action
in the head, and the when
and
unless
clauses can be different.
Note
The JSON in the parameters of this operation are strings that can
contain embedded quotation marks ("
) within the outermost quotation mark pair. When you are calling the
API directly, using a tool like the AWS CLI or Postman, you have to stringify the JSON object by preceding all embedded
quotation marks with a backslash character ( \"
) and combining all lines into a
single text line with no line breaks.
Example strings are displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.
Sample Request
POST HTTP/1.1
Host: verifiedpermissions.us-east-1.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: identity
X-Amz-Target: VerifiedPermissions.UpdatePolicyTemplate
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
"description": "My updated template description",
"policyStoreId": "PSEXAMPLEabcdefg111111",
"policyTemplateId": "PTEXAMPLEabcdefg111111",
"statement":"\"ResearchAccess\"\npermit(\n principal in ?principal,\n action == Action::\"view\",\n resource in ?resource\"\n)\nwhen {\n principal has department && principal.department == \"research\"\n};",
}
Sample Response
HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
vary: origin
vary: access-control-request-method
vary: access-control-request-headers
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive
{
"policyStoreId":"PSEXAMPLEabcdefg111111",
"policyTemplateId":"PTEXAMPLEabcdefg111111",
"createdDate":"2023-05-17T18:58:48.795411Z",
"lastUpdatedDate":"2023-05-17T19:18:48.870209Z"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: