Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetAutomatedReasoningPolicyAnnotations

Retrieves the current annotations for an Automated Reasoning policy build workflow. Annotations contain corrections to the rules, variables and types to be applied to the policy.

Request Syntax


GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/annotations HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

buildWorkflowId

The unique identifier of the build workflow whose annotations you want to retrieve.

Length Constraints: Minimum length of 0. Maximum length of 36.

Pattern: [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}

Required: Yes

policyArn

The Amazon Resource Name (ARN) of the Automated Reasoning policy whose annotations you want to retrieve.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "annotations": [ 
      { ... }
   ],
   "annotationSetHash": "string",
   "buildWorkflowId": "string",
   "name": "string",
   "policyArn": "string",
   "updatedAt": "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.

annotations

The current set of annotations containing rules, variables, and types extracted from the source documents. These can be modified before finalizing the policy.

Type: Array of AutomatedReasoningPolicyAnnotation objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

annotationSetHash

A hash value representing the current state of the annotations. This is used for optimistic concurrency control when updating annotations.

Type: String

Length Constraints: Fixed length of 128.

Pattern: [0-9a-z]{128}

buildWorkflowId

The unique identifier of the build workflow.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 36.

Pattern: [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}

name

The name of the Automated Reasoning policy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [0-9a-zA-Z-_ ]+

policyArn

The Amazon Resource Name (ARN) of the Automated Reasoning policy.

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}))?

updatedAt

The timestamp when the annotations were last updated.

Type: Timestamp

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

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

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