BedrockAgentCoreControl / Client / update_policy_engine

update_policy_engine

BedrockAgentCoreControl.Client.update_policy_engine(**kwargs)

Updates an existing policy engine within the AgentCore Policy system. This operation allows modification of the policy engine description while maintaining its identity. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

See also: AWS API Documentation

Request Syntax

response = client.update_policy_engine(
    policyEngineId='string',
    description={
        'optionalValue': 'string'
    }
)
Parameters:

  • policyEngineId (string) –

    [REQUIRED]

    The unique identifier of the policy engine to be updated.

  • description (dict) –

    The new description for the policy engine.

    • optionalValue (string) –

      Represents an optional value that is used to update the human-readable description of the resource. If set to null, it will clear the current description of the resource.

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',
    ],
    'encryptionKeyArn': 'string'
}

Response Structure

  • (dict) –

    • policyEngineId (string) –

      The unique identifier of the updated policy engine.

    • name (string) –

      The name of the updated policy engine.

    • description (string) –

      The updated description of the policy engine.

    • createdAt (datetime) –

      The original creation timestamp of the policy engine.

    • updatedAt (datetime) –

      The timestamp when the policy engine was last updated.

    • policyEngineArn (string) –

      The ARN of the updated policy engine.

    • status (string) –

      The current status of the updated policy engine.

    • statusReasons (list) –

      Additional information about the update status.

      • (string) –

    • encryptionKeyArn (string) –

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

Exceptions