RapidAPI logo

Sign Up

Log In

AmazonS3

FREE
By dimas
Updated 3 months ago
Storage
0.9/10
Popularity Score
319ms
Latency
100%
Success Rate

AmazonS3 API Documentation

Store and retrieve data at any time from the web.

View API Details
POSTaddObject
POSTcheckBucket
POSTcopyObject
POSTcreateBucket
POSTdeleteBucket
POSTdeleteBucketCORS
POSTdeleteBucketLifecycle
POSTdeleteBucketPolicy
POSTdeleteBucketReplication
POSTdeleteBucketTagging
POSTdeleteBucketWebsite
POSTdeleteObjects
POSTdeleteSingleObject
POSTgetBucketACL
POSTgetBucketAccelerate
POSTgetBucketCORS
POSTgetBucketLifecycle
POSTgetBucketLocation
POSTgetBucketLogging
POSTgetBucketNotification
POSTgetBucketObjectVersions
POSTgetBucketPolicy
POSTgetBucketReplication
POSTgetBucketRequestPayment
POSTgetBucketTagging
POSTgetBucketVersioning
POSTgetBucketWebsite
POSTgetBuckets
POSTgetMultipartUploads
POSTgetObjectACL
POSTgetObjectMetadata
POSTgetObjectTorrent
POSTgetParts
POSTgetSingleBucket
POSTgetSingleObject
POSTputBucketACL
POSTputBucketAccelerateConfiguration
POSTputBucketCORS
POSTputBucketLifecycleConfiguration
POSTputBucketLogging
POSTputBucketPolicy
POSTputBucketRequestPayment
POSTputBucketTagging
POSTputBucketVersioning
POSTputBucketWebsite
POSTrestoreArchivedObject
POSTaddObject

This endpoint allows to add an object to a bucket.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
objectNameSTRING
REQUIREDThe name of the object to be retrieved.
regionSTRING
REQUIREDRegion.
apiKeyCREDENTIALS
REQUIREDAPI key obtained from Amazon.
apiSecretCREDENTIALS
REQUIREDAPI secret obtained from Amazon.
objectBodyFILE
REQUIREDFile to be uploaded to the bucket.
bucketNameSTRING
REQUIREDThe name of bucket.
Optional Parameters
grantReadACPSTRING
OPTIONALAllows grantee to read the object ACL. You specify each grantee as a type=value pair, where the type can be one of the following: emailAddress – if value specified is the email address of an AWS account; id – if value specified is the canonical user ID of an AWS account; uri – if granting permission to a predefined group. Example: emailAddress="[email protected]", emailAddress="[email protected]"
metadataJSON
OPTIONALArray of strings. A map of metadata to store with the object in S3. Example: ['', ...]
aclSTRING
OPTIONALThe canned ACL to apply to the object. Default: private. Valid Values: private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | bucket-owner-full-control
contentLanguageSTRING
OPTIONALThe language the content is in.
websiteRedirectLocationSTRING
OPTIONALIf the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL.
contentDispositionSTRING
OPTIONALSpecifies presentational information for the object. For more information, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.
SSEKMSKeyIdSTRING
OPTIONALIf the x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
SSECustomerKeySTRING
OPTIONALSpecifies the customer-provided base64-encoded encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
grantFullControlSTRING
OPTIONALAllows grantee the READ, READ_ACP, and WRITE_ACP permissions on the object. You specify each grantee as a type=value pair, where the type can be one of the following: emailAddress – if value specified is the email address of an AWS account; id – if value specified is the canonical user ID of an AWS account; uri – if granting permission to a predefined group. Example: emailAddress="[email protected]", emailAddress="[email protected]"
contentTypeSTRING
OPTIONALA standard MIME type describing the format of the contents. For more information, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.
storageClassSTRING
OPTIONALIf you don't specify, Standard is the default storage class. Amazon S3 supports other storage classes. Valid Values: STANDARD | STANDARD_IA | REDUCED_REDUNDANCY
grantReadSTRING
OPTIONALAllows grantee to read the object data and its metadata. You specify each grantee as a type=value pair, where the type can be one of the following: emailAddress – if value specified is the email address of an AWS account; id – if value specified is the canonical user ID of an AWS account; uri – if granting permission to a predefined group. Example: emailAddress="[email protected]", emailAddress="[email protected]"
expiresSTRING
OPTIONALThe date and time at which the object is no longer cacheable. For more information, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.
grantWriteACPSTRING
OPTIONALAllows grantee to write the ACL for the applicable object. You specify each grantee as a type=value pair, where the type can be one of the following: emailAddress – if value specified is the email address of an AWS account; id – if value specified is the canonical user ID of an AWS account; uri – if granting permission to a predefined group. Example: emailAddress="[email protected]", emailAddress="[email protected]"
serverSideEncryptionSTRING
OPTIONALSpecifies a server-side encryption algorithm to use when Amazon S3 creates an object. Valid Value: aws:kms, AES256
SSECustomerKeyMD5STRING
OPTIONALSpecifies the base64-encoded 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
contentLengthSTRING
OPTIONALThe size of the object, in bytes. For more information, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.
cacheControlSTRING
OPTIONALCan be used to specify caching behavior along the request/reply chain. For more information, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
contentEncodingSTRING
OPTIONALSpecifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
SSECustomerAlgorithmSTRING
OPTIONALSpecifies the algorithm to use to when encrypting the object. Valid Value: AES256
taggingSTRING
OPTIONALSpecifies a set of one or more tags you want to associated with the object. These tags are stored in the tagging subresource associated with the object.
Request Snippet
unirest.post("https://AmazonS3dimasV1.p.rapidapi.com/addObject")
.header("X-RapidAPI-Host", "AmazonS3dimasV1.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
Log inSign up

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.post("https://AmazonS3dimasV1.p.rapidapi.com/addObject")
.header("X-RapidAPI-Host", "AmazonS3dimasV1.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication