BedrockAgentCoreControl / Paginator / ListPolicySummaries

ListPolicySummaries

class BedrockAgentCoreControl.Paginator.ListPolicySummaries

paginator = client.get_paginator('list_policy_summaries')

paginate(**kwargs)

Creates an iterator that will paginate through responses from BedrockAgentCoreControl.Client.list_policy_summaries().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    policyEngineId='string',
    targetResourceScope='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• policyEngineId (string) –

  [REQUIRED]

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

• targetResourceScope (string) – 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 Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'policies': [
        {
            'policyId': 'string',
            'name': 'string',
            'policyEngineId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'policyArn': 'string',
            'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • policies (list) –

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

    • (dict) –

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

      • policyId (string) –

        The unique identifier for the policy.

      • name (string) –

        The customer-assigned name of the policy.

      • policyEngineId (string) –

        The identifier of the policy engine that manages this policy.

      • createdAt (datetime) –

        The timestamp when the policy was originally created.

      • updatedAt (datetime) –

        The timestamp when the policy was last modified.

      • policyArn (string) –

        The Amazon Resource Name (ARN) of the policy.

      • status (string) –

        The current status of the policy.

  • NextToken (string) –

    A token to resume pagination.