View a markdown version of this page

Harness - Amazon Bedrock AgentCore Control 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).

Harness

Representation of a harness.

Contents

allowedTools

The allowed tools of the harness. All tools are allowed by default.

Type: Array of strings

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

Pattern: (\*|@?[^/]+(/[^/]+)?)

Required: Yes

arn

The ARN of the harness.

Type: String

Pattern: arn:([^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:harness/[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}

Required: Yes

createdAt

The createdAt time of the harness.

Type: Timestamp

Required: Yes

environment

The compute environment on which the Harness runs.

Type: HarnessEnvironmentProvider object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

executionRoleArn

IAM role the harness assumes when running.

Type: String

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

Pattern: arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+

Required: Yes

harnessId

The ID of the harness.

Type: String

Pattern: [a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}

Required: Yes

harnessName

The name of the harness.

Type: String

Pattern: [a-zA-Z][a-zA-Z0-9_]{0,39}

Required: Yes

model

The configuration of the default model used by the Harness.

Type: HarnessModelConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

skills

The skills of the harness.

Type: Array of HarnessSkill objects

Required: Yes

status

The status of the harness.

Type: String

Valid Values: CREATING | CREATE_FAILED | UPDATING | UPDATE_FAILED | READY | DELETING | DELETE_FAILED

Required: Yes

systemPrompt

The system prompt of the harness.

Type: Array of HarnessSystemContentBlock objects

Required: Yes

tools

The tools of the harness.

Type: Array of HarnessTool objects

Required: Yes

truncation

Configuration for truncating model context.

Type: HarnessTruncationConfiguration object

Required: Yes

updatedAt

The updatedAt time of the harness.

Type: Timestamp

Required: Yes

authorizerConfiguration

Represents inbound authorization configuration options used to authenticate incoming requests.

Type: AuthorizerConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

environmentArtifact

The environment artifact (e.g., container) in which the Harness operates.

Type: HarnessEnvironmentArtifact object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

environmentVariables

Environment variables exposed in the environment in which the harness operates.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 100.

Value Length Constraints: Minimum length of 0. Maximum length of 5000.

Required: No

failureReason

Reason why create or update operations fail.

Type: String

Required: No

harnessVersion

The version of the harness. Incremented on every successful UpdateHarness.

Type: String

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

Pattern: ([1-9][0-9]{0,4})

Required: No

hooks

The lifecycle hooks configured for the harness.

Type: Array of HarnessHook objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

maxIterations

The maximum number of iterations in the agent loop allowed before exiting per invocation.

Type: Integer

Required: No

maxTokens

The maximum total number of output tokens the agent can generate across all model calls within a single invocation.

Type: Integer

Required: No

memory

AgentCore Memory instance configuration for short and long term memory.

Type: HarnessMemoryConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

timeoutSeconds

The maximum duration per invocation.

Type: Integer

Required: No

See Also

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