`s3.multipart.abort`

Abort multipart upload and clean up parts

CLI

Package: @procedures/s3 · README
Path: ["s3","multipart","abort"]
CLI: mark s3 multipart abort --bucket <string> --key <string> --uploadId <string>
As data: {"$proc":["s3","multipart","abort"],"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","multipart","abort"], { bucket: "<bucket>", key: "<key>", uploadId: "<uploadId>" });
console.log(JSON.stringify(result));

From the command line

$ mark s3 multipart abort --bucket <string> --key <string> --uploadId <string>

As data, in a program

{
  "$proc": ["s3", "multipart", "abort"],
  "input": {
    "bucket": "<bucket>",
    "key": "<key>",
    "uploadId": "<uploadId>"
  }
}

Input

Field	Type	Required	Description
`bucket`	`string`	yes	S3 bucket name
`key`	`string`	yes	Object key
`uploadId`	`string`	yes	Upload ID to abort

Output

Field	Type	Required	Default	Description
`aborted`	`boolean`	yes		True when the upload was aborted

JSON Schemas

{
  "input": {
    "type": "object",
    "properties": {
      "bucket": {
        "type": "string",
        "description": "S3 bucket name"
      },
      "key": {
        "type": "string",
        "description": "Object key"
      },
      "uploadId": {
        "type": "string",
        "description": "Upload ID to abort"
      }
    },
    "required": [
      "bucket",
      "key",
      "uploadId"
    ]
  },
  "output": {
    "type": "object",
    "properties": {
      "aborted": {
        "type": "boolean",
        "description": "True when the upload was aborted"
      }
    },
    "required": [
      "aborted"
    ],
    "additionalProperties": {}
  }
}