BedrockAgentCoreControl / Client / list_policy_engine_summaries

list_policy_engine_summaries

BedrockAgentCoreControl.Client.list_policy_engine_summaries(**kwargs)

Retrieves a paginated list of metadata-only policy engine summaries without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy engine, but does not include descriptions or status reasons. Because this operation does not require access to the customer’s KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

See also: AWS API Documentation

Request Syntax

response = client.list_policy_engine_summaries(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – A pagination token returned from a previous ListPolicyEngineSummaries call. Use this token to retrieve the next page of results when the response is paginated.

  • maxResults (integer) – The maximum number of policy engine summaries to return in a single response.

Return type:

dict

Returns:

Response Syntax

{
    'policyEngines': [
        {
            'policyEngineId': 'string',
            'name': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'policyEngineArn': 'string',
            'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
            'encryptionKeyArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • policyEngines (list) –

      An array of policy engine summary objects that exist in the account. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.

      • (dict) –

        Represents a metadata-only summary of a policy engine resource. This structure contains resource identifiers, status, and timestamps without customer-encrypted fields such as description or status reasons. Policy engine summaries are returned by operations that do not require access to the customer’s KMS key.

        • policyEngineId (string) –

          The unique identifier for the policy engine.

        • name (string) –

          The customer-assigned name of the policy engine.

        • createdAt (datetime) –

          The timestamp when the policy engine was originally created.

        • updatedAt (datetime) –

          The timestamp when the policy engine was last modified.

        • policyEngineArn (string) –

          The Amazon Resource Name (ARN) of the policy engine.

        • status (string) –

          The current status of the policy engine.

        • encryptionKeyArn (string) –

          The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

    • nextToken (string) –

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

Exceptions