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

ListPolicySummaries

Retrieves a paginated list of metadata-only policy summaries within a policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy, but does not include policy definitions, descriptions, or 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-summaries?maxResults=maxResults&nextToken=nextToken&targetResourceScope=targetResourceScope HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of policy summaries to return in a single response.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

A pagination token returned from a previous ListPolicySummaries call. Use this token to retrieve the next page of results when the response is paginated.

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

Pattern: \S*

policyEngineId

The identifier of the policy engine whose policy summaries to retrieve.

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

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

Required: Yes

targetResourceScope

Optional filter to list policy summaries that apply to a specific resource scope or resource type. This helps narrow down results to those relevant for particular AWS resources, agent tools, or operational contexts within the policy engine ecosystem.

Length Constraints: Minimum length of 20. Maximum length of 1011.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "policies": [ 
      { 
         "createdAt": "string",
         "name": "string",
         "policyArn": "string",
         "policyEngineId": "string",
         "policyId": "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.

nextToken

A pagination token that can be used in subsequent ListPolicySummaries calls to retrieve additional results. This token is only present when there are more results available.

Type: String

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

Pattern: \S*

policies

An array of policy summary objects that match the specified criteria. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.

Type: Array of PolicySummary objects

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

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