View a markdown version of this page

InvokeHarnessStreamOutput - 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).

InvokeHarnessStreamOutput

The streaming events returned by a harness invocation.

Contents

contentBlockDelta

A delta update to the current content block.

Type: HarnessContentBlockDeltaEvent object

Required: No

contentBlockStart

Indicates the start of a new content block.

Type: HarnessContentBlockStartEvent object

Required: No

contentBlockStop

Indicates the end of the current content block.

Type: HarnessContentBlockStopEvent object

Required: No

hookEvent

A lifecycle hook event emitted when a configured hook runs.

Type: HarnessHookEvent object

Required: No

internalServerException

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

Type: Exception

HTTP Status Code: 500

Required: No

messageStart

Indicates the start of a new message from the agent.

Type: HarnessMessageStartEvent object

Required: No

messageStop

Indicates the end of the current message.

Type: HarnessMessageStopEvent object

Required: No

metadata

Token usage and latency metrics for the invocation.

Type: HarnessMetadataEvent object

Required: No

runtimeClientError

An error returned by the runtime container during agent execution.

Type: Exception

HTTP Status Code: 424

Required: No

validationException

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

Type: Exception

HTTP Status Code: 400

Required: No

See Also

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