BedrockAgentCoreControl / Client / delete_payment_manager

delete_payment_manager¶

BedrockAgentCoreControl.Client.delete_payment_manager(**kwargs)¶

Deletes a payment manager. All payment connectors associated with the payment manager must be deleted before the payment manager can be deleted. This operation initiates the deletion process asynchronously.

Request Syntax

response = client.delete_payment_manager(
    paymentManagerId='string',
    clientToken='string'
)

Parameters:

paymentManagerId (string) –
[REQUIRED]

The unique identifier of the payment manager to delete.
clientToken (string) –
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
    'paymentManagerId': 'string'
}

Response Structure

(dict) –
- status (string) –
  
  The current status of the payment manager, set to DELETING when deletion is initiated. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
- paymentManagerId (string) –
  
  The unique identifier of the deleted payment manager.

Exceptions

BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ConflictException
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException