BedrockAgentCoreControl / Client / get_policy_engine

get_policy_engine¶

BedrockAgentCoreControl.Client.get_policy_engine(**kwargs)¶

Retrieves detailed information about a specific policy engine within the AgentCore Policy system. This operation returns the complete policy engine configuration, metadata, and current status, allowing administrators to review and manage policy engine settings.

Request Syntax

response = client.get_policy_engine(
    policyEngineId='string'
)

Parameters:

policyEngineId (string) –

[REQUIRED]

The unique identifier of the policy engine to be retrieved. This must be a valid policy engine ID that exists within the account.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- policyEngineId (string) –
  
  The unique identifier of the retrieved policy engine. This matches the policy engine ID provided in the request and serves as the system identifier.
- name (string) –
  
  The customer-assigned name of the policy engine. This is the human-readable identifier that was specified when the policy engine was created.
- description (string) –
  
  The human-readable description of the policy engine’s purpose and scope. This helps administrators understand the policy engine’s role in governance.
- createdAt (datetime) –
  
  The timestamp when the policy engine was originally created.
- updatedAt (datetime) –
  
  The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration.
- policyEngineArn (string) –
  
  The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.
- status (string) –
  
  The current status of the policy engine.
- statusReasons (list) –
  
  Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine.
  - (string) –

Exceptions

BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException