BedrockAgentCoreControl / Client / list_policy_generation_summaries
list_policy_generation_summaries¶
- BedrockAgentCoreControl.Client.list_policy_generation_summaries(**kwargs)¶
Retrieves a paginated list of metadata-only policy generation summaries within a policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and findings for each policy generation, but does not include 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_generation_summaries( nextToken='string', maxResults=123, policyEngineId='string' )
- Parameters:
nextToken (string) – A pagination token returned from a previous ListPolicyGenerationSummaries call. Use this token to retrieve the next page of results when the response is paginated.
maxResults (integer) – The maximum number of policy generation summaries to return in a single response.
policyEngineId (string) –
[REQUIRED]
The identifier of the policy engine whose policy generation summaries to retrieve.
- Return type:
dict
- Returns:
Response Syntax
{ 'policyGenerations': [ { 'policyEngineId': 'string', 'policyGenerationId': 'string', 'name': 'string', 'policyGenerationArn': 'string', 'resource': { 'arn': 'string' }, 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'status': 'GENERATING'|'GENERATED'|'GENERATE_FAILED'|'DELETE_FAILED', 'findings': 'string' }, ], 'nextToken': 'string' }
Response Structure
(dict) –
policyGenerations (list) –
An array of policy generation summary objects that match the specified criteria. Each summary contains resource identifiers, status, timestamps, and findings without customer-encrypted content.
(dict) –
Represents a metadata-only summary of a policy generation resource. This structure contains resource identifiers, status, timestamps, and findings without customer-encrypted fields such as status reasons. Policy generation summaries are returned by operations that do not require access to the customer’s KMS key.
policyEngineId (string) –
The identifier of the policy engine associated with this generation request.
policyGenerationId (string) –
The unique identifier for this policy generation request.
name (string) –
The customer-assigned name for this policy generation request.
policyGenerationArn (string) –
The ARN of this policy generation request.
resource (dict) –
The resource information associated with this policy generation.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
arn. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBERas the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBERis as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
arn (string) –
The Amazon Resource Name (ARN) of the resource. This globally unique identifier specifies the exact resource that policies will be evaluated against for access control decisions.
createdAt (datetime) –
The timestamp when this policy generation request was created.
updatedAt (datetime) –
The timestamp when this policy generation was last updated.
status (string) –
The current status of this policy generation request.
findings (string) –
Findings and insights from this policy generation process.
nextToken (string) –
A pagination token that can be used in subsequent ListPolicyGenerationSummaries calls to retrieve additional results. This token is only present when there are more results available.
Exceptions
BedrockAgentCoreControl.Client.exceptions.AccessDeniedExceptionBedrockAgentCoreControl.Client.exceptions.ValidationExceptionBedrockAgentCoreControl.Client.exceptions.ThrottlingExceptionBedrockAgentCoreControl.Client.exceptions.ResourceNotFoundExceptionBedrockAgentCoreControl.Client.exceptions.InternalServerException