BedrockAgentCore / Client / delete_payment_session
delete_payment_session¶
- BedrockAgentCore.Client.delete_payment_session(**kwargs)¶
Deletes a payment session. This permanently removes the payment session record.
See also: AWS API Documentation
Request Syntax
response = client.delete_payment_session( userId='string', paymentManagerArn='string', paymentSessionId='string' )
- Parameters:
userId (string) – The user ID making the delete request. Must match the session’s userId.
paymentManagerArn (string) –
[REQUIRED]
The payment manager ARN. Must match the session’s paymentManagerArn.
paymentSessionId (string) –
[REQUIRED]
The payment session ID to delete.
- Return type:
dict
- Returns:
Response Syntax
{ 'status': 'ACTIVE'|'EXPIRED'|'DELETED' }
Response Structure
(dict) –
Response structure for deleting a payment session.
status (string) –
The status of the deletion. Always DELETED for successful hard delete.
Exceptions
BedrockAgentCore.Client.exceptions.AccessDeniedExceptionBedrockAgentCore.Client.exceptions.ValidationExceptionBedrockAgentCore.Client.exceptions.ResourceNotFoundExceptionBedrockAgentCore.Client.exceptions.ThrottlingExceptionBedrockAgentCore.Client.exceptions.InternalServerException