Skip to content

Bedrock Agentcore  >  Operations  >  get_payment_session

get_payment_session

Operation

get_payment_session async

get_payment_session(input: GetPaymentSessionInput, plugins: list[Plugin] | None = None) -> GetPaymentSessionOutput

Get a payment session.

Parameters:

Name Type Description Default
input GetPaymentSessionInput

An instance of GetPaymentSessionInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GetPaymentSessionOutput

An instance of GetPaymentSessionOutput.

Input

GetPaymentSessionInput dataclass

Request structure for getting a payment session.

Attributes

agent_name class-attribute instance-attribute
agent_name: str | None = None

The agent name associated with this request, used for observability.

payment_manager_arn class-attribute instance-attribute
payment_manager_arn: str | None = None

The ARN of the payment manager that owns this session.

payment_session_id class-attribute instance-attribute
payment_session_id: str | None = None

The ID of the payment session to retrieve.

user_id class-attribute instance-attribute
user_id: str | None = None

The user ID associated with this payment session.

Output

GetPaymentSessionOutput dataclass

Response structure for getting a payment session.

Attributes

payment_session instance-attribute
payment_session: PaymentSession

The payment session details.