View a markdown version of this page

HarnessHookEvent - Amazon Bedrock AgentCore Data Plane
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

HarnessHookEvent

A lifecycle hook event emitted in the invocation stream for visibility into hook decisions.

Contents

hookEventId

The unique identifier for this hook event.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

name

The name of the hook that ran.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

type

The type of lifecycle hook event.

Type: String

Valid Values: before_tool_call | after_tool_call | before_invocation | after_invocation

Required: Yes

decision

The decision applied to the hook event. This field is present only for blocking Lambda targets.

Type: String

Valid Values: allow | deny

Required: No

reason

The optional reason for the applied decision.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: