BedrockAgentCore / Client / delete_payment_instrument

delete_payment_instrument

BedrockAgentCore.Client.delete_payment_instrument(**kwargs)

Deletes a payment instrument. This is a soft delete operation that preserves the record for audit and compliance purposes.

See also: AWS API Documentation

Request Syntax

response = client.delete_payment_instrument(
    userId='string',
    paymentManagerArn='string',
    paymentConnectorId='string',
    paymentInstrumentId='string'
)
Parameters:

  • userId (string) – The user ID making the delete request. Must match the instrument’s userId.

  • paymentManagerArn (string) –

    [REQUIRED]

    The payment manager ARN. Must match the instrument’s paymentManagerArn.

  • paymentConnectorId (string) –

    [REQUIRED]

    The payment connector ID. Must match the instrument’s paymentConnectorId.

  • paymentInstrumentId (string) –

    [REQUIRED]

    The payment instrument ID to delete.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'INITIATED'|'ACTIVE'|'FAILED'|'DELETED'
}

Response Structure

  • (dict) –

    Response structure for deleting a payment instrument.

    • status (string) –

      The status of the instrument after deletion. Always DELETED for successful soft delete.

Exceptions

  • BedrockAgentCore.Client.exceptions.AccessDeniedException

  • BedrockAgentCore.Client.exceptions.ValidationException

  • BedrockAgentCore.Client.exceptions.ResourceNotFoundException

  • BedrockAgentCore.Client.exceptions.ThrottlingException

  • BedrockAgentCore.Client.exceptions.InternalServerException