HarnessEndpoint
Representation of a harness endpoint. An endpoint is a named, stable reference to a specific version of a harness that callers invoke, allowing the underlying version to be updated without changing how the agent is invoked.
Contents
- arn
-
The ARN of the endpoint.
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}/harness-endpoint/[a-zA-Z][a-zA-Z0-9_]{0,47}Required: Yes
- createdAt
-
The timestamp when the endpoint was created.
Type: Timestamp
Required: Yes
- endpointName
-
The name of the endpoint.
Type: String
Pattern:
[a-zA-Z][a-zA-Z0-9_]{0,47}Required: Yes
- harnessId
-
The ID of the harness that the endpoint belongs to.
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 that the endpoint belongs to.
Type: String
Pattern:
[a-zA-Z][a-zA-Z0-9_]{0,39}Required: Yes
- status
-
The status of the endpoint.
Type: String
Valid Values:
CREATING | CREATE_FAILED | UPDATING | UPDATE_FAILED | READY | DELETING | DELETE_FAILEDRequired: Yes
- updatedAt
-
The timestamp when the endpoint was last updated.
Type: Timestamp
Required: Yes
- description
-
The description of the endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- failureReason
-
The reason the endpoint's last create or update operation failed.
Type: String
Required: No
- liveVersion
-
The harness version that the endpoint is currently serving.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
([1-9][0-9]{0,4})Required: No
- targetVersion
-
The harness version that the endpoint points to. While an update is in progress, this can differ from the live version until the endpoint finishes transitioning.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
([1-9][0-9]{0,4})Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: