DeletionQueueApi.md 3.6 KB
DeletionQueueApi
All URIs are relative to https://your-apigw-id.execute-api.region.amazonaws.com/Prod
| Method | HTTP request | Description |
|---|---|---|
| AddItemToDeletionQueue | PATCH /v1/queue | Adds an item to the deletion queue (Deprecated: use PATCH /v1/queue/matches) |
| AddItemsToDeletionQueue | PATCH /v1/queue/matches | Adds one or more items to the deletion queue |
| DeleteMatches | DELETE /v1/queue/matches | Removes one or more items from the deletion queue |
| ListDeletionQueueMatches | GET /v1/queue | Lists deletion queue items |
| StartDeletionJob | DELETE /v1/queue | Starts a job for the items in the deletion queue |
AddItemToDeletionQueue
Adds an item to the deletion queue (Deprecated: use PATCH /v1/queue/matches)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateDeletionQueueItem | CreateDeletionQueueItem | Request body containing details of the Match to add to the Deletion Queue |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
AddItemsToDeletionQueue
Adds one or more items to the deletion queue
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ListOfCreateDeletionQueueItems | ListOfCreateDeletionQueueItems |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
DeleteMatches
Removes one or more items from the deletion queue
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ListOfMatchDeletions | ListOfMatchDeletions |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
ListDeletionQueueMatches
Lists deletion queue items
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| StartAt | String | Start at watermark query string parameter | [optional] [default to 0] |
| PageSize | Integer | Page size query string parameter. Min: 1. Max: 1000 | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
StartDeletionJob
Starts a job for the items in the deletion queue
Parameters
This endpoint does not need any parameters.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json