Amazon Web Services, Inc.

Amazon Simple Storage Service

For information about using the Amazon S3 API—including authentication, signing requests, code examples, and error handling—see the Amazon S3 Developer Guide…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

For information about using the Amazon S3 API—including authentication, signing requests, code examples, and error handling—see the Amazon S3 Developer Guide .

Welcome to the Amazon S3 API Reference . This guide explains the Amazon Simple Storage Service (Amazon S3)
application programming interface (API).
Welcome to the Amazon S3 API Reference . This guide explains the Amazon Simple Storage Service (Amazon S3)
application programming interface (API).
You can use any toolkit that supports HTTP to use the REST API. You can even use a browser
to fetch objects, as long as they are anonymously readable.
The REST API uses the standard HTTP headers and status codes, so that standard browsers and toolkits work as expected. In some areas, we have added functionality to HTTP (for example, we added headers to support access control). In these cases, we have done our best to add the new functionality in a way that matched the style of standard HTTP usage.
The current version of the Amazon S3 API is 2006-03-01 .
Amazon S3 supports the REST API.

Support for SOAP over HTTP is deprecated, but it is still available over HTTPS.
However, new Amazon S3 features will not be supported for SOAP. We recommend that
you use either this REST API or the Amazon Web Services SDKs.

Endpoints 12

  • GETList parts/:Bucket/:Key?x-id=ListParts&max-parts=0&part-number-marker=string&uploadId=stringLists the parts that have been uploaded for a specific multipart upload. To use this operation, you must provide the upload ID in the request. You obtain this…
  • PUTUpload part copy/:Bucket/:Key?x-id=UploadPartCopy&partNumber=0&uploadId=stringUploads a part by copying data from an existing object as data source. To specify the data source, you add the request header x-amz-copy-source in your…
  • POSTSelect object content/:Bucket/:Key?select=&select-type=2This operation is not supported for directory buckets. This action filters the contents of an Amazon S3 object based on a simple structured query language…
  • DELETEDelete object tagging/:Bucket/:Key?tagging=&versionId=stringThis operation is not supported for directory buckets. Removes the entire tag set from the specified object. For more information about managing object tags,…
  • HEADHead object/:Bucket/:Key?response-cache-control=string&response-content-disposition=string&response-content-encoding=string&response-content-language=string&response-content-type=string&response-expires=string&versionId=string&partNumber=0The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's…
  • GETList objects v2/:Bucket?list-type=2&delimiter=string&encoding-type=string&max-keys=0&prefix=string&continuation-token=string&fetch-owner=true&start-after=stringReturns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of…
  • PUTUpdate bucket metadata journal table configuration/:Bucket?metadataJournalTable=Enables or disables journal table record expiration for an S3 Metadata configuration on a general purpose bucket. For more information, see Accelerating data…
  • POSTDelete objects/:Bucket?delete=This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then…
  • DELETEDelete public access block/:Bucket?publicAccessBlock=This operation is not supported for directory buckets. Removes the PublicAccessBlock configuration for an Amazon S3 bucket. This operation removes the…
  • HEADHead bucket/:BucketYou can use this operation to determine if a bucket exists and if you have permission to access it. The action returns a 200 OK HTTP status code if the bucket…
  • GETList directory buckets/?x-id=ListDirectoryBuckets&continuation-token=string&max-directory-buckets=0Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request. For more information about directory buckets, see…
  • POSTWrite get object response/WriteGetObjectResponseThis operation is not supported for directory buckets. Passes transformed objects to a GetObject operation when using Object Lambda access points. For…

API details

Base URL
https://s3.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
12 operations on 4 pathsGET 3POST 3PUT 2HEAD 2DELETE 2
Description format
AWS Smithy model, API version 2006-03-01

How to test the Amazon Simple Storage Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Simple Storage Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List parts” (GET /:Bucket/:Key?x-id=ListParts&max-parts=0&part-number-marker=string&uploadId=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Simple Storage Service?

For information about using the Amazon S3 API—including authentication, signing requests, code examples, and error handling—see the Amazon S3 Developer Guide… It is listed under Developer tools and has 12 endpoints.

Who publishes the Amazon Simple Storage Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Simple Storage Service?

Requests go to https://s3.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Simple Storage Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Simple Storage Service have?

12 operations on 4 paths (3 GET, 3 POST, 2 PUT, 2 HEAD, 2 DELETE).

Is forking the Amazon Simple Storage Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.