0.6.5 • Published yesterday

@apicity/s3

Licence

MIT

Version

0.6.5

Deps

Size

493 kB

Vulns

Weekly

1.5K

Summary Dependency Versions

@apicity/s3

S3-compatible object storage provider.

Runtime dependencies:

zod@^4.4.3 — request schemas attached to every POST endpoint as .schema

Installation

npm install @apicity/s3
# or
pnpm add @apicity/s3

Quick Start

import { createS3 } from "@apicity/s3";

const s3 = createS3({
  accessKeyId: process.env.S3_ACCESS_KEY_ID!,
  secretAccessKey: process.env.S3_SECRET_ACCESS_KEY!,
  region: process.env.S3_REGION ?? "us-east-1",
  endpoint: process.env.S3_ENDPOINT,
});

API Reference

112 endpoints across 3 groups. Each method mirrors an upstream URL path.

buckets

PUT s3.buckets.create

PUT https://s3.us-east-1.amazonaws.com/{bucket}

Upstream docs

const res = await s3.buckets.create({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

POST s3.buckets.createMetadataConfiguration

POST https://s3.us-east-1.amazonaws.com/{bucket}?metadataConfiguration

Upstream docs

const res = await s3.buckets.createMetadataConfiguration({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

POST s3.buckets.createMetadataTableConfiguration

POST https://s3.us-east-1.amazonaws.com/{bucket}?metadataTable

Upstream docs

const res = await s3.buckets.createMetadataTableConfiguration({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.createSession

GET https://s3express-{param}.{param}.amazonaws.com/{bucket}?session

Upstream docs

const res = await s3.buckets.createSession({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.del

DELETE https://s3.us-east-1.amazonaws.com/{bucket}

Upstream docs

const res = await s3.buckets.del({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delAnalytics

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?analytics{query}

Upstream docs

const res = await s3.buckets.delAnalytics({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delCors

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?cors

Upstream docs

const res = await s3.buckets.delCors({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delEncryption

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?encryption

Upstream docs

const res = await s3.buckets.delEncryption({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delIntelligentTiering

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?intelligent-tiering{query}

Upstream docs

const res = await s3.buckets.delIntelligentTiering({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delInventory

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?inventory{query}

Upstream docs

const res = await s3.buckets.delInventory({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delLifecycle

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?lifecycle

Upstream docs

const res = await s3.buckets.delLifecycle({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delMetadataConfiguration

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?metadataConfiguration

Upstream docs

const res = await s3.buckets.delMetadataConfiguration({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delMetadataTableConfiguration

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?metadataTable

Upstream docs

const res = await s3.buckets.delMetadataTableConfiguration({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delMetrics

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?metrics{query}

Upstream docs

const res = await s3.buckets.delMetrics({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delOwnershipControls

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?ownershipControls

Upstream docs

const res = await s3.buckets.delOwnershipControls({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delPolicy

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?policy

Upstream docs

const res = await s3.buckets.delPolicy({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delPublicAccessBlock

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?publicAccessBlock

Upstream docs

const res = await s3.buckets.delPublicAccessBlock({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delReplication

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?replication

Upstream docs

const res = await s3.buckets.delReplication({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delTagging

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?tagging

Upstream docs

const res = await s3.buckets.delTagging({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.buckets.delWebsite

DELETE https://s3.us-east-1.amazonaws.com/{bucket}?website

Upstream docs

const res = await s3.buckets.delWebsite({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getAbac

GET https://s3.us-east-1.amazonaws.com/{bucket}?abac

Upstream docs

const res = await s3.buckets.getAbac({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getAccelerateConfiguration

GET https://s3.us-east-1.amazonaws.com/{bucket}?accelerate

Upstream docs

const res = await s3.buckets.getAccelerateConfiguration({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getAcl

GET https://s3.us-east-1.amazonaws.com/{bucket}?acl

Upstream docs

const res = await s3.buckets.getAcl({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getAnalytics

GET https://s3.us-east-1.amazonaws.com/{bucket}?analytics{query}

Upstream docs

const res = await s3.buckets.getAnalytics({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getCors

GET https://s3.us-east-1.amazonaws.com/{bucket}?cors

Upstream docs

const res = await s3.buckets.getCors({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getEncryption

GET https://s3.us-east-1.amazonaws.com/{bucket}?encryption

Upstream docs

const res = await s3.buckets.getEncryption({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getIntelligentTiering

GET https://s3.us-east-1.amazonaws.com/{bucket}?intelligent-tiering{query}

Upstream docs

const res = await s3.buckets.getIntelligentTiering({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getInventory

GET https://s3.us-east-1.amazonaws.com/{bucket}?inventory{query}

Upstream docs

const res = await s3.buckets.getInventory({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getLifecycle

GET https://s3.us-east-1.amazonaws.com/{bucket}?lifecycle

Upstream docs

const res = await s3.buckets.getLifecycle({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getLifecycleLegacy

GET https://s3.us-east-1.amazonaws.com/{bucket}?lifecycle

Upstream docs

const res = await s3.buckets.getLifecycleLegacy({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getLogging

GET https://s3.us-east-1.amazonaws.com/{bucket}?logging

Upstream docs

const res = await s3.buckets.getLogging({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getMetadataConfiguration

GET https://s3.us-east-1.amazonaws.com/{bucket}?metadataConfiguration

Upstream docs

const res = await s3.buckets.getMetadataConfiguration({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getMetadataTableConfiguration

GET https://s3.us-east-1.amazonaws.com/{bucket}?metadataTable

Upstream docs

const res = await s3.buckets.getMetadataTableConfiguration({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getMetrics

GET https://s3.us-east-1.amazonaws.com/{bucket}?metrics{query}

Upstream docs

const res = await s3.buckets.getMetrics({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getNotification

GET https://s3.us-east-1.amazonaws.com/{bucket}?notification

Upstream docs

const res = await s3.buckets.getNotification({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getNotificationLegacy

GET https://s3.us-east-1.amazonaws.com/{bucket}?notification

Upstream docs

const res = await s3.buckets.getNotificationLegacy({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getObjectLockConfiguration

GET https://s3.us-east-1.amazonaws.com/{bucket}?object-lock

Upstream docs

const res = await s3.buckets.getObjectLockConfiguration({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getOwnershipControls

GET https://s3.us-east-1.amazonaws.com/{bucket}?ownershipControls

Upstream docs

const res = await s3.buckets.getOwnershipControls({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getPolicy

GET https://s3.us-east-1.amazonaws.com/{bucket}?policy

Upstream docs

const res = await s3.buckets.getPolicy({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getPolicyStatus

GET https://s3.us-east-1.amazonaws.com/{bucket}?policyStatus

Upstream docs

const res = await s3.buckets.getPolicyStatus({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getPublicAccessBlock

GET https://s3.us-east-1.amazonaws.com/{bucket}?publicAccessBlock

Upstream docs

const res = await s3.buckets.getPublicAccessBlock({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getReplication

GET https://s3.us-east-1.amazonaws.com/{bucket}?replication

Upstream docs

const res = await s3.buckets.getReplication({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getRequestPayment

GET https://s3.us-east-1.amazonaws.com/{bucket}?requestPayment

Upstream docs

const res = await s3.buckets.getRequestPayment({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getTagging

GET https://s3.us-east-1.amazonaws.com/{bucket}?tagging

Upstream docs

const res = await s3.buckets.getTagging({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getVersioning

GET https://s3.us-east-1.amazonaws.com/{bucket}?versioning

Upstream docs

const res = await s3.buckets.getVersioning({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.getWebsite

GET https://s3.us-east-1.amazonaws.com/{bucket}?website

Upstream docs

const res = await s3.buckets.getWebsite({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

HEAD s3.buckets.head

HEAD https://s3.us-east-1.amazonaws.com/{bucket}

Upstream docs

const res = await s3.buckets.head({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.list

GET https://s3.us-east-1.amazonaws.com/

Upstream docs

const res = await s3.buckets.list({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.listAnalytics

GET https://s3.us-east-1.amazonaws.com/{bucket}?analytics{query}

Upstream docs

const res = await s3.buckets.listAnalytics({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.listDirectory

GET https://s3express-control.{param}.amazonaws.com/{query}

Upstream docs

const res = await s3.buckets.listDirectory({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.listIntelligentTiering

GET https://s3.us-east-1.amazonaws.com/{bucket}?intelligent-tiering{query}

Upstream docs

const res = await s3.buckets.listIntelligentTiering({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.listInventory

GET https://s3.us-east-1.amazonaws.com/{bucket}?inventory{query}

Upstream docs

const res = await s3.buckets.listInventory({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.listMetrics

GET https://s3.us-east-1.amazonaws.com/{bucket}?metrics{query}

Upstream docs

const res = await s3.buckets.listMetrics({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.buckets.location

GET https://s3.us-east-1.amazonaws.com/{bucket}?location

Upstream docs

const res = await s3.buckets.location({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putAbac

PUT https://s3.us-east-1.amazonaws.com/{bucket}?abac

Upstream docs

const res = await s3.buckets.putAbac({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putAccelerateConfiguration

PUT https://s3.us-east-1.amazonaws.com/{bucket}?accelerate

Upstream docs

const res = await s3.buckets.putAccelerateConfiguration({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putAcl

PUT https://s3.us-east-1.amazonaws.com/{bucket}?acl

Upstream docs

const res = await s3.buckets.putAcl({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putAnalytics

PUT https://s3.us-east-1.amazonaws.com/{bucket}?analytics{query}

Upstream docs

const res = await s3.buckets.putAnalytics({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putCors

PUT https://s3.us-east-1.amazonaws.com/{bucket}?cors

Upstream docs

const res = await s3.buckets.putCors({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putEncryption

PUT https://s3.us-east-1.amazonaws.com/{bucket}?encryption

Upstream docs

const res = await s3.buckets.putEncryption({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putIntelligentTiering

PUT https://s3.us-east-1.amazonaws.com/{bucket}?intelligent-tiering{query}

Upstream docs

const res = await s3.buckets.putIntelligentTiering({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putInventory

PUT https://s3.us-east-1.amazonaws.com/{bucket}?inventory{query}

Upstream docs

const res = await s3.buckets.putInventory({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putLifecycle

PUT https://s3.us-east-1.amazonaws.com/{bucket}?lifecycle

Upstream docs

const res = await s3.buckets.putLifecycle({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putLifecycleLegacy

PUT https://s3.us-east-1.amazonaws.com/{bucket}?lifecycle

Upstream docs

const res = await s3.buckets.putLifecycleLegacy({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putLogging

PUT https://s3.us-east-1.amazonaws.com/{bucket}?logging

Upstream docs

const res = await s3.buckets.putLogging({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putMetrics

PUT https://s3.us-east-1.amazonaws.com/{bucket}?metrics{query}

Upstream docs

const res = await s3.buckets.putMetrics({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putNotification

PUT https://s3.us-east-1.amazonaws.com/{bucket}?notification

Upstream docs

const res = await s3.buckets.putNotification({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putNotificationLegacy

PUT https://s3.us-east-1.amazonaws.com/{bucket}?notification

Upstream docs

const res = await s3.buckets.putNotificationLegacy({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putObjectLockConfiguration

PUT https://s3.us-east-1.amazonaws.com/{bucket}?object-lock

Upstream docs

const res = await s3.buckets.putObjectLockConfiguration({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putOwnershipControls

PUT https://s3.us-east-1.amazonaws.com/{bucket}?ownershipControls

Upstream docs

const res = await s3.buckets.putOwnershipControls({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putPolicy

PUT https://s3.us-east-1.amazonaws.com/{bucket}?policy

Upstream docs

const res = await s3.buckets.putPolicy({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putPublicAccessBlock

PUT https://s3.us-east-1.amazonaws.com/{bucket}?publicAccessBlock

Upstream docs

const res = await s3.buckets.putPublicAccessBlock({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putReplication

PUT https://s3.us-east-1.amazonaws.com/{bucket}?replication

Upstream docs

const res = await s3.buckets.putReplication({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putRequestPayment

PUT https://s3.us-east-1.amazonaws.com/{bucket}?requestPayment

Upstream docs

const res = await s3.buckets.putRequestPayment({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putTagging

PUT https://s3.us-east-1.amazonaws.com/{bucket}?tagging

Upstream docs

const res = await s3.buckets.putTagging({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putVersioning

PUT https://s3.us-east-1.amazonaws.com/{bucket}?versioning

Upstream docs

const res = await s3.buckets.putVersioning({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.putWebsite

PUT https://s3.us-east-1.amazonaws.com/{bucket}?website

Upstream docs

const res = await s3.buckets.putWebsite({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.updateMetadataInventoryTable

PUT https://s3.us-east-1.amazonaws.com/{bucket}?metadataInventoryTable

Upstream docs

const res = await s3.buckets.updateMetadataInventoryTable({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.buckets.updateMetadataJournalTable

PUT https://s3.us-east-1.amazonaws.com/{bucket}?metadataJournalTable

Upstream docs

const res = await s3.buckets.updateMetadataJournalTable({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

objectLambda

POST s3.objectLambda.writeGetObjectResponse

POST https://{param}.s3-object-lambda.{param}.amazonaws.com/WriteGetObjectResponse

Upstream docs

const res = await s3.objectLambda.writeGetObjectResponse({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

objects

DELETE s3.objects.abortMultipartUpload

DELETE https://s3.us-east-1.amazonaws.com/{bucket}/{key}{query}

Upstream docs

const res = await s3.objects.abortMultipartUpload({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

POST s3.objects.completeMultipartUpload

POST https://s3.us-east-1.amazonaws.com/{bucket}/{key}{query}

Upstream docs

const res = await s3.objects.completeMultipartUpload({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.objects.copy

PUT https://s3.us-east-1.amazonaws.com/{bucket}/{key}

Upstream docs

const res = await s3.objects.copy({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

POST s3.objects.createMultipartUpload

POST https://s3.us-east-1.amazonaws.com/{bucket}/{key}?uploads

Upstream docs

const res = await s3.objects.createMultipartUpload({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.objects.del

DELETE https://s3.us-east-1.amazonaws.com/{bucket}/{key}{query}

Upstream docs

const res = await s3.objects.del({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

POST s3.objects.delMany

POST https://s3.us-east-1.amazonaws.com/{bucket}?delete

Upstream docs

const res = await s3.objects.delMany({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

DELETE s3.objects.delTagging

DELETE https://s3.us-east-1.amazonaws.com/{bucket}/{key}?tagging{query}

Upstream docs

const res = await s3.objects.delTagging({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.get

GET https://s3.us-east-1.amazonaws.com/{bucket}/{key}{query}

Upstream docs

const res = await s3.objects.get({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.getAcl

GET https://s3.us-east-1.amazonaws.com/{bucket}/{key}?acl{query}

Upstream docs

const res = await s3.objects.getAcl({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.getAttributes

GET https://s3.us-east-1.amazonaws.com/{bucket}/{key}?attributes{query}

Upstream docs

const res = await s3.objects.getAttributes({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.getLegalHold

GET https://s3.us-east-1.amazonaws.com/{bucket}/{key}?legal-hold{query}

Upstream docs

const res = await s3.objects.getLegalHold({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.getRetention

GET https://s3.us-east-1.amazonaws.com/{bucket}/{key}?retention{query}

Upstream docs

const res = await s3.objects.getRetention({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.getStream

GET https://s3.us-east-1.amazonaws.com/{bucket}/{key}{query}

Upstream docs

const res = await s3.objects.getStream({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.getTagging

GET https://s3.us-east-1.amazonaws.com/{bucket}/{key}?tagging{query}

Upstream docs

const res = await s3.objects.getTagging({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.getTorrent

GET https://s3.us-east-1.amazonaws.com/{bucket}/{key}?torrent{query}

Upstream docs

const res = await s3.objects.getTorrent({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

HEAD s3.objects.head

HEAD https://s3.us-east-1.amazonaws.com/{bucket}/{key}{query}

Upstream docs

const res = await s3.objects.head({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.list

GET https://s3.us-east-1.amazonaws.com/{bucket}?list-type=2{query}

Upstream docs

const res = await s3.objects.list({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.listLegacy

GET https://s3.us-east-1.amazonaws.com/{bucket}{query}

Upstream docs

const res = await s3.objects.listLegacy({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.listMultipartUploads

GET https://s3.us-east-1.amazonaws.com/{bucket}?uploads{query}

Upstream docs

const res = await s3.objects.listMultipartUploads({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.listParts

GET https://s3.us-east-1.amazonaws.com/{bucket}/{key}{query}

Upstream docs

const res = await s3.objects.listParts({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

GET s3.objects.listVersions

GET https://s3.us-east-1.amazonaws.com/{bucket}?versions{query}

Upstream docs

const res = await s3.objects.listVersions({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.objects.put

PUT https://s3.us-east-1.amazonaws.com/{bucket}/{key}

Upstream docs

const res = await s3.objects.put({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.objects.putAcl

PUT https://s3.us-east-1.amazonaws.com/{bucket}/{key}?acl{query}

Upstream docs

const res = await s3.objects.putAcl({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.objects.putLegalHold

PUT https://s3.us-east-1.amazonaws.com/{bucket}/{key}?legal-hold{query}

Upstream docs

const res = await s3.objects.putLegalHold({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.objects.putRetention

PUT https://s3.us-east-1.amazonaws.com/{bucket}/{key}?retention{query}

Upstream docs

const res = await s3.objects.putRetention({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.objects.putTagging

PUT https://s3.us-east-1.amazonaws.com/{bucket}/{key}?tagging{query}

Upstream docs

const res = await s3.objects.putTagging({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.objects.rename

PUT https://s3express-{param}.{param}.amazonaws.com/{bucket}/{key}?renameObject

Upstream docs

const res = await s3.objects.rename({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

POST s3.objects.restore

POST https://s3.us-east-1.amazonaws.com/{bucket}/{key}?restore{query}

Upstream docs

const res = await s3.objects.restore({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

POST s3.objects.selectContent

POST https://s3.us-east-1.amazonaws.com/{bucket}/{key}?select&select-type=2

Upstream docs

const res = await s3.objects.selectContent({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.objects.updateEncryption

PUT https://s3.us-east-1.amazonaws.com/{bucket}/{key}?encryption{query}

Upstream docs

const res = await s3.objects.updateEncryption({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.objects.uploadPart

PUT https://s3.us-east-1.amazonaws.com/{bucket}/{key}{query}

Upstream docs

const res = await s3.objects.uploadPart({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

PUT s3.objects.uploadPartCopy

PUT https://s3.us-east-1.amazonaws.com/{bucket}/{key}{query}

Upstream docs

const res = await s3.objects.uploadPartCopy({ /* ... */ });

Source: packages/provider/s3/src/s3.ts

Part of the apicity monorepo.

License

MIT — see LICENSE.

Keywords

s3 aws object-storage storage apicity