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

GetAutomatedReasoningPolicyBuildWorkflow

Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.

Request Syntax


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

URI Request Parameters

The request uses the following URI parameters.

buildWorkflowId

The unique identifier of the build workflow 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 build workflow 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

{
   "buildWorkflowId": "string",
   "buildWorkflowType": "string",
   "createdAt": "string",
   "documentContentType": "string",
   "documentDescription": "string",
   "documentName": "string",
   "policyArn": "string",
   "status": "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.

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}

buildWorkflowType

The type of build workflow being executed (e.g., DOCUMENT_INGESTION, POLICY_REPAIR).

Type: String

Valid Values: INGEST_CONTENT | REFINE_POLICY | IMPORT_POLICY

createdAt

The timestamp when the build workflow was created.

Type: Timestamp

documentContentType

The content type of the source document (e.g., text/plain, application/pdf).

Type: String

Valid Values: pdf | txt

documentDescription

A detailed description of the document's content and how it should be used in the policy generation process.

Type: String

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

documentName

The name of the source document used in the build workflow.

Type: String

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

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

status

The current status of the build workflow (e.g., RUNNING, COMPLETED, FAILED, CANCELLED).

Type: String

updatedAt

The timestamp when the build workflow was 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