View a markdown version of this page

GetPolicyGenerationSummary - Amazon Bedrock AgentCore Control Plane

GetPolicyGenerationSummary

Retrieves a metadata-only summary of a specific policy generation request without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and findings, but does not include status reasons. Because this operation does not require access to the customer's AWS KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

Request Syntax

GET /policy-engines/policyEngineId/policy-generation-summaries/policyGenerationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

policyEngineId

The identifier of the policy engine associated with the policy generation request.

Length Constraints: Minimum length of 12. Maximum length of 59.

Pattern: [A-Za-z][A-Za-z0-9_]*-[a-z0-9_]{10}

Required: Yes

policyGenerationId

The unique identifier of the policy generation request to retrieve the summary for.

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", "findings": "string", "name": "string", "policyEngineId": "string", "policyGenerationArn": "string", "policyGenerationId": "string", "resource": { ... }, "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.

createdAt

The timestamp when the policy generation request was created.

Type: Timestamp

findings

The findings from the policy generation process, if available.

Type: String

name

The customer-assigned name for the policy generation request.

Type: String

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

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

policyEngineId

The identifier of the policy engine associated with this policy generation.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 59.

Pattern: [A-Za-z][A-Za-z0-9_]*-[a-z0-9_]{10}

policyGenerationArn

The Amazon Resource Name (ARN) of the policy generation request.

Type: String

Length Constraints: Minimum length of 103. Maximum length of 210.

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}/policy-generation/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}

policyGenerationId

The unique identifier of the policy generation request.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 59.

Pattern: [A-Za-z][A-Za-z0-9_]*-[a-z0-9_]{10}

resource

The resource information associated with the policy generation.

Type: Resource object

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

status

The current status of the policy generation request.

Type: String

Valid Values: GENERATING | GENERATED | GENERATE_FAILED | DELETE_FAILED

updatedAt

The timestamp when the policy generation was last updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Error Types.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: