agent_runtime_endpoints

Creates, updates, deletes, gets or lists an agent_runtime_endpoints resource.

Overview

Name	agent_runtime_endpoints
Type	Resource
Id	aws.bedrock_agentcore_control.agent_runtime_endpoints

Fields

The following fields are returned by SELECT queries:

get_agent_runtime_endpoint

Name	Datatype	Description
id	string	The unique identifier of the AgentCore Runtime endpoint. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}</code>)
name	string	The name of the AgentCore Runtime endpoint. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,47}</code>)
agent_runtime_arn	string	The Amazon Resource Name (ARN) of the AgentCore Runtime. (pattern: <code>arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}</code>)
agent_runtime_endpoint_arn	string	The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint. (pattern: <code>arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}/runtime-endpoint/[a-zA-Z][a-zA-Z0-9_]{0,47}</code>)
created_at	string (date-time)	The timestamp when the AgentCore Runtime endpoint was created.
description	string	The description of the AgentCore Runtime endpoint.
failure_reason	string	The reason for failure if the AgentCore Runtime endpoint is in a failed state.
last_updated_at	string (date-time)	The timestamp when the AgentCore Runtime endpoint was last updated.
live_version	string	The currently deployed version of the AgentCore Runtime on the endpoint. (pattern: <code>([1-9][0-9]{0,4})</code>)
status	string	The current status of the AgentCore Runtime endpoint. (CREATING, CREATE_FAILED, UPDATING, UPDATE_FAILED, READY, DELETING)
target_version	string	The target version of the AgentCore Runtime for the endpoint. (pattern: <code>([1-9][0-9]{0,4})</code>)

list_agent_runtime_endpoints

Name	Datatype	Description
id	string	The unique identifier of the agent runtime endpoint. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}</code>)
name	string	The name of the agent runtime endpoint. (pattern: <code>[a-zA-Z][a-zA-Z0-9_]{0,47}</code>)
agent_runtime_arn	string	The Amazon Resource Name (ARN) of the agent runtime associated with the endpoint. (pattern: <code>arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}</code>)
agent_runtime_endpoint_arn	string	The Amazon Resource Name (ARN) of the agent runtime endpoint. (pattern: <code>arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}/runtime-endpoint/[a-zA-Z][a-zA-Z0-9_]{0,47}</code>)
created_at	string (date-time)	The timestamp when the agent runtime endpoint was created.
description	string	The description of the agent runtime endpoint.
last_updated_at	string (date-time)	The timestamp when the agent runtime endpoint was last updated.
live_version	string	The live version of the agent runtime endpoint. This is the version that is currently serving requests. (pattern: <code>([1-9][0-9]{0,4})</code>)
status	string	The current status of the agent runtime endpoint. (CREATING, CREATE_FAILED, UPDATING, UPDATE_FAILED, READY, DELETING)
target_version	string	The target version of the agent runtime endpoint. This is the version that the endpoint is being updated to. (pattern: <code>([1-9][0-9]{0,4})</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_agent_runtime_endpoint	select	agent_runtime_id, endpoint_name, region		Gets information about an Amazon Secure AgentEndpoint.
list_agent_runtime_endpoints	select	agent_runtime_id, region	maxResults, nextToken	Lists all endpoints for a specific Amazon Secure Agent.
create_agent_runtime_endpoint	insert	agent_runtime_id, region, name		Creates an AgentCore Runtime endpoint.
update_agent_runtime_endpoint	update	agent_runtime_id, endpoint_name, region		Updates an existing Amazon Bedrock AgentCore Runtime endpoint.
delete_agent_runtime_endpoint	delete	agent_runtime_id, endpoint_name, region	clientToken	Deletes an AgentCore Runtime 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
agent_runtime_id	string	The unique identifier of the AgentCore Runtime associated with the endpoint.
endpoint_name	string	The name of the AgentCore Runtime endpoint to delete.
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 the response.
nextToken	string	A token to retrieve the next page of results.

SELECT examples

get_agent_runtime_endpoint

Gets information about an Amazon Secure AgentEndpoint.

SELECT
id,
name,
agent_runtime_arn,
agent_runtime_endpoint_arn,
created_at,
description,
failure_reason,
last_updated_at,
live_version,
status,
target_version
FROM aws.bedrock_agentcore_control.agent_runtime_endpoints
WHERE agent_runtime_id = '{{ agent_runtime_id }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
AND region = '{{ region }}' -- required
;

list_agent_runtime_endpoints

Lists all endpoints for a specific Amazon Secure Agent.

SELECT
id,
name,
agent_runtime_arn,
agent_runtime_endpoint_arn,
created_at,
description,
last_updated_at,
live_version,
status,
target_version
FROM aws.bedrock_agentcore_control.agent_runtime_endpoints
WHERE agent_runtime_id = '{{ agent_runtime_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_agent_runtime_endpoint

Creates an AgentCore Runtime endpoint.

INSERT INTO aws.bedrock_agentcore_control.agent_runtime_endpoints (
name,
agentRuntimeVersion,
description,
clientToken,
tags,
agent_runtime_id,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ agentRuntimeVersion }}',
'{{ description }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ agent_runtime_id }}',
'{{ region }}'
RETURNING
agent_runtime_arn,
agent_runtime_endpoint_arn,
agent_runtime_id,
created_at,
endpoint_name,
status,
target_version
;

Manifest

# Description fields are for documentation purposes
- name: agent_runtime_endpoints
props:
  - name: agent_runtime_id
    value: "{{ agent_runtime_id }}"
    description: Required parameter for the agent_runtime_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the agent_runtime_endpoints resource.
  - name: name
    value: "{{ name }}"
  - name: agentRuntimeVersion
    value: "{{ agentRuntimeVersion }}"
  - name: description
    value: "{{ description }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_agent_runtime_endpoint

Updates an existing Amazon Bedrock AgentCore Runtime endpoint.

UPDATE aws.bedrock_agentcore_control.agent_runtime_endpoints
SET 
agentRuntimeVersion = '{{ agentRuntimeVersion }}',
description = '{{ description }}',
clientToken = '{{ clientToken }}'
WHERE 
agent_runtime_id = '{{ agent_runtime_id }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND region = '{{ region }}' --required
RETURNING
agent_runtime_arn,
agent_runtime_endpoint_arn,
created_at,
last_updated_at,
live_version,
status,
target_version;

DELETE examples

delete_agent_runtime_endpoint

Deletes an AgentCore Runtime endpoint.

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