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

GetPolicyEngine

Retrieves detailed information about a specific policy engine within the AgentCore Policy system. This operation returns the complete policy engine configuration, metadata, and current status, allowing administrators to review and manage policy engine settings.

Request Syntax


GET /policy-engines/policyEngineId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

policyEngineId

The unique identifier of the policy engine to be retrieved. This must be a valid policy engine ID that exists within the account.

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 does not have a request body.

Response Syntax


HTTP/1.1 200
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 200 response.

The following data is returned in JSON format by the service.

createdAt

The timestamp when the policy engine was originally created.

Type: Timestamp

description

The human-readable description of the policy engine's purpose and scope. This helps administrators understand the policy engine's role in governance.

Type: String

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

name

The customer-assigned name of the policy engine. This is the human-readable identifier that was specified when the policy engine was created.

Type: String

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

Pattern: [A-Za-z][A-Za-z0-9_]*

policyEngineArn

The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.

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 retrieved policy engine. This matches the policy engine ID provided in the request and serves as the system identifier.

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 policy engine.

Type: String

statusReasons

Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine.

Type: Array of strings

updatedAt

The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration.

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

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