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

StartAutomatedReasoningPolicyBuildWorkflow

Starts a new build workflow for an Automated Reasoning policy. This initiates the process of analyzing source documents and generating policy rules, variables, and types.

Request Syntax


POST /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowType/start HTTP/1.1
x-amz-client-token: clientRequestToken
Content-type: application/json

{
   "policyDefinition": { 
      "rules": [ 
         { 
            "alternateExpression": "string",
            "expression": "string",
            "id": "string"
         }
      ],
      "types": [ 
         { 
            "description": "string",
            "name": "string",
            "values": [ 
               { 
                  "description": "string",
                  "value": "string"
               }
            ]
         }
      ],
      "variables": [ 
         { 
            "description": "string",
            "name": "string",
            "type": "string"
         }
      ],
      "version": "string"
   },
   "workflowContent": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

buildWorkflowType

The type of build workflow to start (e.g., DOCUMENT_INGESTION for processing new documents, POLICY_REPAIR for fixing existing policies).

Valid Values: INGEST_CONTENT | REFINE_POLICY | IMPORT_POLICY

Required: Yes

clientRequestToken

A unique, case-sensitive identifier to ensure that the operation completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.

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

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9])*

policyArn

The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to start the build workflow.

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 accepts the following data in JSON format.

policyDefinition

An existing policy definition that serves as the starting point for the build workflow, typically used in policy repair or update scenarios.

Type: AutomatedReasoningPolicyDefinition object

Required: No

workflowContent

The actual content to be processed in the build workflow, such as documents to analyze or repair instructions to apply.

Type: AutomatedReasoningPolicyWorkflowTypeContent object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "buildWorkflowId": "string",
   "policyArn": "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.

buildWorkflowId

The unique identifier of the newly started build workflow. Use this ID to track the workflow's progress and retrieve its results.

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}

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

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

ServiceQuotaExceededException

The number of requests exceeds the service quota. Resubmit your request later.

HTTP Status Code: 400

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