harness_endpoints

Creates, updates, deletes, gets or lists a harness_endpoints resource.

Overview

Name	harness_endpoints
Type	Resource
Id	aws.bedrock_agentcore_control.harness_endpoints

Fields

The following fields are returned by SELECT queries:

get_harness_endpoint

Name	Datatype	Description
arn	string	The ARN of the endpoint. (pattern: <code>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}</code>)
created_at	string (date-time)	The timestamp when the endpoint was created.
description	string	The description of the endpoint.
endpoint_name	string	The name of the endpoint. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,47}</code>)
failure_reason	string	The reason the endpoint's last create or update operation failed.
harness_id	string	The ID of the harness that the endpoint belongs to. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}</code>)
harness_name	string	The name of the harness that the endpoint belongs to. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,39}</code>)
live_version	string	The harness version that the endpoint is currently serving. (pattern: <code>([1-9][0-9]{0,4})</code>)
status	string	The status of the endpoint. (CREATING, CREATE_FAILED, UPDATING, UPDATE_FAILED, READY, DELETING, DELETE_FAILED)
target_version	string	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. (pattern: <code>([1-9][0-9]{0,4})</code>)
updated_at	string (date-time)	The timestamp when the endpoint was last updated.

list_harness_endpoints

Name	Datatype	Description
arn	string	The ARN of the endpoint. (pattern: <code>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}</code>)
created_at	string (date-time)	The timestamp when the endpoint was created.
description	string	The description of the endpoint.
endpoint_name	string	The name of the endpoint. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,47}</code>)
failure_reason	string	The reason the endpoint's last create or update operation failed.
harness_id	string	The ID of the harness that the endpoint belongs to. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}</code>)
harness_name	string	The name of the harness that the endpoint belongs to. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,39}</code>)
live_version	string	The harness version that the endpoint is currently serving. (pattern: <code>([1-9][0-9]{0,4})</code>)
status	string	The status of the endpoint. (CREATING, CREATE_FAILED, UPDATING, UPDATE_FAILED, READY, DELETING, DELETE_FAILED)
target_version	string	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. (pattern: <code>([1-9][0-9]{0,4})</code>)
updated_at	string (date-time)	The timestamp when the endpoint was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_harness_endpoint	select	harness_id, endpoint_name, region		Operation to get a single harness endpoint.
list_harness_endpoints	select	harness_id, region	maxResults, nextToken	Operation to list the endpoints of a harness.
create_harness_endpoint	insert	harness_id, region, endpointName		Operation to create a harness endpoint.
update_harness_endpoint	update	harness_id, endpoint_name, region		Operation to update a harness endpoint.
delete_harness_endpoint	delete	harness_id, endpoint_name, region	clientToken	Operation to delete a harness endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint_name	string	The name of the endpoint to delete.
harness_id	string	The ID of the harness that the endpoint belongs to.
region	string	AWS region (default: us-east-1)
clientToken	string	A unique, case-sensitive identifier to ensure idempotency of the request.
maxResults	integer	The maximum number of results to return in a single call.
nextToken	string	The token for the next set of results.

SELECT examples

get_harness_endpoint

Operation to get a single harness endpoint.

SELECT
arn,
created_at,
description,
endpoint_name,
failure_reason,
harness_id,
harness_name,
live_version,
status,
target_version,
updated_at
FROM aws.bedrock_agentcore_control.harness_endpoints
WHERE harness_id = '{{ harness_id }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
AND region = '{{ region }}' -- required
;

list_harness_endpoints

Operation to list the endpoints of a harness.

SELECT
arn,
created_at,
description,
endpoint_name,
failure_reason,
harness_id,
harness_name,
live_version,
status,
target_version,
updated_at
FROM aws.bedrock_agentcore_control.harness_endpoints
WHERE harness_id = '{{ harness_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_harness_endpoint

Operation to create a harness endpoint.

INSERT INTO aws.bedrock_agentcore_control.harness_endpoints (
endpointName,
targetVersion,
description,
clientToken,
tags,
harness_id,
region
)
SELECT 
'{{ endpointName }}' /* required */,
'{{ targetVersion }}',
'{{ description }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ harness_id }}',
'{{ region }}'
RETURNING
endpoint
;

Manifest

# Description fields are for documentation purposes
- name: harness_endpoints
props:
  - name: harness_id
    value: "{{ harness_id }}"
    description: Required parameter for the harness_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the harness_endpoints resource.
  - name: endpointName
    value: "{{ endpointName }}"
  - name: targetVersion
    value: "{{ targetVersion }}"
  - name: description
    value: "{{ description }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_harness_endpoint

Operation to update a harness endpoint.

UPDATE aws.bedrock_agentcore_control.harness_endpoints
SET 
targetVersion = '{{ targetVersion }}',
description = '{{ description }}',
clientToken = '{{ clientToken }}'
WHERE 
harness_id = '{{ harness_id }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND region = '{{ region }}' --required
RETURNING
endpoint;

DELETE examples

delete_harness_endpoint

Operation to delete a harness endpoint.

DELETE FROM aws.bedrock_agentcore_control.harness_endpoints
WHERE harness_id = '{{ harness_id }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;