UpdateAutomatedReasoningPolicyTestCase
Updates an existing Automated Reasoning policy test. You can modify the content, query, expected result, and confidence threshold.
Request Syntax
PATCH /automated-reasoning-policies/policyArn
/test-cases/testCaseId
HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string
",
"confidenceThreshold": number
,
"expectedAggregatedFindingsResult": "string
",
"guardContent": "string
",
"kmsKeyArn": "string
",
"lastUpdatedAt": "string
",
"queryContent": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- policyArn
-
The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?
Required: Yes
- testCaseId
-
The unique identifier of the test to update.
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern:
[0-9A-Z]{12}
Required: Yes
Request Body
The request accepts the following data in JSON format.
- clientRequestToken
-
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9])*
Required: No
- confidenceThreshold
-
The updated minimum confidence level for logic validation. If null is provided, the threshold will be removed.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
- expectedAggregatedFindingsResult
-
The updated expected result of the Automated Reasoning check.
Type: String
Valid Values:
VALID | INVALID | SATISFIABLE | IMPOSSIBLE | TRANSLATION_AMBIGUOUS | TOO_COMPLEX | NO_TRANSLATION
Required: Yes
- guardContent
-
The updated content to be validated by the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: Yes
- kmsKeyArn
-
The AWS KMS key ARN for encrypting the test at rest. If not provided, the key will not be updated. Use
DISCARD
to remove the key.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}
Required: No
- lastUpdatedAt
-
The timestamp when the test was last updated. This is used as a concurrency token to prevent conflicting modifications.
Type: Timestamp
Required: Yes
- queryContent
-
The updated input query or prompt that generated the content.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"policyArn": "string",
"testCaseId": "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.
- policyArn
-
The Amazon Resource Name (ARN) of the policy that contains the updated test.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?
- testCaseId
-
The unique identifier of the updated test.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern:
[0-9A-Z]{12}
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions.
HTTP Status Code: 403
- ConflictException
-
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceInUseException
-
Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: