payment_sessions

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

Overview

Name	payment_sessions
Type	Resource
Id	aws.bedrock_agentcore.payment_sessions

Fields

The following fields are returned by SELECT queries:

get_payment_session

Name	Datatype	Description
available_limits	object	The current available spending limits.
created_at	string (date-time)	The timestamp when the session was created.
expiry_time_in_minutes	integer	The session expiry time in minutes.
limits	object	The spending limits configuration for a payment session.
payment_manager_arn	string	The ARN of the payment manager that owns this session. (pattern: <code>arn:(aws|aws-[a-z0-9-]+):bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/[a-z0-9]([a-z0-9-]{0,47}[a-z0-9])?-[a-z0-9]{10}</code>)
payment_session_id	string	The unique identifier of the payment session. (pattern: <code>payment-session-[0-9a-zA-Z-]{15}</code>)
updated_at	string (date-time)	The timestamp when the session was last updated.
user_id	string	The user ID associated with this session.

list_payment_sessions

Name	Datatype	Description
created_at	string (date-time)	The timestamp when the session was created.
expiry_time_in_minutes	integer	The session expiry time in minutes.
payment_manager_arn	string	The ARN of the payment manager that owns this session. (pattern: <code>arn:(aws|aws-[a-z0-9-]+):bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/[a-z0-9]([a-z0-9-]{0,47}[a-z0-9])?-[a-z0-9]{10}</code>)
payment_session_id	string	The unique identifier of the payment session. (pattern: <code>payment-session-[0-9a-zA-Z-]{15}</code>)
updated_at	string (date-time)	The timestamp when the session was last updated.
user_id	string	The user ID associated with this session.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_payment_session	select	region	X-Amzn-Bedrock-AgentCore-Payments-User-Id, X-Amzn-Bedrock-AgentCore-Payments-Agent-Name	Get a payment session.
list_payment_sessions	select	region	X-Amzn-Bedrock-AgentCore-Payments-User-Id, X-Amzn-Bedrock-AgentCore-Payments-Agent-Name	List payment sessions.
create_payment_session	insert	region, paymentManagerArn, expiryTimeInMinutes	X-Amzn-Bedrock-AgentCore-Payments-User-Id, X-Amzn-Bedrock-AgentCore-Payments-Agent-Name	Create a new payment session.
delete_payment_session	delete	region	X-Amzn-Bedrock-AgentCore-Payments-User-Id	Deletes a payment session. This permanently removes the payment session record.

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 making the delete request. Must match the session's userId.

SELECT examples

get_payment_session

Get a payment session.

SELECT
available_limits,
created_at,
expiry_time_in_minutes,
limits,
payment_manager_arn,
payment_session_id,
updated_at,
user_id
FROM aws.bedrock_agentcore.payment_sessions
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 }}'
;

list_payment_sessions

List payment sessions.

SELECT
created_at,
expiry_time_in_minutes,
payment_manager_arn,
payment_session_id,
updated_at,
user_id
FROM aws.bedrock_agentcore.payment_sessions
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 }}'
;

INSERT examples

create_payment_session

Create a new payment session.

INSERT INTO aws.bedrock_agentcore.payment_sessions (
paymentManagerArn,
limits,
expiryTimeInMinutes,
clientToken,
region,
`X-Amzn-Bedrock-AgentCore-Payments-User-Id`,
`X-Amzn-Bedrock-AgentCore-Payments-Agent-Name`
)
SELECT 
'{{ paymentManagerArn }}' /* required */,
'{{ limits }}',
{{ expiryTimeInMinutes }} /* required */,
'{{ clientToken }}',
'{{ region }}',
'{{ X-Amzn-Bedrock-AgentCore-Payments-User-Id }}',
'{{ X-Amzn-Bedrock-AgentCore-Payments-Agent-Name }}'
RETURNING
payment_session
;

Manifest

# Description fields are for documentation purposes
- name: payment_sessions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the payment_sessions resource.
  - name: paymentManagerArn
    value: "{{ paymentManagerArn }}"
  - name: limits
    description: |
      The spending limits configuration for a payment session.
    value:
      maxSpendAmount:
        value: "{{ value }}"
        currency: "{{ currency }}"
  - name: expiryTimeInMinutes
    value: {{ expiryTimeInMinutes }}
  - name: clientToken
    value: "{{ clientToken }}"
  - name: X-Amzn-Bedrock-AgentCore-Payments-User-Id
    value: "{{ X-Amzn-Bedrock-AgentCore-Payments-User-Id }}"
    description: The user ID associated with this payment session.
    description: The user ID associated with this payment session.
  - name: X-Amzn-Bedrock-AgentCore-Payments-Agent-Name
    value: "{{ X-Amzn-Bedrock-AgentCore-Payments-Agent-Name }}"
    description: The agent name associated with this request, used for observability.
    description: The agent name associated with this request, used for observability.

DELETE examples

delete_payment_session

Deletes a payment session. This permanently removes the payment session record.

DELETE FROM aws.bedrock_agentcore.payment_sessions
WHERE region = '{{ region }}' --required
AND `X-Amzn-Bedrock-AgentCore-Payments-User-Id` = '{{ X-Amzn-Bedrock-AgentCore-Payments-User-Id }}'
;