Bedrock Agentcore  >  Operations  >  delete_payment_session

delete_payment_session

Operation

delete_payment_session async

delete_payment_session(input: DeletePaymentSessionInput, plugins: list[Plugin] | None = None) -> DeletePaymentSessionOutput

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

Parameters:

Name	Type	Description	Default
input	DeletePaymentSessionInput	An instance of DeletePaymentSessionInput.	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
DeletePaymentSessionOutput	An instance of DeletePaymentSessionOutput.

Input

DeletePaymentSessionInput dataclass

Request structure for deleting a payment session.

Attributes

payment_manager_arn class-attribute instance-attribute

payment_manager_arn: str | None = None

The payment manager ARN. Must match the session's paymentManagerArn.

payment_session_id class-attribute instance-attribute

payment_session_id: str | None = None

The payment session ID to delete.

user_id class-attribute instance-attribute

user_id: str | None = None

The user ID making the delete request. Must match the session's userId.

Output

DeletePaymentSessionOutput dataclass

Response structure for deleting a payment session.

Attributes

status instance-attribute

status: PaymentSessionStatus

The status of the deletion. Always DELETED for successful hard delete.