UpdatePolicyEngine
Updates an existing policy engine within the AgentCore Policy system. This operation
allows modification of the policy engine description while maintaining its identity. This is
an asynchronous operation. Use the GetPolicyEngine operation to poll the
status field to track completion.
Request Syntax
PUT /policy-engines/policyEngineId HTTP/1.1
Content-type: application/json
{
"description": "string"
}URI Request Parameters
The request uses the following URI parameters.
- policyEngineId
-
The unique identifier of the policy engine to be updated.
Length Constraints: Minimum length of 12. Maximum length of 59.
Pattern:
[A-Za-z][A-Za-z0-9_]*-[a-z0-9_]{10}Required: Yes
Request Body
The request accepts the following data in JSON format.
- description
-
The new description for the policy engine.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"createdAt": "string",
"description": "string",
"name": "string",
"policyEngineArn": "string",
"policyEngineId": "string",
"status": "string",
"statusReasons": [ "string" ],
"updatedAt": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- createdAt
-
The original creation timestamp of the policy engine.
Type: Timestamp
- description
-
The updated description of the policy engine.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
- name
-
The name of the updated policy engine.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[A-Za-z][A-Za-z0-9_]* - policyEngineArn
-
The ARN of the updated policy engine.
Type: String
Length Constraints: Minimum length of 76. Maximum length of 136.
Pattern:
arn:aws[-a-z]{0,7}:bedrock-agentcore:[a-z0-9-]{9,15}:[0-9]{12}:policy-engine/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10} - policyEngineId
-
The unique identifier of the updated policy engine.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 59.
Pattern:
[A-Za-z][A-Za-z0-9_]*-[a-z0-9_]{10} - status
-
The current status of the updated policy engine.
Type: String
Valid Values:
CREATING | ACTIVE | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED - statusReasons
-
Additional information about the update status.
Type: Array of strings
- updatedAt
-
The timestamp when the policy engine was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
This exception is thrown when a request is denied per access permissions
HTTP Status Code: 403
- ConflictException
-
This exception is thrown when there is a conflict performing an operation
HTTP Status Code: 409
- InternalServerException
-
This exception is thrown if there was an unexpected error during processing of request
HTTP Status Code: 500
- ResourceNotFoundException
-
This exception is thrown when a resource referenced by the operation does not exist
HTTP Status Code: 404
- ThrottlingException
-
This exception is thrown when the number of requests exceeds the limit
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by the service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
