`s3.delete`

Delete object from S3 bucket

CLI

Package: @procedures/s3 · README
Path: ["s3","delete"]
CLI: mark s3 delete --bucket <string> --key <string>
As data: {"$proc":["s3","delete"],"input":{}}

Use it

In TypeScript

import { Client, LocalTransport, PROCEDURE_REGISTRY } from "@procedures/client";
import "@procedures/s3"; // registers its procedures

const client = new Client(new LocalTransport({ registry: PROCEDURE_REGISTRY }));
const result = await client.exec(["s3","delete"], { bucket: "<bucket>", key: "<key>" });
console.log(JSON.stringify(result));

From the command line

$ mark s3 delete --bucket <string> --key <string>

As data, in a program

{
  "$proc": ["s3", "delete"],
  "input": { "bucket": "<bucket>", "key": "<key>" }
}

Input

Field	Type	Required	Description
`bucket`	`string`	yes	S3 bucket name
`key`	`string`	yes	Object key (path in bucket)
`versionId`	`string`	no	Specific version to delete

Output

Field	Type	Required	Description
`deleted`	`boolean`	yes	True when the delete succeeded
`deleteMarker`	`boolean`	no	True when versioning made a delete marker
`versionId`	`string`	no	The version id of the delete marker

JSON Schemas

{
  "input": {
    "type": "object",
    "properties": {
      "bucket": {
        "type": "string",
        "description": "S3 bucket name"
      },
      "key": {
        "type": "string",
        "description": "Object key (path in bucket)"
      },
      "versionId": {
        "description": "Specific version to delete",
        "type": "string"
      }
    },
    "required": [
      "bucket",
      "key"
    ]
  },
  "output": {
    "type": "object",
    "properties": {
      "deleted": {
        "type": "boolean",
        "description": "True when the delete succeeded"
      },
      "deleteMarker": {
        "description": "True when versioning made a delete marker",
        "type": "boolean"
      },
      "versionId": {
        "description": "The version id of the delete marker",
        "type": "string"
      }
    },
    "required": [
      "deleted"
    ],
    "additionalProperties": {}
  }
}