.. AUTO-GENERATED FILE. DO NOT EDIT.

hardware-customers-delete-one
=============================

Source
------

- Repository: ``jef-systems/jef-hardware-backend``
- Source Run ID: ``25090787814``
- Source SHA: ``444376867c764658b4ed0286bc44ff0ac8c80995``
- Module: ``hardware``
- Documentation Scope: ``async``
- Lambda: ``jef-hardware-delete-2``

Endpoint
--------

- API Name: ``jef-hardware``
- Action Name: ``delete``
- Method: ``DELETE``
- Scope Label: ``Async``
- Resource Path: ``/hardware-customers-delete-one``
- Complete Endpoint: ``https://24jo9zrosl.execute-api.ap-southeast-1.amazonaws.com/prod/hardware-customers-delete-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-hardware-delete-2``
- curl payload mode: ``json_body``

API Gateway Description
-----------------------

.. code-block:: text

   Function: jef-hardware-delete-2
   Module: jef-hardware
   Action: delete
   Method: DELETE
   Invocation Mode: ASYNC
   Resource Path: /hardware-customers-delete-one
   
   API Gateway Response:
   - status_code: 202
   - message: Request accepted for asynchronous processing.
   
   Table:
   - table: jef-hardware-customers
   
   Payload Example:
   - pk: 8f4dbfea-7d7d-4d90-ae89-58f4e8f1a001
   
   Payload Schema:
   - pk: customer_id
   
   Response Schema:
   - is_accepted: boolean
   - message: string

Request Payload
---------------

.. code-block:: json

   {
     "pk": "8f4dbfea-7d7d-4d90-ae89-58f4e8f1a001"
   }

Response
--------

.. code-block:: json

   {
     "is_accepted": "boolean",
     "message": "string"
   }

CMD curl
--------

.. code-block:: text

   curl -X DELETE "https://24jo9zrosl.execute-api.ap-southeast-1.amazonaws.com/prod/hardware-customers-delete-one" -H "Content-Type: application/json" --data-raw "{\"pk\": \"8f4dbfea-7d7d-4d90-ae89-58f4e8f1a001\"}"

PowerShell curl
---------------

.. code-block:: text

   curl.exe -X DELETE "https://24jo9zrosl.execute-api.ap-southeast-1.amazonaws.com/prod/hardware-customers-delete-one" -H "Content-Type: application/json" --data-raw '{"pk": "8f4dbfea-7d7d-4d90-ae89-58f4e8f1a001"}'