payment_instrument_balances

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

Overview

Name	payment_instrument_balances
Type	Resource
Id	aws.bedrock_agentcore.payment_instrument_balances

Fields

The following fields are returned by SELECT queries:

get_payment_instrument_balance

Name	Datatype	Description
payment_instrument_id	string	The ID of the payment instrument. (pattern: <code>payment-instrument-[0-9a-zA-Z-]{15}</code>)
token_balance	object	The balance of the supported token on the requested chain.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_payment_instrument_balance	select	region	X-Amzn-Bedrock-AgentCore-Payments-User-Id, X-Amzn-Bedrock-AgentCore-Payments-Agent-Name	Get the balance of a payment instrument.

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
region	string	AWS region (default: us-east-1)
X-Amzn-Bedrock-AgentCore-Payments-Agent-Name	string	The agent name associated with this request, used for observability.
X-Amzn-Bedrock-AgentCore-Payments-User-Id	string	The user ID associated with this payment instrument.

SELECT examples

get_payment_instrument_balance

Get the balance of a payment instrument.

SELECT
payment_instrument_id,
token_balance
FROM aws.bedrock_agentcore.payment_instrument_balances
WHERE region = '{{ region }}' -- required
AND `X-Amzn-Bedrock-AgentCore-Payments-User-Id` = '{{ X-Amzn-Bedrock-AgentCore-Payments-User-Id }}'
AND `X-Amzn-Bedrock-AgentCore-Payments-Agent-Name` = '{{ X-Amzn-Bedrock-AgentCore-Payments-Agent-Name }}'
;