You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.S3

Inherits:
AWS.Service show all
Identifier:
s3
API Version:
2006-03-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Sending a Request Using S3

var s3 = new AWS.S3();
s3.abortMultipartUpload(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the S3 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var s3 = new AWS.S3({apiVersion: '2006-03-01'});

You can also set the API version globally in AWS.config.apiVersions using the s3 service identifier:

AWS.config.apiVersions = {
  s3: '2006-03-01',
  // other service API versions
};

var s3 = new AWS.S3();

Version:

  • 2006-03-01

Defined Under Namespace

Classes: ManagedUpload

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

bucketExists, bucketNotExists, objectExists, objectNotExists

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, defineService

Constructor Details

new AWS.S3(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a S3 object

var s3 = new AWS.S3({apiVersion: '2006-03-01'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • useDualstack (Boolean) —

    Enables IPv6/IPv4 dualstack endpoint. When a DNS lookup is performed on an endpoint of this type, it returns an “A” record with an IPv4 address and an “AAAA” record with an IPv6 address. In most cases the network stack in the client environment will automatically prefer the AAAA record and make a connection using the IPv6 address. Note, however, that currently on Windows, the IPv4 address will be preferred.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.S3.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.S3.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.S3.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

abortMultipartUpload(params = {}, callback) ⇒ AWS.Request

This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts action and ensure that the parts list is empty.

For information about permissions required to use the multipart upload, see Multipart Upload and Permissions.

The following operations are related to AbortMultipartUpload:

Service Reference:

Examples:

To abort a multipart upload


/* The following example aborts a multipart upload. */

 var params = {
  Bucket: "examplebucket", 
  Key: "bigobject", 
  UploadId: "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
 };
 s3.abortMultipartUpload(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the abortMultipartUpload operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  UploadId: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  RequestPayer: requester
};
s3.abortMultipartUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name to which the upload was taking place.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • Key — (String)

      Key of the object for which the multipart upload was initiated.

    • UploadId — (String)

      Upload ID that identifies the multipart upload.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

completeMultipartUpload(params = {}, callback) ⇒ AWS.Request

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag value, returned after that part was uploaded.

Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.

Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload.

For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions.

CompleteMultipartUpload has the following special errors:

  • Error code: EntityTooSmall

    • Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.

    • 400 Bad Request

  • Error code: InvalidPart

    • Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.

    • 400 Bad Request

  • Error code: InvalidPartOrder

    • Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.

    • 400 Bad Request

  • Error code: NoSuchUpload

    • Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • 404 Not Found

The following operations are related to CompleteMultipartUpload:

Service Reference:

Examples:

To complete multipart upload


/* The following example completes a multipart upload. */

 var params = {
  Bucket: "examplebucket", 
  Key: "bigobject", 
  MultipartUpload: {
   Parts: [
      {
     ETag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"", 
     PartNumber: 1
    }, 
      {
     ETag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"", 
     PartNumber: 2
    }
   ]
  }, 
  UploadId: "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
 };
 s3.completeMultipartUpload(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Bucket: "acexamplebucket", 
    ETag: "\"4d9031c7644d8081c2829f4ea23c55f7-2\"", 
    Key: "bigobject", 
    Location: "https://examplebucket.s3.<Region>.amazonaws.com/bigobject"
   }
   */
 });

Calling the completeMultipartUpload operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  UploadId: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  MultipartUpload: {
    Parts: [
      {
        ETag: 'STRING_VALUE',
        PartNumber: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  },
  RequestPayer: requester
};
s3.completeMultipartUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      Name of the bucket to which the multipart upload was initiated.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • Key — (String)

      Object key for which the multipart upload was initiated.

    • MultipartUpload — (map)

      The container for the multipart upload request information.

      • Parts — (Array<map>)

        Array of CompletedPart data types.

        • ETag — (String)

          Entity tag returned when the part was uploaded.

        • PartNumber — (Integer)

          Part number that identifies the part. This is a positive integer between 1 and 10,000.

    • UploadId — (String)

      ID for the initiated multipart upload.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Location — (String)

        The URI that identifies the newly created object.

      • Bucket — (String)

        The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.

        When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

        When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

      • Key — (String)

        The object key of the newly created object.

      • Expiration — (String)

        If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.

      • ETag — (String)

        Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits.

      • ServerSideEncryption — (String)

        If you specified server-side encryption either with an Amazon S3-managed encryption key or an Amazon Web Services KMS key in your initiate multipart upload request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

        Possible values include:
        • "AES256"
        • "aws:kms"
      • VersionId — (String)

        Version ID of the newly created object, in case the bucket has versioning turned on.

      • SSEKMSKeyId — (String)

        If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

      • BucketKeyEnabled — (Boolean)

        Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

copyObject(params = {}, callback) ⇒ AWS.Request

Creates a copy of an object that is already stored in Amazon S3.

Note: You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API.

All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.

If the copy is successful, you receive a response with information about the copied object.

Note: If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.

The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing.

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration.

Metadata

When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.

To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive header. When you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.

x-amz-copy-source-if Headers

To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the following request parameters:

  • x-amz-copy-source-if-match

  • x-amz-copy-source-if-none-match

  • x-amz-copy-source-if-unmodified-since

  • x-amz-copy-source-if-modified-since

If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

  • x-amz-copy-source-if-match condition evaluates to true

  • x-amz-copy-source-if-unmodified-since condition evaluates to false

If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code:

  • x-amz-copy-source-if-none-match condition evaluates to false

  • x-amz-copy-source-if-modified-since condition evaluates to true

Note: All headers with the x-amz- prefix, including x-amz-copy-source, must be signed.

Server-side encryption

When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption.

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

Access Control List (ACL)-Specific Request Headers

When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

Storage Class Options

You can use the CopyObject action to change the storage class of an object that is already stored in Amazon S3 using the StorageClass parameter. For more information, see Storage Classes in the Amazon S3 User Guide.

Versioning

By default, x-amz-copy-source identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId subresource.

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response.

If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.

If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject.

The following operations are related to CopyObject:

For more information, see Copying Objects.

Service Reference:

Examples:

To copy an object


/* The following example copies an object from one bucket to another. */

 var params = {
  Bucket: "destinationbucket", 
  CopySource: "/sourcebucket/HappyFacejpg", 
  Key: "HappyFaceCopyjpg"
 };
 s3.copyObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CopyObjectResult: {
     ETag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
     LastModified: <Date Representation>
    }
   }
   */
 });

Calling the copyObject operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  CopySource: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ACL: private | public-read | public-read-write | authenticated-read | aws-exec-read | bucket-owner-read | bucket-owner-full-control,
  BucketKeyEnabled: true || false,
  CacheControl: 'STRING_VALUE',
  ContentDisposition: 'STRING_VALUE',
  ContentEncoding: 'STRING_VALUE',
  ContentLanguage: 'STRING_VALUE',
  ContentType: 'STRING_VALUE',
  CopySourceIfMatch: 'STRING_VALUE',
  CopySourceIfModifiedSince: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CopySourceIfNoneMatch: 'STRING_VALUE',
  CopySourceIfUnmodifiedSince: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CopySourceSSECustomerAlgorithm: 'STRING_VALUE',
  CopySourceSSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  CopySourceSSECustomerKeyMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  ExpectedSourceBucketOwner: 'STRING_VALUE',
  Expires: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  GrantFullControl: 'STRING_VALUE',
  GrantRead: 'STRING_VALUE',
  GrantReadACP: 'STRING_VALUE',
  GrantWriteACP: 'STRING_VALUE',
  Metadata: {
    '<MetadataKey>': 'STRING_VALUE',
    /* '<MetadataKey>': ... */
  },
  MetadataDirective: COPY | REPLACE,
  ObjectLockLegalHoldStatus: ON | OFF,
  ObjectLockMode: GOVERNANCE | COMPLIANCE,
  ObjectLockRetainUntilDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  RequestPayer: requester,
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SSECustomerKeyMD5: 'STRING_VALUE',
  SSEKMSEncryptionContext: 'STRING_VALUE',
  SSEKMSKeyId: 'STRING_VALUE',
  ServerSideEncryption: AES256 | aws:kms,
  StorageClass: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS,
  Tagging: 'STRING_VALUE',
  TaggingDirective: COPY | REPLACE,
  WebsiteRedirectLocation: 'STRING_VALUE'
};
s3.copyObject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ACL — (String)

      The canned ACL to apply to the object.

      This action is not supported by Amazon S3 on Outposts.

      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
      • "aws-exec-read"
      • "bucket-owner-read"
      • "bucket-owner-full-control"
    • Bucket — (String)

      The name of the destination bucket.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • CacheControl — (String)

      Specifies caching behavior along the request/reply chain.

    • ContentDisposition — (String)

      Specifies presentational information for the object.

    • ContentEncoding — (String)

      Specifies 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.

    • ContentLanguage — (String)

      The language the content is in.

    • ContentType — (String)

      A standard MIME type describing the format of the object data.

    • CopySource — (String)

      Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

      • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

      • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

        Note: Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

        Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

      To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

    • CopySourceIfMatch — (String)

      Copies the object if its entity tag (ETag) matches the specified tag.

    • CopySourceIfModifiedSince — (Date)

      Copies the object if it has been modified since the specified time.

    • CopySourceIfNoneMatch — (String)

      Copies the object if its entity tag (ETag) is different than the specified ETag.

    • CopySourceIfUnmodifiedSince — (Date)

      Copies the object if it hasn't been modified since the specified time.

    • Expires — (Date)

      The date and time at which the object is no longer cacheable.

    • GrantFullControl — (String)

      Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

      This action is not supported by Amazon S3 on Outposts.

    • GrantRead — (String)

      Allows grantee to read the object data and its metadata.

      This action is not supported by Amazon S3 on Outposts.

    • GrantReadACP — (String)

      Allows grantee to read the object ACL.

      This action is not supported by Amazon S3 on Outposts.

    • GrantWriteACP — (String)

      Allows grantee to write the ACL for the applicable object.

      This action is not supported by Amazon S3 on Outposts.

    • Key — (String)

      The key of the destination object.

    • Metadata — (map<String>)

      A map of metadata to store with the object in S3.

    • MetadataDirective — (String)

      Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

      Possible values include:
      • "COPY"
      • "REPLACE"
    • TaggingDirective — (String)

      Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

      Possible values include:
      • "COPY"
      • "REPLACE"
    • ServerSideEncryption — (String)

      The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

      Possible values include:
      • "AES256"
      • "aws:kms"
    • StorageClass — (String)

      By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

      Possible values include:
      • "STANDARD"
      • "REDUCED_REDUNDANCY"
      • "STANDARD_IA"
      • "ONEZONE_IA"
      • "INTELLIGENT_TIERING"
      • "GLACIER"
      • "DEEP_ARCHIVE"
      • "OUTPOSTS"
    • WebsiteRedirectLocation — (String)

      If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    • SSECustomerAlgorithm — (String)

      Specifies the algorithm to use to when encrypting the object (for example, AES256).

    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 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.

    • SSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    • SSEKMSKeyId — (String)

      Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

    • SSEKMSEncryptionContext — (String)

      Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    • BucketKeyEnabled — (Boolean)

      Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

      Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

    • CopySourceSSECustomerAlgorithm — (String)

      Specifies the algorithm to use when decrypting the source object (for example, AES256).

    • CopySourceSSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

    • CopySourceSSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • Tagging — (String)

      The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

    • ObjectLockMode — (String)

      The Object Lock mode that you want to apply to the copied object.

      Possible values include:
      • "GOVERNANCE"
      • "COMPLIANCE"
    • ObjectLockRetainUntilDate — (Date)

      The date and time when you want the copied object's Object Lock to expire.

    • ObjectLockLegalHoldStatus — (String)

      Specifies whether you want to apply a Legal Hold to the copied object.

      Possible values include:
      • "ON"
      • "OFF"
    • ExpectedBucketOwner — (String)

      The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

    • ExpectedSourceBucketOwner — (String)

      The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CopyObjectResult — (map)

        Container for all response elements.

        • ETag — (String)

          Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.

        • LastModified — (Date)

          Creation date of the object.

      • Expiration — (String)

        If the object expiration is configured, the response includes this header.

      • CopySourceVersionId — (String)

        Version of the copied object in the destination bucket.

      • VersionId — (String)

        Version ID of the newly created copy.

      • ServerSideEncryption — (String)

        The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

        Possible values include:
        • "AES256"
        • "aws:kms"
      • SSECustomerAlgorithm — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

      • SSECustomerKeyMD5 — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

      • SSEKMSKeyId — (String)

        If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

      • SSEKMSEncryptionContext — (String)

        If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

      • BucketKeyEnabled — (Boolean)

        Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createBucket(params, callback) ⇒ AWS.Request

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Bucket naming rules.

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see Accessing a bucket.

Note: If you send your create bucket request to the s3.amazonaws.com endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual hosting of buckets.

When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.

  • Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.

  • Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access control list (ACL) overview.

    You specify each grantee as a type=value pair, where the type is one of the following:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Note: Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
      • US East (N. Virginia)
      • US West (N. California)
      • US West (Oregon)
      • Asia Pacific (Singapore)
      • Asia Pacific (Sydney)
      • Asia Pacific (Tokyo)
      • Europe (Ireland)
      • South America (São Paulo)
      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    x-amz-grant-read: id="11112222333", id="444455556666"

Note: You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Permissions

If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, authenticated-read, or if you specify access permissions explicitly through any other ACL, both s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the CreateBucket request is private, only s3:CreateBucket permission is needed.

If ObjectLockEnabledForBucket is set to true in your CreateBucket request, s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.

The following operations are related to CreateBucket:

Note: This operation cannot be used in a browser. S3 does not support CORS on this operation.

Service Reference:

Examples:

To create a bucket


/* The following example creates a bucket. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.createBucket(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Location: "/examplebucket"
   }
   */
 });

To create a bucket in a specific region


/* The following example creates a bucket. The request specifies an AWS region where to create the bucket. */

 var params = {
  Bucket: "examplebucket", 
  CreateBucketConfiguration: {
   LocationConstraint: "eu-west-1"
  }
 };
 s3.createBucket(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Location: "http://examplebucket.<Region>.s3.amazonaws.com/"
   }
   */
 });

Calling the createBucket operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ACL: private | public-read | public-read-write | authenticated-read,
  CreateBucketConfiguration: {
    LocationConstraint: af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ca-central-1 | cn-north-1 | cn-northwest-1 | EU | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-2 | us-gov-east-1 | us-gov-west-1 | us-west-1 | us-west-2
  },
  GrantFullControl: 'STRING_VALUE',
  GrantRead: 'STRING_VALUE',
  GrantReadACP: 'STRING_VALUE',
  GrantWrite: 'STRING_VALUE',
  GrantWriteACP: 'STRING_VALUE',
  ObjectLockEnabledForBucket: true || false
};
s3.createBucket(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • ACL — (String)

      The canned ACL to apply to the bucket.

      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
    • Bucket — (String)

      The name of the bucket to create.

    • CreateBucketConfiguration — (map)

      The configuration information for the bucket.

      • LocationConstraint — (String)

        Specifies the Region where the bucket will be created. If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1).

        Possible values include:
        • "af-south-1"
        • "ap-east-1"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "ap-northeast-3"
        • "ap-south-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ca-central-1"
        • "cn-north-1"
        • "cn-northwest-1"
        • "EU"
        • "eu-central-1"
        • "eu-north-1"
        • "eu-south-1"
        • "eu-west-1"
        • "eu-west-2"
        • "eu-west-3"
        • "me-south-1"
        • "sa-east-1"
        • "us-east-2"
        • "us-gov-east-1"
        • "us-gov-west-1"
        • "us-west-1"
        • "us-west-2"
    • GrantFullControl — (String)

      Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    • GrantRead — (String)

      Allows grantee to list the objects in the bucket.

    • GrantReadACP — (String)

      Allows grantee to read the bucket ACL.

    • GrantWrite — (String)

      Allows grantee to create new objects in the bucket.

      For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

    • GrantWriteACP — (String)

      Allows grantee to write the ACL for the applicable bucket.

    • ObjectLockEnabledForBucket — (Boolean)

      Specifies whether you want S3 Object Lock to be enabled for the new bucket.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Location — (String)

        Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createMultipartUpload(params = {}, callback) ⇒ AWS.Request

This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.

For more information about multipart uploads, see Multipart Upload Overview.

If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

For information about the permissions required to use the multipart upload API, see Multipart Upload and Permissions.

For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4).

Note: After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.

You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload.

To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions in the Amazon S3 User Guide.

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.

For more information, see Protecting Data Using Server-Side Encryption.

Access Permissions

When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:

  • Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL.

  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Server-Side- Encryption-Specific Request Headers

You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key.

  • Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.

    • x-amz-server-side-encryption

    • x-amz-server-side-encryption-aws-kms-key-id

    • x-amz-server-side-encryption-context

    Note: If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key in Amazon Web Services KMS to protect the data.

    All GET and PUT requests for an object protected by Amazon Web Services KMS fail if you don't make them with SSL or by using SigV4.

    For more information about server-side encryption with KMS key (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys.

  • Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.

    • x-amz-server-side-encryption-customer-algorithm

    • x-amz-server-side-encryption-customer-key

    • x-amz-server-side-encryption-customer-key-MD5

    For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys.

Access-Control-List (ACL)-Specific Request Headers

You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:

  • Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.

  • Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:

    • x-amz-grant-read

    • x-amz-grant-write

    • x-amz-grant-read-acp

    • x-amz-grant-write-acp

    • x-amz-grant-full-control

    You specify each grantee as a type=value pair, where the type is one of the following:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Note: Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
      • US East (N. Virginia)
      • US West (N. California)
      • US West (Oregon)
      • Asia Pacific (Singapore)
      • Asia Pacific (Sydney)
      • Asia Pacific (Tokyo)
      • Europe (Ireland)
      • South America (São Paulo)
      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    x-amz-grant-read: id="11112222333", id="444455556666"

The following operations are related to CreateMultipartUpload:

Service Reference:

Examples:

To initiate a multipart upload


/* The following example initiates a multipart upload. */

 var params = {
  Bucket: "examplebucket", 
  Key: "largeobject"
 };
 s3.createMultipartUpload(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Bucket: "examplebucket", 
    Key: "largeobject", 
    UploadId: "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--"
   }
   */
 });

Calling the createMultipartUpload operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ACL: private | public-read | public-read-write | authenticated-read | aws-exec-read | bucket-owner-read | bucket-owner-full-control,
  BucketKeyEnabled: true || false,
  CacheControl: 'STRING_VALUE',
  ContentDisposition: 'STRING_VALUE',
  ContentEncoding: 'STRING_VALUE',
  ContentLanguage: 'STRING_VALUE',
  ContentType: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  Expires: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  GrantFullControl: 'STRING_VALUE',
  GrantRead: 'STRING_VALUE',
  GrantReadACP: 'STRING_VALUE',
  GrantWriteACP: 'STRING_VALUE',
  Metadata: {
    '<MetadataKey>': 'STRING_VALUE',
    /* '<MetadataKey>': ... */
  },
  ObjectLockLegalHoldStatus: ON | OFF,
  ObjectLockMode: GOVERNANCE | COMPLIANCE,
  ObjectLockRetainUntilDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  RequestPayer: requester,
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SSECustomerKeyMD5: 'STRING_VALUE',
  SSEKMSEncryptionContext: 'STRING_VALUE',
  SSEKMSKeyId: 'STRING_VALUE',
  ServerSideEncryption: AES256 | aws:kms,
  StorageClass: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS,
  Tagging: 'STRING_VALUE',
  WebsiteRedirectLocation: 'STRING_VALUE'
};
s3.createMultipartUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ACL — (String)

      The canned ACL to apply to the object.

      This action is not supported by Amazon S3 on Outposts.

      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
      • "aws-exec-read"
      • "bucket-owner-read"
      • "bucket-owner-full-control"
    • Bucket — (String)

      The name of the bucket to which to initiate the upload

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • CacheControl — (String)

      Specifies caching behavior along the request/reply chain.

    • ContentDisposition — (String)

      Specifies presentational information for the object.

    • ContentEncoding — (String)

      Specifies 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.

    • ContentLanguage — (String)

      The language the content is in.

    • ContentType — (String)

      A standard MIME type describing the format of the object data.

    • Expires — (Date)

      The date and time at which the object is no longer cacheable.

    • GrantFullControl — (String)

      Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

      This action is not supported by Amazon S3 on Outposts.

    • GrantRead — (String)

      Allows grantee to read the object data and its metadata.

      This action is not supported by Amazon S3 on Outposts.

    • GrantReadACP — (String)

      Allows grantee to read the object ACL.

      This action is not supported by Amazon S3 on Outposts.

    • GrantWriteACP — (String)

      Allows grantee to write the ACL for the applicable object.

      This action is not supported by Amazon S3 on Outposts.

    • Key — (String)

      Object key for which the multipart upload is to be initiated.

    • Metadata — (map<String>)

      A map of metadata to store with the object in S3.

    • ServerSideEncryption — (String)

      The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

      Possible values include:
      • "AES256"
      • "aws:kms"
    • StorageClass — (String)

      By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

      Possible values include:
      • "STANDARD"
      • "REDUCED_REDUNDANCY"
      • "STANDARD_IA"
      • "ONEZONE_IA"
      • "INTELLIGENT_TIERING"
      • "GLACIER"
      • "DEEP_ARCHIVE"
      • "OUTPOSTS"
    • WebsiteRedirectLocation — (String)

      If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    • SSECustomerAlgorithm — (String)

      Specifies the algorithm to use to when encrypting the object (for example, AES256).

    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 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.

    • SSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    • SSEKMSKeyId — (String)

      Specifies the ID of the symmetric customer managed key to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

    • SSEKMSEncryptionContext — (String)

      Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    • BucketKeyEnabled — (Boolean)

      Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

      Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • Tagging — (String)

      The tag-set for the object. The tag-set must be encoded as URL Query parameters.

    • ObjectLockMode — (String)

      Specifies the Object Lock mode that you want to apply to the uploaded object.

      Possible values include:
      • "GOVERNANCE"
      • "COMPLIANCE"
    • ObjectLockRetainUntilDate — (Date)

      Specifies the date and time when you want the Object Lock to expire.

    • ObjectLockLegalHoldStatus — (String)

      Specifies whether you want to apply a Legal Hold to the uploaded object.

      Possible values include:
      • "ON"
      • "OFF"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AbortDate — (Date)

        If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

        The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.

      • AbortRuleId — (String)

        This header is returned along with the x-amz-abort-date header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

      • Bucket — (String)

        The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

        When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

        When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

      • Key — (String)

        Object key for which the multipart upload was initiated.

      • UploadId — (String)

        ID for the initiated multipart upload.

      • ServerSideEncryption — (String)

        The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

        Possible values include:
        • "AES256"
        • "aws:kms"
      • SSECustomerAlgorithm — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

      • SSECustomerKeyMD5 — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

      • SSEKMSKeyId — (String)

        If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

      • SSEKMSEncryptionContext — (String)

        If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

      • BucketKeyEnabled — (Boolean)

        Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createPresignedPost(params, callback) ⇒ map?

Note:

All fields passed in when creating presigned post data will be signed as exact match conditions. Any fields that will be interpolated by S3 must be added to the fields hash after signing, and an appropriate condition for such fields must be explicitly added to the Conditions array passed to this function before signing.

Note:

You must ensure that you have static or previously resolved credentials if you call this method synchronously (with no callback), otherwise it may not properly sign the request. If you cannot guarantee this (you are using an asynchronous credential provider, i.e., EC2 IAM roles), you should always call this method with an asynchronous callback.

Get a pre-signed POST policy to support uploading to S3 directly from an HTML form.

Examples:

Presiging post data with a known key

var params = {
  Bucket: 'bucket',
  Fields: {
    key: 'key'
  }
};
s3.createPresignedPost(params, function(err, data) {
  if (err) {
    console.error('Presigning post data encountered an error', err);
  } else {
    console.log('The post data is', data);
  }
});

Presigning post data with an interpolated key

var params = {
  Bucket: 'bucket',
  Conditions: [
    ['starts-with', '$key', 'path/to/uploads/']
  ]
};
s3.createPresignedPost(params, function(err, data) {
  if (err) {
    console.error('Presigning post data encountered an error', err);
  } else {
    data.Fields.key = 'path/to/uploads/${filename}';
    console.log('The post data is', data);
  }
});

Parameters:

  • params (map)
  • callback (Function)

Callback (callback):

  • function(err, data) { ... }

    Parameters:

    • err (Error) —

      the error object returned from the policy signer

    • data (map) —

      The data necessary to construct an HTML form

    • data.url (String) —

      The URL to use as the action of the form

    • data.fields (map) —

      A hash of fields that must be included in the form for the upload to succeed. This hash will include the signed POST policy, your access key ID and security token (if present), etc. These may be safely included as input elements of type 'hidden.'

Options Hash (params):

  • Bucket (String) —

    The bucket to which the post should be uploaded

  • Expires (Integer) — default: 3600 —

    The number of seconds for which the presigned policy should be valid.

  • Conditions (Array) —

    An array of conditions that must be met for the presigned policy to allow the upload. This can include required tags, the accepted range for content lengths, etc.

  • Fields (map) —

    Fields to include in the form. All values passed in as fields will be signed as exact match conditions.

Returns:

  • (map) —

    If called synchronously (with no callback), returns a hash with the url to set as the form action and a hash of fields to include in the form.

  • (null) —

    Nothing is returned if a callback is provided.

See Also:

deleteBucket(params = {}, callback) ⇒ AWS.Request

Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

Related Resources

Note: This operation cannot be used in a browser. S3 does not support CORS on this operation.

Service Reference:

Examples:

To delete a bucket


/* The following example deletes the specified bucket. */

 var params = {
  Bucket: "forrandall2"
 };
 s3.deleteBucket(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteBucket operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deleteBucket(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      Specifies the bucket being deleted.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBucketAnalyticsConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to DeleteBucketAnalyticsConfiguration:

Service Reference:

Examples:

Calling the deleteBucketAnalyticsConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deleteBucketAnalyticsConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket from which an analytics configuration is deleted.

    • Id — (String)

      The ID that identifies the analytics configuration.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBucketCors(params = {}, callback) ⇒ AWS.Request

Deletes the cors configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant this permission to others.

For information about cors, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Related Resources:

Service Reference:

Examples:

To delete cors configuration on a bucket.


/* The following example deletes CORS configuration on a bucket. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.deleteBucketCors(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteBucketCors operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deleteBucketCors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      Specifies the bucket whose cors configuration is being deleted.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBucketEncryption(params = {}, callback) ⇒ AWS.Request

This implementation of the DELETE action removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon S3 User Guide.

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

Related Resources

Service Reference:

Examples:

Calling the deleteBucketEncryption operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deleteBucketEncryption(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket containing the server-side encryption configuration to delete.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBucketIntelligentTieringConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in two low latency and high throughput access tiers. For data that can be accessed asynchronously, you can choose to activate automatic archiving capabilities within the S3 Intelligent-Tiering storage class.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to DeleteBucketIntelligentTieringConfiguration include:

Service Reference:

Examples:

Calling the deleteBucketIntelligentTieringConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE' /* required */
};
s3.deleteBucketIntelligentTieringConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

    • Id — (String)

      The ID used to identify the S3 Intelligent-Tiering configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBucketInventoryConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes an inventory configuration (identified by the inventory ID) from the bucket.

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

Operations related to DeleteBucketInventoryConfiguration include:

Service Reference:

Examples:

Calling the deleteBucketInventoryConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deleteBucketInventoryConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket containing the inventory configuration to delete.

    • Id — (String)

      The ID used to identify the inventory configuration.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBucketLifecycle(params = {}, callback) ⇒ AWS.Request

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.

To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.

There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.

For more information about the object expiration, see Elements to Describe Lifecycle Actions.

Related actions include:

Service Reference:

Examples:

To delete lifecycle configuration on a bucket.


/* The following example deletes lifecycle configuration on a bucket. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.deleteBucketLifecycle(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteBucketLifecycle operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deleteBucketLifecycle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name of the lifecycle to delete.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBucketMetricsConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to DeleteBucketMetricsConfiguration:

Service Reference:

Examples:

Calling the deleteBucketMetricsConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deleteBucketMetricsConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket containing the metrics configuration to delete.

    • Id — (String)

      The ID used to identify the metrics configuration.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBucketOwnershipControls(params = {}, callback) ⇒ AWS.Request

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to DeleteBucketOwnershipControls:

Service Reference:

Examples:

Calling the deleteBucketOwnershipControls operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deleteBucketOwnershipControls(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The Amazon S3 bucket whose OwnershipControls you want to delete.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBucketPolicy(params = {}, callback) ⇒ AWS.Request

This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account to use this operation.

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and UserPolicies.

The following operations are related to DeleteBucketPolicy

Service Reference:

Examples:

To delete bucket policy


/* The following example deletes bucket policy on the specified bucket. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.deleteBucketPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteBucketPolicy operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deleteBucketPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBucketReplication(params = {}, callback) ⇒ AWS.Request

Deletes the replication configuration from the bucket.

To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

Note: It can take a while for the deletion of a replication configuration to fully propagate.

For information about replication configuration, see Replication in the Amazon S3 User Guide.

The following operations are related to DeleteBucketReplication:

Service Reference:

Examples:

To delete bucket replication configuration


/* The following example deletes replication configuration set on bucket. */

 var params = {
  Bucket: "example"
 };
 s3.deleteBucketReplication(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteBucketReplication operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deleteBucketReplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBucketTagging(params = {}, callback) ⇒ AWS.Request

Deletes the tags from the bucket.

To use this operation, you must have permission to perform the s3:PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

The following operations are related to DeleteBucketTagging:

Service Reference:

Examples:

To delete bucket tags


/* The following example deletes bucket tags. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.deleteBucketTagging(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteBucketTagging operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deleteBucketTagging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket that has the tag set to be removed.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBucketWebsite(params = {}, callback) ⇒ AWS.Request

This action removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist.

This DELETE action requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission.

For more information about hosting websites, see Hosting Websites on Amazon S3.

The following operations are related to DeleteBucketWebsite:

Service Reference:

Examples:

To delete bucket website configuration


/* The following example deletes bucket website configuration. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.deleteBucketWebsite(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteBucketWebsite operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deleteBucketWebsite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name for which you want to remove the website configuration.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteObject(params = {}, callback) ⇒ AWS.Request

Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects but will still respond that the command was successful.

To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, to true.

If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE versionId request. Requests that include x-amz-mfa must use HTTPS.

For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.

You can delete objects by explicitly calling DELETE Object or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration actions.

The following action is related to DeleteObject:

Service Reference:

Examples:

To delete an object (from a non-versioned bucket)


/* The following example deletes an object from a non-versioned bucket. */

 var params = {
  Bucket: "ExampleBucket", 
  Key: "HappyFace.jpg"
 };
 s3.deleteObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

To delete an object


/* The following example deletes an object from an S3 bucket. */

 var params = {
  Bucket: "examplebucket", 
  Key: "objectkey.jpg"
 };
 s3.deleteObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteObject operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  BypassGovernanceRetention: true || false,
  ExpectedBucketOwner: 'STRING_VALUE',
  MFA: 'STRING_VALUE',
  RequestPayer: requester,
  VersionId: 'STRING_VALUE'
};
s3.deleteObject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name of the bucket containing the object.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • Key — (String)

      Key name of the object to delete.

    • MFA — (String)

      The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

    • VersionId — (String)

      VersionId used to reference a specific version of the object.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • BypassGovernanceRetention — (Boolean)

      Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:PutBucketPublicAccessBlock permission.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeleteMarker — (Boolean)

        Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.

      • VersionId — (String)

        Returns the version ID of the delete marker created as a result of the DELETE operation.

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteObjects(params = {}, callback) ⇒ AWS.Request

This action 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 this action provides a suitable alternative to sending individual delete requests, reducing per-request overhead.

The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete action and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.

The action supports two modes for the response: verbose and quiet. By default, the action uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete action encountered an error. For a successful deletion, the action does not return any information about the delete in the response body.

When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete.

Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.

The following operations are related to DeleteObjects:

Service Reference:

Examples:

To delete multiple object versions from a versioned bucket


/* The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response. */

 var params = {
  Bucket: "examplebucket", 
  Delete: {
   Objects: [
      {
     Key: "HappyFace.jpg", 
     VersionId: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
    }, 
      {
     Key: "HappyFace.jpg", 
     VersionId: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
    }
   ], 
   Quiet: false
  }
 };
 s3.deleteObjects(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Deleted: [
       {
      Key: "HappyFace.jpg", 
      VersionId: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
     }, 
       {
      Key: "HappyFace.jpg", 
      VersionId: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
     }
    ]
   }
   */
 });

To delete multiple objects from a versioned bucket


/* The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker. */

 var params = {
  Bucket: "examplebucket", 
  Delete: {
   Objects: [
      {
     Key: "objectkey1"
    }, 
      {
     Key: "objectkey2"
    }
   ], 
   Quiet: false
  }
 };
 s3.deleteObjects(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Deleted: [
       {
      DeleteMarker: true, 
      DeleteMarkerVersionId: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F", 
      Key: "objectkey1"
     }, 
       {
      DeleteMarker: true, 
      DeleteMarkerVersionId: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt", 
      Key: "objectkey2"
     }
    ]
   }
   */
 });

Calling the deleteObjects operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Delete: { /* required */
    Objects: [ /* required */
      {
        Key: 'STRING_VALUE', /* required */
        VersionId: 'STRING_VALUE'
      },
      /* more items */
    ],
    Quiet: true || false
  },
  BypassGovernanceRetention: true || false,
  ExpectedBucketOwner: 'STRING_VALUE',
  MFA: 'STRING_VALUE',
  RequestPayer: requester
};
s3.deleteObjects(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name containing the objects to delete.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • Delete — (map)

      Container for the request.

      • Objects — required — (Array<map>)

        The objects to delete.

        • Key — required — (String)

          Key name of the object.

          Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

        • VersionId — (String)

          VersionId for the specific version of the object to delete.

      • Quiet — (Boolean)

        Element to enable quiet mode for the request. When you add this element, you must set its value to true.

    • MFA — (String)

      The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • BypassGovernanceRetention — (Boolean)

      Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:PutBucketPublicAccessBlock permission.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Deleted — (Array<map>)

        Container element for a successful delete. It identifies the object that was successfully deleted.

        • Key — (String)

          The name of the deleted object.

        • VersionId — (String)

          The version ID of the deleted object.

        • DeleteMarker — (Boolean)

          Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete marker was created.

        • DeleteMarkerVersionId — (String)

          The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"
      • Errors — (Array<map>)

        Container for a failed delete action that describes the object that Amazon S3 attempted to delete and the error it encountered.

        • Key — (String)

          The error key.

        • VersionId — (String)

          The version ID of the error.

        • Code — (String)

          The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.

          Amazon S3 error codes

            • Code: AccessDenied

            • Description: Access Denied

            • HTTP Status Code: 403 Forbidden

            • SOAP Fault Code Prefix: Client

            • Code: AccountProblem

            • Description: There is a problem with your Amazon Web Services account that prevents the action from completing successfully. Contact Amazon Web Services Support for further assistance.

            • HTTP Status Code: 403 Forbidden

            • SOAP Fault Code Prefix: Client

            • Code: AllAccessDisabled

            • Description: All access to this Amazon S3 resource has been disabled. Contact Amazon Web Services Support for further assistance.

            • HTTP Status Code: 403 Forbidden

            • SOAP Fault Code Prefix: Client

            • Code: AmbiguousGrantByEmailAddress

            • Description: The email address you provided is associated with more than one account.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: AuthorizationHeaderMalformed

            • Description: The authorization header you provided is invalid.

            • HTTP Status Code: 400 Bad Request

            • HTTP Status Code: N/A

            • Code: BadDigest

            • Description: The Content-MD5 you specified did not match what we received.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: BucketAlreadyExists

            • Description: The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.

            • HTTP Status Code: 409 Conflict

            • SOAP Fault Code Prefix: Client

            • Code: BucketAlreadyOwnedByYou

            • Description: The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).

            • Code: 409 Conflict (in all Regions except the North Virginia Region)

            • SOAP Fault Code Prefix: Client

            • Code: BucketNotEmpty

            • Description: The bucket you tried to delete is not empty.

            • HTTP Status Code: 409 Conflict

            • SOAP Fault Code Prefix: Client

            • Code: CredentialsNotSupported

            • Description: This request does not support credentials.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: CrossLocationLoggingProhibited

            • Description: Cross-location logging not allowed. Buckets in one geographic location cannot log information to a bucket in another location.

            • HTTP Status Code: 403 Forbidden

            • SOAP Fault Code Prefix: Client

            • Code: EntityTooSmall

            • Description: Your proposed upload is smaller than the minimum allowed object size.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: EntityTooLarge

            • Description: Your proposed upload exceeds the maximum allowed object size.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: ExpiredToken

            • Description: The provided token has expired.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: IllegalVersioningConfigurationException

            • Description: Indicates that the versioning configuration specified in the request is invalid.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: IncompleteBody

            • Description: You did not provide the number of bytes specified by the Content-Length HTTP header

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: IncorrectNumberOfFilesInPostRequest

            • Description: POST requires exactly one file upload per request.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InlineDataTooLarge

            • Description: Inline data exceeds the maximum allowed size.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InternalError

            • Description: We encountered an internal error. Please try again.

            • HTTP Status Code: 500 Internal Server Error

            • SOAP Fault Code Prefix: Server

            • Code: InvalidAccessKeyId

            • Description: The Amazon Web Services access key ID you provided does not exist in our records.

            • HTTP Status Code: 403 Forbidden

            • SOAP Fault Code Prefix: Client

            • Code: InvalidAddressingHeader

            • Description: You must specify the Anonymous role.

            • HTTP Status Code: N/A

            • SOAP Fault Code Prefix: Client

            • Code: InvalidArgument

            • Description: Invalid Argument

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidBucketName

            • Description: The specified bucket is not valid.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidBucketState

            • Description: The request is not valid with the current state of the bucket.

            • HTTP Status Code: 409 Conflict

            • SOAP Fault Code Prefix: Client

            • Code: InvalidDigest

            • Description: The Content-MD5 you specified is not valid.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidEncryptionAlgorithmError

            • Description: The encryption request you specified is not valid. The valid value is AES256.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidLocationConstraint

            • Description: The specified location constraint is not valid. For more information about Regions, see How to Select a Region for Your Buckets.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidObjectState

            • Description: The action is not valid for the current state of the object.

            • HTTP Status Code: 403 Forbidden

            • SOAP Fault Code Prefix: Client

            • Code: InvalidPart

            • Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidPartOrder

            • Description: The list of parts was not in ascending order. Parts list must be specified in order by part number.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidPayer

            • Description: All access to this object has been disabled. Please contact Amazon Web Services Support for further assistance.

            • HTTP Status Code: 403 Forbidden

            • SOAP Fault Code Prefix: Client

            • Code: InvalidPolicyDocument

            • Description: The content of the form does not meet the conditions specified in the policy document.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidRange

            • Description: The requested range cannot be satisfied.

            • HTTP Status Code: 416 Requested Range Not Satisfiable

            • SOAP Fault Code Prefix: Client

            • Code: InvalidRequest

            • Description: Please use AWS4-HMAC-SHA256.

            • HTTP Status Code: 400 Bad Request

            • Code: N/A

            • Code: InvalidRequest

            • Description: SOAP requests must be made over an HTTPS connection.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidRequest

            • Description: Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS compliant names.

            • HTTP Status Code: 400 Bad Request

            • Code: N/A

            • Code: InvalidRequest

            • Description: Amazon S3 Transfer Acceleration is not supported for buckets with periods (.) in their names.

            • HTTP Status Code: 400 Bad Request

            • Code: N/A

            • Code: InvalidRequest

            • Description: Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.

            • HTTP Status Code: 400 Bad Request

            • Code: N/A

            • Code: InvalidRequest

            • Description: Amazon S3 Transfer Accelerate is not configured on this bucket.

            • HTTP Status Code: 400 Bad Request

            • Code: N/A

            • Code: InvalidRequest

            • Description: Amazon S3 Transfer Accelerate is disabled on this bucket.

            • HTTP Status Code: 400 Bad Request

            • Code: N/A

            • Code: InvalidRequest

            • Description: Amazon S3 Transfer Acceleration is not supported on this bucket. Contact Amazon Web Services Support for more information.

            • HTTP Status Code: 400 Bad Request

            • Code: N/A

            • Code: InvalidRequest

            • Description: Amazon S3 Transfer Acceleration cannot be enabled on this bucket. Contact Amazon Web Services Support for more information.

            • HTTP Status Code: 400 Bad Request

            • Code: N/A

            • Code: InvalidSecurity

            • Description: The provided security credentials are not valid.

            • HTTP Status Code: 403 Forbidden

            • SOAP Fault Code Prefix: Client

            • Code: InvalidSOAPRequest

            • Description: The SOAP request body is invalid.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidStorageClass

            • Description: The storage class you specified is not valid.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidTargetBucketForLogging

            • Description: The target bucket for logging does not exist, is not owned by you, or does not have the appropriate grants for the log-delivery group.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidToken

            • Description: The provided token is malformed or otherwise invalid.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: InvalidURI

            • Description: Couldn't parse the specified URI.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: KeyTooLongError

            • Description: Your key is too long.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: MalformedACLError

            • Description: The XML you provided was not well-formed or did not validate against our published schema.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: MalformedPOSTRequest

            • Description: The body of your POST request is not well-formed multipart/form-data.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: MalformedXML

            • Description: This happens when the user sends malformed XML (XML that doesn't conform to the published XSD) for the configuration. The error message is, "The XML you provided was not well-formed or did not validate against our published schema."

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: MaxMessageLengthExceeded

            • Description: Your request was too big.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: MaxPostPreDataLengthExceededError

            • Description: Your POST request fields preceding the upload file were too large.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: MetadataTooLarge

            • Description: Your metadata headers exceed the maximum allowed metadata size.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: MethodNotAllowed

            • Description: The specified method is not allowed against this resource.

            • HTTP Status Code: 405 Method Not Allowed

            • SOAP Fault Code Prefix: Client

            • Code: MissingAttachment

            • Description: A SOAP attachment was expected, but none were found.

            • HTTP Status Code: N/A

            • SOAP Fault Code Prefix: Client

            • Code: MissingContentLength

            • Description: You must provide the Content-Length HTTP header.

            • HTTP Status Code: 411 Length Required

            • SOAP Fault Code Prefix: Client

            • Code: MissingRequestBodyError

            • Description: This happens when the user sends an empty XML document as a request. The error message is, "Request body is empty."

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: MissingSecurityElement

            • Description: The SOAP 1.1 request is missing a security element.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: MissingSecurityHeader

            • Description: Your request is missing a required header.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: NoLoggingStatusForKey

            • Description: There is no such thing as a logging status subresource for a key.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: NoSuchBucket

            • Description: The specified bucket does not exist.

            • HTTP Status Code: 404 Not Found

            • SOAP Fault Code Prefix: Client

            • Code: NoSuchBucketPolicy

            • Description: The specified bucket does not have a bucket policy.

            • HTTP Status Code: 404 Not Found

            • SOAP Fault Code Prefix: Client

            • Code: NoSuchKey

            • Description: The specified key does not exist.

            • HTTP Status Code: 404 Not Found

            • SOAP Fault Code Prefix: Client

            • Code: NoSuchLifecycleConfiguration

            • Description: The lifecycle configuration does not exist.

            • HTTP Status Code: 404 Not Found

            • SOAP Fault Code Prefix: Client

            • Code: NoSuchUpload

            • Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

            • HTTP Status Code: 404 Not Found

            • SOAP Fault Code Prefix: Client

            • Code: NoSuchVersion

            • Description: Indicates that the version ID specified in the request does not match an existing version.

            • HTTP Status Code: 404 Not Found

            • SOAP Fault Code Prefix: Client

            • Code: NotImplemented

            • Description: A header you provided implies functionality that is not implemented.

            • HTTP Status Code: 501 Not Implemented

            • SOAP Fault Code Prefix: Server

            • Code: NotSignedUp

            • Description: Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: Amazon S3

            • HTTP Status Code: 403 Forbidden

            • SOAP Fault Code Prefix: Client

            • Code: OperationAborted

            • Description: A conflicting conditional action is currently in progress against this resource. Try again.

            • HTTP Status Code: 409 Conflict

            • SOAP Fault Code Prefix: Client

            • Code: PermanentRedirect

            • Description: The bucket you are attempting to access must be addressed using the specified endpoint. Send all future requests to this endpoint.

            • HTTP Status Code: 301 Moved Permanently

            • SOAP Fault Code Prefix: Client

            • Code: PreconditionFailed

            • Description: At least one of the preconditions you specified did not hold.

            • HTTP Status Code: 412 Precondition Failed

            • SOAP Fault Code Prefix: Client

            • Code: Redirect

            • Description: Temporary redirect.

            • HTTP Status Code: 307 Moved Temporarily

            • SOAP Fault Code Prefix: Client

            • Code: RestoreAlreadyInProgress

            • Description: Object restore is already in progress.

            • HTTP Status Code: 409 Conflict

            • SOAP Fault Code Prefix: Client

            • Code: RequestIsNotMultiPartContent

            • Description: Bucket POST must be of the enclosure-type multipart/form-data.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: RequestTimeout

            • Description: Your socket connection to the server was not read from or written to within the timeout period.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: RequestTimeTooSkewed

            • Description: The difference between the request time and the server's time is too large.

            • HTTP Status Code: 403 Forbidden

            • SOAP Fault Code Prefix: Client

            • Code: RequestTorrentOfBucketError

            • Description: Requesting the torrent file of a bucket is not permitted.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: SignatureDoesNotMatch

            • Description: The request signature we calculated does not match the signature you provided. Check your Amazon Web Services secret access key and signing method. For more information, see REST Authentication and SOAP Authentication for details.

            • HTTP Status Code: 403 Forbidden

            • SOAP Fault Code Prefix: Client

            • Code: ServiceUnavailable

            • Description: Reduce your request rate.

            • HTTP Status Code: 503 Service Unavailable

            • SOAP Fault Code Prefix: Server

            • Code: SlowDown

            • Description: Reduce your request rate.

            • HTTP Status Code: 503 Slow Down

            • SOAP Fault Code Prefix: Server

            • Code: TemporaryRedirect

            • Description: You are being redirected to the bucket while DNS updates.

            • HTTP Status Code: 307 Moved Temporarily

            • SOAP Fault Code Prefix: Client

            • Code: TokenRefreshRequired

            • Description: The provided token must be refreshed.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: TooManyBuckets

            • Description: You have attempted to create more buckets than allowed.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: UnexpectedContent

            • Description: This request does not support content.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: UnresolvableGrantByEmailAddress

            • Description: The email address you provided does not match any account on record.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

            • Code: UserKeyMustBeSpecified

            • Description: The bucket POST must contain the specified field name. If it is specified, check the order of the fields.

            • HTTP Status Code: 400 Bad Request

            • SOAP Fault Code Prefix: Client

        • Message — (String)

          The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteObjectTagging(params = {}, callback) ⇒ AWS.Request

Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.

To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.

To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action.

The following operations are related to DeleteBucketMetricsConfiguration:

Service Reference:

Examples:

To remove tag set from an object version


/* The following example removes tag set associated with the specified object version. The request specifies both the object key and object version. */

 var params = {
  Bucket: "examplebucket", 
  Key: "HappyFace.jpg", 
  VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
 };
 s3.deleteObjectTagging(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
   }
   */
 });

To remove tag set from an object


/* The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version. */

 var params = {
  Bucket: "examplebucket", 
  Key: "HappyFace.jpg"
 };
 s3.deleteObjectTagging(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    VersionId: "null"
   }
   */
 });

Calling the deleteObjectTagging operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  VersionId: 'STRING_VALUE'
};
s3.deleteObjectTagging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name containing the objects from which to remove the tags.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • Key — (String)

      The key that identifies the object in the bucket from which to remove all tags.

    • VersionId — (String)

      The versionId of the object that the tag-set will be removed from.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VersionId — (String)

        The versionId of the object the tag-set was removed from.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePublicAccessBlock(params = {}, callback) ⇒ AWS.Request

Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to DeletePublicAccessBlock:

Service Reference:

Examples:

Calling the deletePublicAccessBlock operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.deletePublicAccessBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketAccelerateConfiguration(params = {}, callback) ⇒ AWS.Request

This implementation of the GET action uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.

To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended by using the PutBucketAccelerateConfiguration operation.

A GET accelerate request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.

For more information about transfer acceleration, see Transfer Acceleration in the Amazon S3 User Guide.

Related Resources

Service Reference:

Examples:

Calling the getBucketAccelerateConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketAccelerateConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which the accelerate configuration is retrieved.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (String)

        The accelerate configuration of the bucket.

        Possible values include:
        • "Enabled"
        • "Suspended"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketAcl(params = {}, callback) ⇒ AWS.Request

This implementation of the GET action uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

Related Resources

Service Reference:

Examples:

Calling the getBucketAcl operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketAcl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      Specifies the S3 bucket whose ACL is being requested.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Owner — (map)

        Container for the bucket owner's display name and ID.

        • DisplayName — (String)

          Container for the display name of the owner.

        • ID — (String)

          Container for the ID of the owner.

      • Grants — (Array<map>)

        A list of grants.

        • Grantee — (map)

          The person being granted permissions.

          • DisplayName — (String)

            Screen name of the grantee.

          • EmailAddress — (String)

            Email address of the grantee.

            Note: Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
            • US East (N. Virginia)
            • US West (N. California)
            • US West (Oregon)
            • Asia Pacific (Singapore)
            • Asia Pacific (Sydney)
            • Asia Pacific (Tokyo)
            • Europe (Ireland)
            • South America (São Paulo)
            For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
          • ID — (String)

            The canonical user ID of the grantee.

          • Type — required — (String)

            Type of grantee

            Possible values include:
            • "CanonicalUser"
            • "AmazonCustomerByEmail"
            • "Group"
          • URI — (String)

            URI of the grantee group.

        • Permission — (String)

          Specifies the permission given to the grantee.

          Possible values include:
          • "FULL_CONTROL"
          • "WRITE"
          • "WRITE_ACP"
          • "READ"
          • "READ_ACP"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketAnalyticsConfiguration(params = {}, callback) ⇒ AWS.Request

This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide.

Related Resources

Service Reference:

Examples:

Calling the getBucketAnalyticsConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketAnalyticsConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket from which an analytics configuration is retrieved.

    • Id — (String)

      The ID that identifies the analytics configuration.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AnalyticsConfiguration — (map)

        The configuration and any analyses for the analytics filter.

        • Id — required — (String)

          The ID that identifies the analytics configuration.

        • Filter — (map)

          The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

          • Prefix — (String)

            The prefix to use when evaluating an analytics filter.

          • Tag — (map)

            The tag to use when evaluating an analytics filter.

            • Key — required — (String)

              Name of the object key.

            • Value — required — (String)

              Value of the tag.

          • And — (map)

            A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

            • Prefix — (String)

              The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.

            • Tags — (Array<map>)

              The list of tags to use when evaluating an AND predicate.

              • Key — required — (String)

                Name of the object key.

              • Value — required — (String)

                Value of the tag.

        • StorageClassAnalysis — required — (map)

          Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

          • DataExport — (map)

            Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.

            • OutputSchemaVersion — required — (String)

              The version of the output schema to use when exporting data. Must be V_1.

              Possible values include:
              • "V_1"
            • Destination — required — (map)

              The place to store the data for an analysis.

              • S3BucketDestination — required — (map)

                A destination signifying output to an S3 bucket.

                • Format — required — (String)

                  Specifies the file format used when exporting data to Amazon S3.

                  Possible values include:
                  • "CSV"
                • BucketAccountId — (String)

                  The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

                  Note: Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
                • Bucket — required — (String)

                  The Amazon Resource Name (ARN) of the bucket to which data is exported.

                • Prefix — (String)

                  The prefix to use when exporting data. The prefix is prepended to all results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketCors(params = {}, callback) ⇒ AWS.Request

Returns the cors configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

For more information about cors, see Enabling Cross-Origin Resource Sharing.

The following operations are related to GetBucketCors:

Service Reference:

Examples:

To get cors configuration set on a bucket


/* The following example returns cross-origin resource sharing (CORS) configuration set on a bucket. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.getBucketCors(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CORSRules: [
       {
      AllowedHeaders: [
         "Authorization"
      ], 
      AllowedMethods: [
         "GET"
      ], 
      AllowedOrigins: [
         "*"
      ], 
      MaxAgeSeconds: 3000
     }
    ]
   }
   */
 });

Calling the getBucketCors operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketCors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name for which to get the cors configuration.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CORSRules — (Array<map>)

        A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

        • ID — (String)

          Unique identifier for the rule. The value cannot be longer than 255 characters.

        • AllowedHeaders — (Array<String>)

          Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

        • AllowedMethods — required — (Array<String>)

          An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.

        • AllowedOrigins — required — (Array<String>)

          One or more origins you want customers to be able to access the bucket from.

        • ExposeHeaders — (Array<String>)

          One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

        • MaxAgeSeconds — (Integer)

          The time in seconds that your browser is to cache the preflight response for the specified resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketEncryption(params = {}, callback) ⇒ AWS.Request

Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not have a default encryption configuration, GetBucketEncryption returns ServerSideEncryptionConfigurationNotFoundError.

For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.

To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to GetBucketEncryption:

Service Reference:

Examples:

Calling the getBucketEncryption operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketEncryption(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket from which the server-side encryption configuration is retrieved.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServerSideEncryptionConfiguration — (map)

        Specifies the default server-side-encryption configuration.

        • Rules — required — (Array<map>)

          Container for information about a particular server-side encryption configuration rule.

          • ApplyServerSideEncryptionByDefault — (map)

            Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.

            • SSEAlgorithm — required — (String)

              Server-side encryption algorithm to use for the default encryption.

              Possible values include:
              • "AES256"
              • "aws:kms"
            • KMSMasterKeyID — (String)

              Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

              You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account operations, you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

              For example:

              • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

              • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

              Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

          • BucketKeyEnabled — (Boolean)

            Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.

            For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketIntelligentTieringConfiguration(params = {}, callback) ⇒ AWS.Request

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in two low latency and high throughput access tiers. For data that can be accessed asynchronously, you can choose to activate automatic archiving capabilities within the S3 Intelligent-Tiering storage class.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to GetBucketIntelligentTieringConfiguration include:

Service Reference:

Examples:

Calling the getBucketIntelligentTieringConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE' /* required */
};
s3.getBucketIntelligentTieringConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

    • Id — (String)

      The ID used to identify the S3 Intelligent-Tiering configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IntelligentTieringConfiguration — (map)

        Container for S3 Intelligent-Tiering configuration.

        • Id — required — (String)

          The ID used to identify the S3 Intelligent-Tiering configuration.

        • Filter — (map)

          Specifies a bucket filter. The configuration only includes objects that meet the filter's criteria.

          • Prefix — (String)

            An object key name prefix that identifies the subset of objects to which the rule applies.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

          • Tag — (map)

            A container of a key value name pair.

            • Key — required — (String)

              Name of the object key.

            • Value — required — (String)

              Value of the tag.

          • And — (map)

            A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

            • Prefix — (String)

              An object key name prefix that identifies the subset of objects to which the configuration applies.

            • Tags — (Array<map>)

              All of these tags must exist in the object's tag set in order for the configuration to apply.

              • Key — required — (String)

                Name of the object key.

              • Value — required — (String)

                Value of the tag.

        • Status — required — (String)

          Specifies the status of the configuration.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • Tierings — required — (Array<map>)

          Specifies the S3 Intelligent-Tiering storage class tier of the configuration.

          • Days — required — (Integer)

            The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).

          • AccessTier — required — (String)

            S3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class.

            Possible values include:
            • "ARCHIVE_ACCESS"
            • "DEEP_ARCHIVE_ACCESS"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketInventoryConfiguration(params = {}, callback) ⇒ AWS.Request

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

The following operations are related to GetBucketInventoryConfiguration:

Service Reference:

Examples:

Calling the getBucketInventoryConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketInventoryConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket containing the inventory configuration to retrieve.

    • Id — (String)

      The ID used to identify the inventory configuration.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InventoryConfiguration — (map)

        Specifies the inventory configuration.

        • Destination — required — (map)

          Contains information about where to publish the inventory results.

          • S3BucketDestination — required — (map)

            Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

            • AccountId — (String)

              The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

              Note: Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
            • Bucket — required — (String)

              The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

            • Format — required — (String)

              Specifies the output format of the inventory results.

              Possible values include:
              • "CSV"
              • "ORC"
              • "Parquet"
            • Prefix — (String)

              The prefix that is prepended to all inventory results.

            • Encryption — (map)

              Contains the type of server-side encryption used to encrypt the inventory results.

              • SSES3 — (map)

                Specifies the use of SSE-S3 to encrypt delivered inventory reports.

              • SSEKMS — (map)

                Specifies the use of SSE-KMS to encrypt delivered inventory reports.

                • KeyId — required — (String)

                  Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting inventory reports.

        • IsEnabled — required — (Boolean)

          Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

        • Filter — (map)

          Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

          • Prefix — required — (String)

            The prefix that an object must have to be included in the inventory results.

        • Id — required — (String)

          The ID used to identify the inventory configuration.

        • IncludedObjectVersions — required — (String)

          Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

          Possible values include:
          • "All"
          • "Current"
        • OptionalFields — (Array<String>)

          Contains the optional fields that are included in the inventory results.

        • Schedule — required — (map)

          Specifies the schedule for generating inventory results.

          • Frequency — required — (String)

            Specifies how frequently inventory results are produced.

            Possible values include:
            • "Daily"
            • "Weekly"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketLifecycle(params = {}, callback) ⇒ AWS.Request

For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter element, you should see the updated version of this topic. This topic is provided for backward compatibility.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

GetBucketLifecycle has the following special error:

  • Error code: NoSuchLifecycleConfiguration

    • Description: The lifecycle configuration does not exist.

    • HTTP Status Code: 404 Not Found

    • SOAP Fault Code Prefix: Client

The following operations are related to GetBucketLifecycle:

Service Reference:

Examples:

To get a bucket acl


/* The following example gets ACL on the specified bucket. */

 var params = {
  Bucket: "acl1"
 };
 s3.getBucketLifecycle(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Rules: [
       {
      Expiration: {
       Days: 1
      }, 
      ID: "delete logs", 
      Prefix: "123/", 
      Status: "Enabled"
     }
    ]
   }
   */
 });

Calling the getBucketLifecycle operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketLifecycle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which to get the lifecycle information.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Rules — (Array<map>)

        Container for a lifecycle rule.

        • Expiration — (map)

          Specifies the expiration for the lifecycle of the object.

          • Date — (Date)

            Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.

          • Days — (Integer)

            Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

          • ExpiredObjectDeleteMarker — (Boolean)

            Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

        • ID — (String)

          Unique identifier for the rule. The value can't be longer than 255 characters.

        • Prefix — required — (String)

          Object key prefix that identifies one or more objects to which this rule applies.

          Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

        • Status — required — (String)

          If Enabled, the rule is currently being applied. If Disabled, the rule is not currently being applied.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • Transition — (map)

          Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

          • Date — (Date)

            Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

          • Days — (Integer)

            Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

          • StorageClass — (String)

            The storage class to which you want the object to transition.

            Possible values include:
            • "GLACIER"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
        • NoncurrentVersionTransition — (map)

          Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.

          • NoncurrentDays — (Integer)

            Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.

          • StorageClass — (String)

            The class of storage used to store the object.

            Possible values include:
            • "GLACIER"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
        • NoncurrentVersionExpiration — (map)

          Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

        • AbortIncompleteMultipartUpload — (map)

          Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide.

          • DaysAfterInitiation — (Integer)

            Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketLifecycleConfiguration(params = {}, callback) ⇒ AWS.Request

Note: Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, see GetBucketLifecycle.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

GetBucketLifecycleConfiguration has the following special error:

  • Error code: NoSuchLifecycleConfiguration

    • Description: The lifecycle configuration does not exist.

    • HTTP Status Code: 404 Not Found

    • SOAP Fault Code Prefix: Client

The following operations are related to GetBucketLifecycleConfiguration:

Service Reference:

Examples:

To get lifecycle configuration on a bucket


/* The following example retrieves lifecycle configuration on set on a bucket.  */

 var params = {
  Bucket: "examplebucket"
 };
 s3.getBucketLifecycleConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Rules: [
       {
      ID: "Rule for TaxDocs/", 
      Prefix: "TaxDocs", 
      Status: "Enabled", 
      Transitions: [
         {
        Days: 365, 
        StorageClass: "STANDARD_IA"
       }
      ]
     }
    ]
   }
   */
 });

Calling the getBucketLifecycleConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketLifecycleConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which to get the lifecycle information.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Rules — (Array<map>)

        Container for a lifecycle rule.

        • Expiration — (map)

          Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

          • Date — (Date)

            Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.

          • Days — (Integer)

            Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

          • ExpiredObjectDeleteMarker — (Boolean)

            Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

        • ID — (String)

          Unique identifier for the rule. The value cannot be longer than 255 characters.

        • Prefix — (String)

          Prefix identifying one or more objects to which the rule applies. This is no longer used; use Filter instead.

          Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

        • Filter — (map)

          The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified. Filter is required if the LifecycleRule does not containt a Prefix element.

          • Prefix — (String)

            Prefix identifying one or more objects to which the rule applies.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

          • Tag — (map)

            This tag must exist in the object's tag set in order for the rule to apply.

            • Key — required — (String)

              Name of the object key.

            • Value — required — (String)

              Value of the tag.

          • And — (map)

            This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.

            • Prefix — (String)

              Prefix identifying one or more objects to which the rule applies.

            • Tags — (Array<map>)

              All of these tags must exist in the object's tag set in order for the rule to apply.

              • Key — required — (String)

                Name of the object key.

              • Value — required — (String)

                Value of the tag.

        • Status — required — (String)

          If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • Transitions — (Array<map>)

          Specifies when an Amazon S3 object transitions to a specified storage class.

          • Date — (Date)

            Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

          • Days — (Integer)

            Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

          • StorageClass — (String)

            The storage class to which you want the object to transition.

            Possible values include:
            • "GLACIER"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
        • NoncurrentVersionTransitions — (Array<map>)

          Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

          • NoncurrentDays — (Integer)

            Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.

          • StorageClass — (String)

            The class of storage used to store the object.

            Possible values include:
            • "GLACIER"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
        • NoncurrentVersionExpiration — (map)

          Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

        • AbortIncompleteMultipartUpload — (map)

          Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide.

          • DaysAfterInitiation — (Integer)

            Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketLocation(params = {}, callback) ⇒ AWS.Request

Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint request parameter in a CreateBucket request. For more information, see CreateBucket.

To use this implementation of the operation, you must be the bucket owner.

To use this API against an access point, provide the alias of the access point in place of the bucket name.

The following operations are related to GetBucketLocation:

Service Reference:

Examples:

To get bucket location


/* The following example returns bucket location. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.getBucketLocation(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LocationConstraint: "us-west-2"
   }
   */
 });

Calling the getBucketLocation operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketLocation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which to get the location.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LocationConstraint — (String)

        Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints. Buckets in Region us-east-1 have a LocationConstraint of null.

        Possible values include:
        • "af-south-1"
        • "ap-east-1"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "ap-northeast-3"
        • "ap-south-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ca-central-1"
        • "cn-north-1"
        • "cn-northwest-1"
        • "EU"
        • "eu-central-1"
        • "eu-north-1"
        • "eu-south-1"
        • "eu-west-1"
        • "eu-west-2"
        • "eu-west-3"
        • "me-south-1"
        • "sa-east-1"
        • "us-east-2"
        • "us-gov-east-1"
        • "us-gov-west-1"
        • "us-west-1"
        • "us-west-2"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketLogging(params = {}, callback) ⇒ AWS.Request

Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.

The following operations are related to GetBucketLogging:

Service Reference:

Examples:

Calling the getBucketLogging operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketLogging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name for which to get the logging information.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LoggingEnabled — (map)

        Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference.

        • TargetBucket — required — (String)

          Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.

        • TargetGrants — (Array<map>)

          Container for granting information.

          • Grantee — (map)

            Container for the person being granted permissions.

            • DisplayName — (String)

              Screen name of the grantee.

            • EmailAddress — (String)

              Email address of the grantee.

              Note: Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
              • US East (N. Virginia)
              • US West (N. California)
              • US West (Oregon)
              • Asia Pacific (Singapore)
              • Asia Pacific (Sydney)
              • Asia Pacific (Tokyo)
              • Europe (Ireland)
              • South America (São Paulo)
              For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
            • ID — (String)

              The canonical user ID of the grantee.

            • Type — required — (String)

              Type of grantee

              Possible values include:
              • "CanonicalUser"
              • "AmazonCustomerByEmail"
              • "Group"
            • URI — (String)

              URI of the grantee group.

          • Permission — (String)

            Logging permissions assigned to the grantee for the bucket.

            Possible values include:
            • "FULL_CONTROL"
            • "READ"
            • "WRITE"
        • TargetPrefix — required — (String)

          A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketMetricsConfiguration(params = {}, callback) ⇒ AWS.Request

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to GetBucketMetricsConfiguration:

Service Reference:

Examples:

Calling the getBucketMetricsConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketMetricsConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket containing the metrics configuration to retrieve.

    • Id — (String)

      The ID used to identify the metrics configuration.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MetricsConfiguration — (map)

        Specifies the metrics configuration.

        • Id — required — (String)

          The ID used to identify the metrics configuration.

        • Filter — (map)

          Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).

          • Prefix — (String)

            The prefix used when evaluating a metrics filter.

          • Tag — (map)

            The tag used when evaluating a metrics filter.

            • Key — required — (String)

              Name of the object key.

            • Value — required — (String)

              Value of the tag.

          • AccessPointArn — (String)

            The access point ARN used when evaluating a metrics filter.

          • And — (map)

            A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

            • Prefix — (String)

              The prefix used when evaluating an AND predicate.

            • Tags — (Array<map>)

              The list of tags used when evaluating an AND predicate.

              • Key — required — (String)

                Name of the object key.

              • Value — required — (String)

                Value of the tag.

            • AccessPointArn — (String)

              The access point ARN used when evaluating an AND predicate.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketNotification(params = {}, callback) ⇒ AWS.Request

No longer used, see GetBucketNotificationConfiguration.

Service Reference:

Examples:

To get notification configuration set on a bucket


/* The following example returns notification configuration set on a bucket. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.getBucketNotification(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    QueueConfiguration: {
     Event: "s3:ObjectCreated:Put", 
     Events: [
        "s3:ObjectCreated:Put"
     ], 
     Id: "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx", 
     Queue: "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue"
    }, 
    TopicConfiguration: {
     Event: "s3:ObjectCreated:Copy", 
     Events: [
        "s3:ObjectCreated:Copy"
     ], 
     Id: "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi", 
     Topic: "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic"
    }
   }
   */
 });

To get notification configuration set on a bucket


/* The following example returns notification configuration set on a bucket. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.getBucketNotification(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    QueueConfiguration: {
     Event: "s3:ObjectCreated:Put", 
     Events: [
        "s3:ObjectCreated:Put"
     ], 
     Id: "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx", 
     Queue: "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue"
    }, 
    TopicConfiguration: {
     Event: "s3:ObjectCreated:Copy", 
     Events: [
        "s3:ObjectCreated:Copy"
     ], 
     Id: "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi", 
     Topic: "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic"
    }
   }
   */
 });

Calling the getBucketNotification operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketNotification(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which to get the notification configuration.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TopicConfiguration — (map)

        This data type is deprecated. A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

        • Id — (String)

          An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        • Events — (Array<String>)

          A collection of events related to objects

        • Event — (String)

          Bucket event for which to send notifications.

          Possible values include:
          • "s3:ReducedRedundancyLostObject"
          • "s3:ObjectCreated:*"
          • "s3:ObjectCreated:Put"
          • "s3:ObjectCreated:Post"
          • "s3:ObjectCreated:Copy"
          • "s3:ObjectCreated:CompleteMultipartUpload"
          • "s3:ObjectRemoved:*"
          • "s3:ObjectRemoved:Delete"
          • "s3:ObjectRemoved:DeleteMarkerCreated"
          • "s3:ObjectRestore:*"
          • "s3:ObjectRestore:Post"
          • "s3:ObjectRestore:Completed"
          • "s3:Replication:*"
          • "s3:Replication:OperationFailedReplication"
          • "s3:Replication:OperationNotTracked"
          • "s3:Replication:OperationMissedThreshold"
          • "s3:Replication:OperationReplicatedAfterThreshold"
        • Topic — (String)

          Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.

      • QueueConfiguration — (map)

        This data type is deprecated. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

        • Id — (String)

          An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        • Event — (String)

          The bucket event for which to send notifications.

          Possible values include:
          • "s3:ReducedRedundancyLostObject"
          • "s3:ObjectCreated:*"
          • "s3:ObjectCreated:Put"
          • "s3:ObjectCreated:Post"
          • "s3:ObjectCreated:Copy"
          • "s3:ObjectCreated:CompleteMultipartUpload"
          • "s3:ObjectRemoved:*"
          • "s3:ObjectRemoved:Delete"
          • "s3:ObjectRemoved:DeleteMarkerCreated"
          • "s3:ObjectRestore:*"
          • "s3:ObjectRestore:Post"
          • "s3:ObjectRestore:Completed"
          • "s3:Replication:*"
          • "s3:Replication:OperationFailedReplication"
          • "s3:Replication:OperationNotTracked"
          • "s3:Replication:OperationMissedThreshold"
          • "s3:Replication:OperationReplicatedAfterThreshold"
        • Events — (Array<String>)

          A collection of bucket events for which to send notifications.

        • Queue — (String)

          The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

      • CloudFunctionConfiguration — (map)

        Container for specifying the Lambda notification configuration.

        • Id — (String)

          An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        • Event — (String)

          The bucket event for which to send notifications.

          Possible values include:
          • "s3:ReducedRedundancyLostObject"
          • "s3:ObjectCreated:*"
          • "s3:ObjectCreated:Put"
          • "s3:ObjectCreated:Post"
          • "s3:ObjectCreated:Copy"
          • "s3:ObjectCreated:CompleteMultipartUpload"
          • "s3:ObjectRemoved:*"
          • "s3:ObjectRemoved:Delete"
          • "s3:ObjectRemoved:DeleteMarkerCreated"
          • "s3:ObjectRestore:*"
          • "s3:ObjectRestore:Post"
          • "s3:ObjectRestore:Completed"
          • "s3:Replication:*"
          • "s3:Replication:OperationFailedReplication"
          • "s3:Replication:OperationNotTracked"
          • "s3:Replication:OperationMissedThreshold"
          • "s3:Replication:OperationReplicatedAfterThreshold"
        • Events — (Array<String>)

          Bucket events for which to send notifications.

        • CloudFunction — (String)

          Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.

        • InvocationRole — (String)

          The role supporting the invocation of the Lambda function

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketNotificationConfiguration(params = {}, callback) ⇒ AWS.Request

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration element.

By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.

The following action is related to GetBucketNotification:

Service Reference:

Examples:

Calling the getBucketNotificationConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketNotificationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which to get the notification configuration.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TopicConfigurations — (Array<map>)

        The topic to which notifications are sent and the events for which notifications are generated.

        • Id — (String)

          An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        • TopicArn — required — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.

        • Events — required — (Array<String>)

          The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon S3 User Guide.

        • Filter — (map)

          Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon S3 User Guide.

          • Key — (map)

            A container for object key name prefix and suffix filtering rules.

            • FilterRules — (Array<map>)

              A list of containers for the key-value pair that defines the criteria for the filter rule.

              • Name — (String)

                The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.

                Possible values include:
                • "prefix"
                • "suffix"
              • Value — (String)

                The value that the filter searches for in object key names.

      • QueueConfigurations — (Array<map>)

        The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.

        • Id — (String)

          An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        • QueueArn — required — (String)

          The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

        • Events — required — (Array<String>)

          A collection of bucket events for which to send notifications

        • Filter — (map)

          Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon S3 User Guide.

          • Key — (map)

            A container for object key name prefix and suffix filtering rules.

            • FilterRules — (Array<map>)

              A list of containers for the key-value pair that defines the criteria for the filter rule.

              • Name — (String)

                The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.

                Possible values include:
                • "prefix"
                • "suffix"
              • Value — (String)

                The value that the filter searches for in object key names.

      • LambdaFunctionConfigurations — (Array<map>)

        Describes the Lambda functions to invoke and the events for which to invoke them.

        • Id — (String)

          An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        • LambdaFunctionArn — required — (String)

          The Amazon Resource Name (ARN) of the Lambda function that Amazon S3 invokes when the specified event type occurs.

        • Events — required — (Array<String>)

          The Amazon S3 bucket event for which to invoke the Lambda function. For more information, see Supported Event Types in the Amazon S3 User Guide.

        • Filter — (map)

          Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon S3 User Guide.

          • Key — (map)

            A container for object key name prefix and suffix filtering rules.

            • FilterRules — (Array<map>)

              A list of containers for the key-value pair that defines the criteria for the filter rule.

              • Name — (String)

                The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.

                Possible values include:
                • "prefix"
                • "suffix"
              • Value — (String)

                The value that the filter searches for in object key names.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketOwnershipControls(params = {}, callback) ⇒ AWS.Request

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to GetBucketOwnershipControls:

Service Reference:

Examples:

Calling the getBucketOwnershipControls operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketOwnershipControls(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OwnershipControls — (map)

        The OwnershipControls (BucketOwnerPreferred or ObjectWriter) currently in effect for this Amazon S3 bucket.

        • Rules — required — (Array<map>)

          The container element for an ownership control rule.

          • ObjectOwnership — required — (String)

            The container element for object ownership for a bucket's ownership controls.

            BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.

            ObjectWriter - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.

            Possible values include:
            • "BucketOwnerPreferred"
            • "ObjectWriter"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketPolicy(params = {}, callback) ⇒ AWS.Request

Returns the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

The following action is related to GetBucketPolicy:

Service Reference:

Examples:

To get bucket policy


/* The following example returns bucket policy associated with a bucket. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.getBucketPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Policy: "{\"Version\":\"2008-10-17\",\"Id\":\"LogPolicy\",\"Statement\":[{\"Sid\":\"Enables the log delivery group to publish logs to your bucket \",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"111122223333\"},\"Action\":[\"s3:GetBucketAcl\",\"s3:GetObjectAcl\",\"s3:PutObject\"],\"Resource\":[\"arn:aws:s3:::policytest1/*\",\"arn:aws:s3:::policytest1\"]}]}"
   }
   */
 });

Calling the getBucketPolicy operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name for which to get the bucket policy.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (String)

        The bucket policy as a JSON document.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketPolicyStatus(params = {}, callback) ⇒ AWS.Request

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".

The following operations are related to GetBucketPolicyStatus:

Service Reference:

Examples:

Calling the getBucketPolicyStatus operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketPolicyStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the Amazon S3 bucket whose policy status you want to retrieve.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PolicyStatus — (map)

        The policy status for the specified bucket.

        • IsPublic — (Boolean)

          The policy status for this bucket. TRUE indicates that this bucket is public. FALSE indicates that the bucket is not public.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketReplication(params = {}, callback) ⇒ AWS.Request

Returns the replication configuration of a bucket.

Note: It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

For information about replication configuration, see Replication in the Amazon S3 User Guide.

This action requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies.

If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication and Priority elements. The response also returns those elements.

For information about GetBucketReplication errors, see List of replication-related error codes

The following operations are related to GetBucketReplication:

Service Reference:

Examples:

To get replication configuration set on a bucket


/* The following example returns replication configuration set on a bucket. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.getBucketReplication(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ReplicationConfiguration: {
     Role: "arn:aws:iam::acct-id:role/example-role", 
     Rules: [
        {
       Destination: {
        Bucket: "arn:aws:s3:::destination-bucket"
       }, 
       ID: "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy", 
       Prefix: "Tax", 
       Status: "Enabled"
      }
     ]
    }
   }
   */
 });

Calling the getBucketReplication operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketReplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name for which to get the replication information.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReplicationConfiguration — (map)

        A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

        • Role — required — (String)

          The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Replication in the Amazon S3 User Guide.

        • Rules — required — (Array<map>)

          A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.

          • ID — (String)

            A unique identifier for the rule. The maximum value is 255 characters.

          • Priority — (Integer)

            The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

            For more information, see Replication in the Amazon S3 User Guide.

          • Prefix — (String)

            An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

          • Filter — (map)

            A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix, Tag, or an And child element.

            • Prefix — (String)

              An object key name prefix that identifies the subset of objects to which the rule applies.

              Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

            • Tag — (map)

              A container for specifying a tag key and value.

              The rule applies only to objects that have the tag in their tag set.

              • Key — required — (String)

                Name of the object key.

              • Value — required — (String)

                Value of the tag.

            • And — (map)

              A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example:

              • If you specify both a Prefix and a Tag filter, wrap these filters in an And tag.

              • If you specify a filter based on multiple tags, wrap the Tag elements in an And tag.

              • Prefix — (String)

                An object key name prefix that identifies the subset of objects to which the rule applies.

              • Tags — (Array<map>)

                An array of tags containing key and value pairs.

                • Key — required — (String)

                  Name of the object key.

                • Value — required — (String)

                  Value of the tag.

          • Status — required — (String)

            Specifies whether the rule is enabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
          • SourceSelectionCriteria — (map)

            A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

            • SseKmsEncryptedObjects — (map)

              A container for filter information for the selection of Amazon S3 objects encrypted with Amazon Web Services KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required.

              • Status — required — (String)

                Specifies whether Amazon S3 replicates objects created with server-side encryption using an Amazon Web Services KMS key stored in Amazon Web Services Key Management Service.

                Possible values include:
                • "Enabled"
                • "Disabled"
            • ReplicaModifications — (map)

              A filter that you can specify for selections for modifications on replicas. Amazon S3 doesn't replicate replica modifications by default. In the latest version of replication configuration (when Filter is specified), you can specify this element and set the status to Enabled to replicate modifications on replicas.

              Note: If you don't specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed
              • Status — required — (String)

                Specifies whether Amazon S3 replicates modifications on replicas.

                Possible values include:
                • "Enabled"
                • "Disabled"
          • ExistingObjectReplication — (map)

            • Status — required — (String)

              Possible values include:

              • "Enabled"
              • "Disabled"
          • Destination — required — (map)

            A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).

            • Bucket — required — (String)

              The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.

            • Account — (String)

              Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the Amazon Web Services account that owns the destination bucket by specifying the AccessControlTranslation property, this is the account ID of the destination bucket owner. For more information, see Replication Additional Configuration: Changing the Replica Owner in the Amazon S3 User Guide.

            • StorageClass — (String)

              The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.

              For valid values, see the StorageClass element of the PUT Bucket replication action in the Amazon S3 API Reference.

              Possible values include:
              • "STANDARD"
              • "REDUCED_REDUNDANCY"
              • "STANDARD_IA"
              • "ONEZONE_IA"
              • "INTELLIGENT_TIERING"
              • "GLACIER"
              • "DEEP_ARCHIVE"
              • "OUTPOSTS"
            • AccessControlTranslation — (map)

              Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the Amazon Web Services account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same Amazon Web Services account that owns the source object.

              • Owner — required — (String)

                Specifies the replica ownership. For default and valid values, see PUT bucket replication in the Amazon S3 API Reference.

                Possible values include:
                • "Destination"
            • EncryptionConfiguration — (map)

              A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element.

              • ReplicaKmsKeyID — (String)

                Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key stored in Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric, customer managed KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

            • ReplicationTime — (map)

              A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a Metrics block.

              • Status — required — (String)

                Specifies whether the replication time is enabled.

                Possible values include:
                • "Enabled"
                • "Disabled"
              • Time — required — (map)

                A container specifying the time by which replication should be complete for all objects and operations on objects.

                • Minutes — (Integer)

                  Contains an integer specifying time in minutes.

                  Valid value: 15

            • Metrics — (map)

              A container specifying replication metrics-related settings enabling replication metrics and events.

              • Status — required — (String)

                Specifies whether the replication metrics are enabled.

                Possible values include:
                • "Enabled"
                • "Disabled"
              • EventThreshold — (map)

                A container specifying the time threshold for emitting the s3:Replication:OperationMissedThreshold event.

                • Minutes — (Integer)

                  Contains an integer specifying time in minutes.

                  Valid value: 15

          • DeleteMarkerReplication — (map)

            Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

            For more information about delete marker replication, see Basic Rule Configuration.

            Note: If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.
            • Status — (String)

              Indicates whether to replicate delete markers.

              Note: Indicates whether to replicate delete markers.
              Possible values include:
              • "Enabled"
              • "Disabled"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketRequestPayment(params = {}, callback) ⇒ AWS.Request

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

The following operations are related to GetBucketRequestPayment:

Service Reference:

Examples:

To get bucket versioning configuration


/* The following example retrieves bucket versioning configuration. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.getBucketRequestPayment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Payer: "BucketOwner"
   }
   */
 });

Calling the getBucketRequestPayment operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketRequestPayment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which to get the payment request configuration

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Payer — (String)

        Specifies who pays for the download and request fees.

        Possible values include:
        • "Requester"
        • "BucketOwner"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketTagging(params = {}, callback) ⇒ AWS.Request

Returns the tag set associated with the bucket.

To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:

  • Error code: NoSuchTagSetError

    • Description: There is no tag set associated with the bucket.

The following operations are related to GetBucketTagging:

Service Reference:

Examples:

To get tag set associated with a bucket


/* The following example returns tag set associated with a bucket */

 var params = {
  Bucket: "examplebucket"
 };
 s3.getBucketTagging(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TagSet: [
       {
      Key: "key1", 
      Value: "value1"
     }, 
       {
      Key: "key2", 
      Value: "value2"
     }
    ]
   }
   */
 });

Calling the getBucketTagging operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketTagging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which to get the tagging information.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TagSet — (Array<map>)

        Contains the tag set.

        • Key — required — (String)

          Name of the object key.

        • Value — required — (String)

          Value of the tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketVersioning(params = {}, callback) ⇒ AWS.Request

Returns the versioning state of a bucket.

To retrieve the versioning state of a bucket, you must be the bucket owner.

This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.

The following operations are related to GetBucketVersioning:

Service Reference:

Examples:

To get bucket versioning configuration


/* The following example retrieves bucket versioning configuration. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.getBucketVersioning(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    MFADelete: "Disabled", 
    Status: "Enabled"
   }
   */
 });

Calling the getBucketVersioning operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketVersioning(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which to get the versioning information.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (String)

        The versioning state of the bucket.

        Possible values include:
        • "Enabled"
        • "Suspended"
      • MFADelete — (String)

        Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

        Possible values include:
        • "Enabled"
        • "Disabled"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBucketWebsite(params = {}, callback) ⇒ AWS.Request

Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.

This GET action requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission.

The following operations are related to DeleteBucketWebsite:

Service Reference:

Examples:

To get bucket website configuration


/* The following example retrieves website configuration of a bucket. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.getBucketWebsite(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ErrorDocument: {
     Key: "error.html"
    }, 
    IndexDocument: {
     Suffix: "index.html"
    }
   }
   */
 });

Calling the getBucketWebsite operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getBucketWebsite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name for which to get the website configuration.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RedirectAllRequestsTo — (map)

        Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

        • HostName — required — (String)

          Name of the host where requests are redirected.

        • Protocol — (String)

          Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

          Possible values include:
          • "http"
          • "https"
      • IndexDocument — (map)

        The name of the index document for the website (for example index.html).

        • Suffix — required — (String)

          A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.

          Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

      • ErrorDocument — (map)

        The object key name of the website error document to use for 4XX class errors.

        • Key — required — (String)

          The object key name to use when a 4XX class error occurs.

          Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

      • RoutingRules — (Array<map>)

        Rules that define when a redirect is applied and the redirect behavior.

        • Condition — (map)

          A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

          • HttpErrorCodeReturnedEquals — (String)

            The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

          • KeyPrefixEquals — (String)

            The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

        • Redirect — required — (map)

          Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.

          • HostName — (String)

            The host name to use in the redirect request.

          • HttpRedirectCode — (String)

            The HTTP redirect code to use on the response. Not required if one of the siblings is present.

          • Protocol — (String)

            Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

            Possible values include:
            • "http"
            • "https"
          • ReplaceKeyPrefixWith — (String)

            The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

          • ReplaceKeyWith — (String)

            The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getObject(params = {}, callback) ⇒ AWS.Request

Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header.

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg.

To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification.

To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.

If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects.

Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

Assuming you have the relevant permission to read object tags, the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.

Permissions

You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

  • If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error.

  • If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 ("access denied") error.

Versioning

By default, the GET action returns the current version of an object. To return a different version, use the versionId subresource.

Note:
  • You need the s3:GetObjectVersion permission to access a specific version of an object.
  • If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

For more information about versioning, see PutBucketVersioning.

Overriding Response Header Values

There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.

You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters.

Note: You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.

  • response-content-type

  • response-content-language

  • response-expires

  • response-cache-control

  • response-content-disposition

  • response-content-encoding

Additional Considerations about Request Headers

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

The following operations are related to GetObject:

Service Reference:

Examples:

To retrieve an object


/* The following example retrieves an object for an S3 bucket. */

 var params = {
  Bucket: "examplebucket", 
  Key: "HappyFace.jpg"
 };
 s3.getObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AcceptRanges: "bytes", 
    ContentLength: 3191, 
    ContentType: "image/jpeg", 
    ETag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
    LastModified: <Date Representation>, 
    Metadata: {
    }, 
    TagCount: 2, 
    VersionId: "null"
   }
   */
 });

To retrieve a byte range of an object


/* The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range. */

 var params = {
  Bucket: "examplebucket", 
  Key: "SampleFile.txt", 
  Range: "bytes=0-9"
 };
 s3.getObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AcceptRanges: "bytes", 
    ContentLength: 10, 
    ContentRange: "bytes 0-9/43", 
    ContentType: "text/plain", 
    ETag: "\"0d94420ffd0bc68cd3d152506b97a9cc\"", 
    LastModified: <Date Representation>, 
    Metadata: {
    }, 
    VersionId: "null"
   }
   */
 });

Calling the getObject operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  IfMatch: 'STRING_VALUE',
  IfModifiedSince: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  IfNoneMatch: 'STRING_VALUE',
  IfUnmodifiedSince: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  PartNumber: 'NUMBER_VALUE',
  Range: 'STRING_VALUE',
  RequestPayer: requester,
  ResponseCacheControl: 'STRING_VALUE',
  ResponseContentDisposition: 'STRING_VALUE',
  ResponseContentEncoding: 'STRING_VALUE',
  ResponseContentLanguage: 'STRING_VALUE',
  ResponseContentType: 'STRING_VALUE',
  ResponseExpires: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SSECustomerKeyMD5: 'STRING_VALUE',
  VersionId: 'STRING_VALUE'
};
s3.getObject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name containing the object.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • IfMatch — (String)

      Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

    • IfModifiedSince — (Date)

      Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

    • IfNoneMatch — (String)

      Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

    • IfUnmodifiedSince — (Date)

      Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

    • Key — (String)

      Key of the object to get.

    • Range — (String)

      Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

      Note: Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
    • ResponseCacheControl — (String)

      Sets the Cache-Control header of the response.

    • ResponseContentDisposition — (String)

      Sets the Content-Disposition header of the response

    • ResponseContentEncoding — (String)

      Sets the Content-Encoding header of the response.

    • ResponseContentLanguage — (String)

      Sets the Content-Language header of the response.

    • ResponseContentType — (String)

      Sets the Content-Type header of the response.

    • ResponseExpires — (Date)

      Sets the Expires header of the response.

    • VersionId — (String)

      VersionId used to reference a specific version of the object.

    • SSECustomerAlgorithm — (String)

      Specifies the algorithm to use to when decrypting the object (for example, AES256).

    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

    • SSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • PartNumber — (Integer)

      Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Body — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

        Object data.

      • DeleteMarker — (Boolean)

        Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

      • AcceptRanges — (String)

        Indicates that a range of bytes was specified.

      • Expiration — (String)

        If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.

      • Restore — (String)

        Provides information about object restoration action and expiration time of the restored object copy.

      • LastModified — (Date)

        Creation date of the object.

      • ContentLength — (Integer)

        Size of the body in bytes.

      • ETag — (String)

        An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

      • MissingMeta — (Integer)

        This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

      • VersionId — (String)

        Version of the object.

      • CacheControl — (String)

        Specifies caching behavior along the request/reply chain.

      • ContentDisposition — (String)

        Specifies presentational information for the object.

      • ContentEncoding — (String)

        Specifies 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.

      • ContentLanguage — (String)

        The language the content is in.

      • ContentRange — (String)

        The portion of the object returned in the response.

      • ContentType — (String)

        A standard MIME type describing the format of the object data.

      • Expires — (Date)

        The date and time at which the object is no longer cacheable.

      • WebsiteRedirectLocation — (String)

        If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

      • ServerSideEncryption — (String)

        The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

        Possible values include:
        • "AES256"
        • "aws:kms"
      • Metadata — (map<String>)

        A map of metadata to store with the object in S3.

      • SSECustomerAlgorithm — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

      • SSECustomerKeyMD5 — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

      • SSEKMSKeyId — (String)

        If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

      • BucketKeyEnabled — (Boolean)

        Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

      • StorageClass — (String)

        Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

        Possible values include:
        • "STANDARD"
        • "REDUCED_REDUNDANCY"
        • "STANDARD_IA"
        • "ONEZONE_IA"
        • "INTELLIGENT_TIERING"
        • "GLACIER"
        • "DEEP_ARCHIVE"
        • "OUTPOSTS"
      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"
      • ReplicationStatus — (String)

        Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

        Possible values include:
        • "COMPLETE"
        • "PENDING"
        • "FAILED"
        • "REPLICA"
      • PartsCount — (Integer)

        The count of parts this object has.

      • TagCount — (Integer)

        The number of tags, if any, on the object.

      • ObjectLockMode — (String)

        The Object Lock mode currently in place for this object.

        Possible values include:
        • "GOVERNANCE"
        • "COMPLIANCE"
      • ObjectLockRetainUntilDate — (Date)

        The date and time when this object's Object Lock will expire.

      • ObjectLockLegalHoldStatus — (String)

        Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.

        Possible values include:
        • "ON"
        • "OFF"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getObjectAcl(params = {}, callback) ⇒ AWS.Request

Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object.

This action is not supported by Amazon S3 on Outposts.

Versioning

By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

The following operations are related to GetObjectAcl:

Service Reference:

Examples:

To retrieve object ACL


/* The following example retrieves access control list (ACL) of an object. */

 var params = {
  Bucket: "examplebucket", 
  Key: "HappyFace.jpg"
 };
 s3.getObjectAcl(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Grants: [
       {
      Grantee: {
       DisplayName: "owner-display-name", 
       ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", 
       Type: "CanonicalUser"
      }, 
      Permission: "WRITE"
     }, 
       {
      Grantee: {
       DisplayName: "owner-display-name", 
       ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", 
       Type: "CanonicalUser"
      }, 
      Permission: "WRITE_ACP"
     }, 
       {
      Grantee: {
       DisplayName: "owner-display-name", 
       ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", 
       Type: "CanonicalUser"
      }, 
      Permission: "READ"
     }, 
       {
      Grantee: {
       DisplayName: "owner-display-name", 
       ID: "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", 
       Type: "CanonicalUser"
      }, 
      Permission: "READ_ACP"
     }
    ], 
    Owner: {
     DisplayName: "owner-display-name", 
     ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
    }
   }
   */
 });

Calling the getObjectAcl operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  RequestPayer: requester,
  VersionId: 'STRING_VALUE'
};
s3.getObjectAcl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name that contains the object for which to get the ACL information.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    • Key — (String)

      The key of the object for which to get the ACL information.

    • VersionId — (String)

      VersionId used to reference a specific version of the object.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Owner — (map)

        Container for the bucket owner's display name and ID.

        • DisplayName — (String)

          Container for the display name of the owner.

        • ID — (String)

          Container for the ID of the owner.

      • Grants — (Array<map>)

        A list of grants.

        • Grantee — (map)

          The person being granted permissions.

          • DisplayName — (String)

            Screen name of the grantee.

          • EmailAddress — (String)

            Email address of the grantee.

            Note: Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
            • US East (N. Virginia)
            • US West (N. California)
            • US West (Oregon)
            • Asia Pacific (Singapore)
            • Asia Pacific (Sydney)
            • Asia Pacific (Tokyo)
            • Europe (Ireland)
            • South America (São Paulo)
            For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
          • ID — (String)

            The canonical user ID of the grantee.

          • Type — required — (String)

            Type of grantee

            Possible values include:
            • "CanonicalUser"
            • "AmazonCustomerByEmail"
            • "Group"
          • URI — (String)

            URI of the grantee group.

        • Permission — (String)

          Specifies the permission given to the grantee.

          Possible values include:
          • "FULL_CONTROL"
          • "WRITE"
          • "WRITE_ACP"
          • "READ"
          • "READ_ACP"
      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getObjectLegalHold(params = {}, callback) ⇒ AWS.Request

Gets an object's current Legal Hold status. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

Service Reference:

Examples:

Calling the getObjectLegalHold operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  RequestPayer: requester,
  VersionId: 'STRING_VALUE'
};
s3.getObjectLegalHold(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name containing the object whose Legal Hold status you want to retrieve.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    • Key — (String)

      The key name for the object whose Legal Hold status you want to retrieve.

    • VersionId — (String)

      The version ID of the object whose Legal Hold status you want to retrieve.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LegalHold — (map)

        The current Legal Hold status for the specified object.

        • Status — (String)

          Indicates whether the specified object has a Legal Hold in place.

          Possible values include:
          • "ON"
          • "OFF"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getObjectLockConfiguration(params = {}, callback) ⇒ AWS.Request

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

Service Reference:

Examples:

Calling the getObjectLockConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getObjectLockConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket whose Object Lock configuration you want to retrieve.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ObjectLockConfiguration — (map)

        The specified bucket's Object Lock configuration.

        • ObjectLockEnabled — (String)

          Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

          Possible values include:
          • "Enabled"
        • Rule — (map)

          Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

          • DefaultRetention — (map)

            The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

            • Mode — (String)

              The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.

              Possible values include:
              • "GOVERNANCE"
              • "COMPLIANCE"
            • Days — (Integer)

              The number of days that you want to specify for the default retention period. Must be used with Mode.

            • Years — (Integer)

              The number of years that you want to specify for the default retention period. Must be used with Mode.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getObjectRetention(params = {}, callback) ⇒ AWS.Request

Retrieves an object's retention settings. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

Service Reference:

Examples:

Calling the getObjectRetention operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  RequestPayer: requester,
  VersionId: 'STRING_VALUE'
};
s3.getObjectRetention(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name containing the object whose retention settings you want to retrieve.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    • Key — (String)

      The key name for the object whose retention settings you want to retrieve.

    • VersionId — (String)

      The version ID for the object whose retention settings you want to retrieve.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Retention — (map)

        The container element for an object's retention settings.

        • Mode — (String)

          Indicates the Retention mode for the specified object.

          Possible values include:
          • "GOVERNANCE"
          • "COMPLIANCE"
        • RetainUntilDate — (Date)

          The date on which this Object Lock Retention will expire.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getObjectTagging(params = {}, callback) ⇒ AWS.Request

Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

By default, the bucket owner has this permission and can grant this permission to others.

For information about the Amazon S3 object tagging feature, see Object Tagging.

The following action is related to GetObjectTagging:

Service Reference:

Examples:

To retrieve tag set of a specific object version


/* The following example retrieves tag set of an object. The request specifies object version. */

 var params = {
  Bucket: "examplebucket", 
  Key: "exampleobject", 
  VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
 };
 s3.getObjectTagging(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TagSet: [
       {
      Key: "Key1", 
      Value: "Value1"
     }
    ], 
    VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
   }
   */
 });

To retrieve tag set of an object


/* The following example retrieves tag set of an object. */

 var params = {
  Bucket: "examplebucket", 
  Key: "HappyFace.jpg"
 };
 s3.getObjectTagging(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TagSet: [
       {
      Key: "Key4", 
      Value: "Value4"
     }, 
       {
      Key: "Key3", 
      Value: "Value3"
     }
    ], 
    VersionId: "null"
   }
   */
 });

Calling the getObjectTagging operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  RequestPayer: requester,
  VersionId: 'STRING_VALUE'
};
s3.getObjectTagging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name containing the object for which to get the tagging information.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • Key — (String)

      Object key for which to get the tagging information.

    • VersionId — (String)

      The versionId of the object for which to get the tagging information.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VersionId — (String)

        The versionId of the object for which you got the tagging information.

      • TagSet — (Array<map>)

        Contains the tag set.

        • Key — required — (String)

          Name of the object key.

        • Value — required — (String)

          Value of the tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getObjectTorrent(params = {}, callback) ⇒ AWS.Request

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.

Note: You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.

To use GET, you must have READ access to the object.

This action is not supported by Amazon S3 on Outposts.

The following action is related to GetObjectTorrent:

Service Reference:

Examples:

To retrieve torrent files for an object


/* The following example retrieves torrent files of an object. */

 var params = {
  Bucket: "examplebucket", 
  Key: "HappyFace.jpg"
 };
 s3.getObjectTorrent(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the getObjectTorrent operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  RequestPayer: requester
};
s3.getObjectTorrent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket containing the object for which to get the torrent files.

    • Key — (String)

      The object key for which to get the information.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Body — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

        A Bencoded dictionary as defined by the BitTorrent specification

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getPublicAccessBlock(params = {}, callback) ⇒ AWS.Request

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".

The following operations are related to GetPublicAccessBlock:

Service Reference:

Examples:

Calling the getPublicAccessBlock operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.getPublicAccessBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PublicAccessBlockConfiguration — (map)

        The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.

        • BlockPublicAcls — (Boolean)

          Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior:

          • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

          • PUT Object calls fail if the request includes a public ACL.

          • PUT Bucket calls fail if the request includes a public ACL.

          Enabling this setting doesn't affect existing policies or ACLs.

        • IgnorePublicAcls — (Boolean)

          Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.

          Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

        • BlockPublicPolicy — (Boolean)

          Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

          Enabling this setting doesn't affect existing bucket policies.

        • RestrictPublicBuckets — (Boolean)

          Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only Amazon Web Service principals and authorized users within this account if the bucket has a public policy.

          Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSignedUrl(operation, params, callback) ⇒ String?

Note:

You must ensure that you have static or previously resolved credentials if you call this method synchronously (with no callback), otherwise it may not properly sign the request. If you cannot guarantee this (you are using an asynchronous credential provider, i.e., EC2 IAM roles), you should always call this method with an asynchronous callback.

Note:

Not all operation parameters are supported when using pre-signed URLs. Certain parameters, such as SSECustomerKey, ACL, Expires, ContentLength, or Tagging must be provided as headers when sending a request. If you are using pre-signed URLs to upload from a browser and need to use these fields, see createPresignedPost().

Note:

The default signer allows altering the request by adding corresponding headers to set some parameters (e.g. Range) and these added parameters won't be signed. You must use signatureVersion v4 to to include these parameters in the signed portion of the URL and enforce exact matching between headers and signed params in the URL.

Note:

This operation cannot be used with a promise. See note above regarding asynchronous credentials and use with a callback.

Get a pre-signed URL for a given operation name.

Examples:

Pre-signing a getObject operation (synchronously)

var params = {Bucket: 'bucket', Key: 'key'};
var url = s3.getSignedUrl('getObject', params);
console.log('The URL is', url);

Pre-signing a putObject (asynchronously)

var params = {Bucket: 'bucket', Key: 'key'};
s3.getSignedUrl('putObject', params, function (err, url) {
  console.log('The URL is', url);
});

Pre-signing a putObject operation with a specific payload

var params = {Bucket: 'bucket', Key: 'key', Body: 'body'};
var url = s3.getSignedUrl('putObject', params);
console.log('The URL is', url);

Passing in a 1-minute expiry time for a pre-signed URL

var params = {Bucket: 'bucket', Key: 'key', Expires: 60};
var url = s3.getSignedUrl('getObject', params);
console.log('The URL is', url); // expires in 60 seconds

Parameters:

  • operation (String) —

    the name of the operation to call

  • params (map) —

    parameters to pass to the operation. See the given operation for the expected operation parameters. In addition, you can also pass the "Expires" parameter to inform S3 how long the URL should work for.

  • callback (Function) —

    if a callback is provided, this function will pass the URL as the second parameter (after the error parameter) to the callback function.

Options Hash (params):

  • Expires (Integer) — default: 900 —

    the number of seconds to expire the pre-signed URL operation in. Defaults to 15 minutes.

Returns:

  • (String) —

    if called synchronously (with no callback), returns the signed URL.

  • (null) —

    nothing is returned if a callback is provided.

getSignedUrlPromise() ⇒ Promise

Note:

Not all operation parameters are supported when using pre-signed URLs. Certain parameters, such as SSECustomerKey, ACL, Expires, ContentLength, or Tagging must be provided as headers when sending a request. If you are using pre-signed URLs to upload from a browser and need to use these fields, see createPresignedPost().

Returns a 'thenable' promise that will be resolved with a pre-signed URL for a given operation name.

Two callbacks can be provided to the then method on the returned promise. The first callback will be called if the promise is fulfilled, and the second callback will be called if the promise is rejected.

Examples:

Pre-signing a getObject operation

var params = {Bucket: 'bucket', Key: 'key'};
var promise = s3.getSignedUrlPromise('getObject', params);
promise.then(function(url) {
  console.log('The URL is', url);
}, function(err) { ... });

Pre-signing a putObject operation with a specific payload

var params = {Bucket: 'bucket', Key: 'key', Body: 'body'};
var promise = s3.getSignedUrlPromise('putObject', params);
promise.then(function(url) {
  console.log('The URL is', url);
}, function(err) { ... });

Passing in a 1-minute expiry time for a pre-signed URL

var params = {Bucket: 'bucket', Key: 'key', Expires: 60};
var promise = s3.getSignedUrlPromise('getObject', params);
promise.then(function(url) {
  console.log('The URL is', url);
}, function(err) { ... });

Parameters:

  • operation (String) —

    the name of the operation to call

  • params (map) —

    parameters to pass to the operation. See the given operation for the expected operation parameters. In addition, you can also pass the "Expires" parameter to inform S3 how long the URL should work for.

Callbacks:

  • function(url) { ... }

    Called if the promise is fulfilled.

    Parameters:

    • url (String) —

      the signed url

  • function(err) { ... }

    Called if the promise is rejected.

    Parameters:

    • err (Error) —

      if an error occurred, this value will be filled

Returns:

  • (Promise) —

    A promise that represents the state of the refresh call.

headBucket(params = {}, callback) ⇒ AWS.Request

This action is useful to determine if a bucket exists and you have permission to access it. The action returns a 200 OK if the bucket exists and you have permission to access it.

If the bucket does not exist or you do not have permission to access it, the HEAD request returns a generic 404 Not Found or 403 Forbidden code. A message body is not included, so you cannot determine the exception beyond these error codes.

To use this operation, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, Using access points.

Service Reference:

Examples:

To determine if bucket exists


/* This operation checks to see if a bucket exists. */

 var params = {
  Bucket: "acl1"
 };
 s3.headBucket(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the headBucket operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.headBucket(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

headObject(params = {}, callback) ⇒ AWS.Request

The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.

A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

Note:
  • Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
  • The last modified property in this case is the creation date of the object.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

Consider the following when using request headers:

  • Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

    • If-Match condition evaluates to true, and;

    • If-Unmodified-Since condition evaluates to false;

    Then Amazon S3 returns 200 OK and the data requested.

  • Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

    • If-None-Match condition evaluates to false, and;

    • If-Modified-Since condition evaluates to true;

    Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Permissions

You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

  • If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 ("no such key") error.

  • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 ("access denied") error.

The following action is related to HeadObject:

Service Reference:

Examples:

To retrieve metadata of an object without returning the object itself


/* The following example retrieves an object metadata. */

 var params = {
  Bucket: "examplebucket", 
  Key: "HappyFace.jpg"
 };
 s3.headObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AcceptRanges: "bytes", 
    ContentLength: 3191, 
    ContentType: "image/jpeg", 
    ETag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
    LastModified: <Date Representation>, 
    Metadata: {
    }, 
    VersionId: "null"
   }
   */
 });

Calling the headObject operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  IfMatch: 'STRING_VALUE',
  IfModifiedSince: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  IfNoneMatch: 'STRING_VALUE',
  IfUnmodifiedSince: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  PartNumber: 'NUMBER_VALUE',
  Range: 'STRING_VALUE',
  RequestPayer: requester,
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SSECustomerKeyMD5: 'STRING_VALUE',
  VersionId: 'STRING_VALUE'
};
s3.headObject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket containing the object.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • IfMatch — (String)

      Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

    • IfModifiedSince — (Date)

      Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

    • IfNoneMatch — (String)

      Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

    • IfUnmodifiedSince — (Date)

      Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

    • Key — (String)

      The object key.

    • Range — (String)

      Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

      Note: Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
    • VersionId — (String)

      VersionId used to reference a specific version of the object.

    • SSECustomerAlgorithm — (String)

      Specifies the algorithm to use to when encrypting the object (for example, AES256).

    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 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.

    • SSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • PartNumber — (Integer)

      Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeleteMarker — (Boolean)

        Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

      • AcceptRanges — (String)

        Indicates that a range of bytes was specified.

      • Expiration — (String)

        If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.

      • Restore — (String)

        If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

        If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

        x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

        If the object restoration is in progress, the header returns the value ongoing-request="true".

        For more information about archiving objects, see Transitioning Objects: General Considerations.

      • ArchiveStatus — (String)

        The archive state of the head object.

        Possible values include:
        • "ARCHIVE_ACCESS"
        • "DEEP_ARCHIVE_ACCESS"
      • LastModified — (Date)

        Creation date of the object.

      • ContentLength — (Integer)

        Size of the body in bytes.

      • ETag — (String)

        An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

      • MissingMeta — (Integer)

        This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

      • VersionId — (String)

        Version of the object.

      • CacheControl — (String)

        Specifies caching behavior along the request/reply chain.

      • ContentDisposition — (String)

        Specifies presentational information for the object.

      • ContentEncoding — (String)

        Specifies 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.

      • ContentLanguage — (String)

        The language the content is in.

      • ContentType — (String)

        A standard MIME type describing the format of the object data.

      • Expires — (Date)

        The date and time at which the object is no longer cacheable.

      • WebsiteRedirectLocation — (String)

        If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

      • ServerSideEncryption — (String)

        If the object is stored using server-side encryption either with an Amazon Web Services KMS key or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

        Possible values include:
        • "AES256"
        • "aws:kms"
      • Metadata — (map<String>)

        A map of metadata to store with the object in S3.

      • SSECustomerAlgorithm — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

      • SSECustomerKeyMD5 — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

      • SSEKMSKeyId — (String)

        If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

      • BucketKeyEnabled — (Boolean)

        Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

      • StorageClass — (String)

        Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

        For more information, see Storage Classes.

        Possible values include:
        • "STANDARD"
        • "REDUCED_REDUNDANCY"
        • "STANDARD_IA"
        • "ONEZONE_IA"
        • "INTELLIGENT_TIERING"
        • "GLACIER"
        • "DEEP_ARCHIVE"
        • "OUTPOSTS"
      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"
      • ReplicationStatus — (String)

        Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

        In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

        • If requesting an object from the source bucket — Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

          For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

        • If requesting an object from a destination bucket — Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

        • When replicating objects to multiple destination buckets the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

        For more information, see Replication.

        Possible values include:
        • "COMPLETE"
        • "PENDING"
        • "FAILED"
        • "REPLICA"
      • PartsCount — (Integer)

        The count of parts this object has.

      • ObjectLockMode — (String)

        The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

        Possible values include:
        • "GOVERNANCE"
        • "COMPLIANCE"
      • ObjectLockRetainUntilDate — (Date)

        The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

      • ObjectLockLegalHoldStatus — (String)

        Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

        Possible values include:
        • "ON"
        • "OFF"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

listBucketAnalyticsConfigurations(params = {}, callback) ⇒ AWS.Request

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to ListBucketAnalyticsConfigurations:

Service Reference:

Examples:

Calling the listBucketAnalyticsConfigurations operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ContinuationToken: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.listBucketAnalyticsConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket from which analytics configurations are retrieved.

    • ContinuationToken — (String)

      The ContinuationToken that represents a placeholder from where this request should begin.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IsTruncated — (Boolean)

        Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

      • ContinuationToken — (String)

        The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.

      • NextContinuationToken — (String)

        NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.

      • AnalyticsConfigurationList — (Array<map>)

        The list of analytics configurations for a bucket.

        • Id — required — (String)

          The ID that identifies the analytics configuration.

        • Filter — (map)

          The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

          • Prefix — (String)

            The prefix to use when evaluating an analytics filter.

          • Tag — (map)

            The tag to use when evaluating an analytics filter.

            • Key — required — (String)

              Name of the object key.

            • Value — required — (String)

              Value of the tag.

          • And — (map)

            A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

            • Prefix — (String)

              The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.

            • Tags — (Array<map>)

              The list of tags to use when evaluating an AND predicate.

              • Key — required — (String)

                Name of the object key.

              • Value — required — (String)

                Value of the tag.

        • StorageClassAnalysis — required — (map)

          Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

          • DataExport — (map)

            Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.

            • OutputSchemaVersion — required — (String)

              The version of the output schema to use when exporting data. Must be V_1.

              Possible values include:
              • "V_1"
            • Destination — required — (map)

              The place to store the data for an analysis.

              • S3BucketDestination — required — (map)

                A destination signifying output to an S3 bucket.

                • Format — required — (String)

                  Specifies the file format used when exporting data to Amazon S3.

                  Possible values include:
                  • "CSV"
                • BucketAccountId — (String)

                  The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

                  Note: Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
                • Bucket — required — (String)

                  The Amazon Resource Name (ARN) of the bucket to which data is exported.

                • Prefix — (String)

                  The prefix to use when exporting data. The prefix is prepended to all results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBucketIntelligentTieringConfigurations(params = {}, callback) ⇒ AWS.Request

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in two low latency and high throughput access tiers. For data that can be accessed asynchronously, you can choose to activate automatic archiving capabilities within the S3 Intelligent-Tiering storage class.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to ListBucketIntelligentTieringConfigurations include:

Service Reference:

Examples:

Calling the listBucketIntelligentTieringConfigurations operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ContinuationToken: 'STRING_VALUE'
};
s3.listBucketIntelligentTieringConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

    • ContinuationToken — (String)

      The ContinuationToken that represents a placeholder from where this request should begin.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IsTruncated — (Boolean)

        Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

      • ContinuationToken — (String)

        The ContinuationToken that represents a placeholder from where this request should begin.

      • NextContinuationToken — (String)

        The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

      • IntelligentTieringConfigurationList — (Array<map>)

        The list of S3 Intelligent-Tiering configurations for a bucket.

        • Id — required — (String)

          The ID used to identify the S3 Intelligent-Tiering configuration.

        • Filter — (map)

          Specifies a bucket filter. The configuration only includes objects that meet the filter's criteria.

          • Prefix — (String)

            An object key name prefix that identifies the subset of objects to which the rule applies.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

          • Tag — (map)

            A container of a key value name pair.

            • Key — required — (String)

              Name of the object key.

            • Value — required — (String)

              Value of the tag.

          • And — (map)

            A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

            • Prefix — (String)

              An object key name prefix that identifies the subset of objects to which the configuration applies.

            • Tags — (Array<map>)

              All of these tags must exist in the object's tag set in order for the configuration to apply.

              • Key — required — (String)

                Name of the object key.

              • Value — required — (String)

                Value of the tag.

        • Status — required — (String)

          Specifies the status of the configuration.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • Tierings — required — (Array<map>)

          Specifies the S3 Intelligent-Tiering storage class tier of the configuration.

          • Days — required — (Integer)

            The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).

          • AccessTier — required — (String)

            S3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class.

            Possible values include:
            • "ARCHIVE_ACCESS"
            • "DEEP_ARCHIVE_ACCESS"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBucketInventoryConfigurations(params = {}, callback) ⇒ AWS.Request

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory

The following operations are related to ListBucketInventoryConfigurations:

Service Reference:

Examples:

Calling the listBucketInventoryConfigurations operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ContinuationToken: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.listBucketInventoryConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket containing the inventory configurations to retrieve.

    • ContinuationToken — (String)

      The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ContinuationToken — (String)

        If sent in the request, the marker that is used as a starting point for this inventory configuration list response.

      • InventoryConfigurationList — (Array<map>)

        The list of inventory configurations for a bucket.

        • Destination — required — (map)

          Contains information about where to publish the inventory results.

          • S3BucketDestination — required — (map)

            Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

            • AccountId — (String)

              The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

              Note: Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
            • Bucket — required — (String)

              The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

            • Format — required — (String)

              Specifies the output format of the inventory results.

              Possible values include:
              • "CSV"
              • "ORC"
              • "Parquet"
            • Prefix — (String)

              The prefix that is prepended to all inventory results.

            • Encryption — (map)

              Contains the type of server-side encryption used to encrypt the inventory results.

              • SSES3 — (map)

                Specifies the use of SSE-S3 to encrypt delivered inventory reports.

              • SSEKMS — (map)

                Specifies the use of SSE-KMS to encrypt delivered inventory reports.

                • KeyId — required — (String)

                  Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting inventory reports.

        • IsEnabled — required — (Boolean)

          Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

        • Filter — (map)

          Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

          • Prefix — required — (String)

            The prefix that an object must have to be included in the inventory results.

        • Id — required — (String)

          The ID used to identify the inventory configuration.

        • IncludedObjectVersions — required — (String)

          Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

          Possible values include:
          • "All"
          • "Current"
        • OptionalFields — (Array<String>)

          Contains the optional fields that are included in the inventory results.

        • Schedule — required — (map)

          Specifies the schedule for generating inventory results.

          • Frequency — required — (String)

            Specifies how frequently inventory results are produced.

            Possible values include:
            • "Daily"
            • "Weekly"
      • IsTruncated — (Boolean)

        Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.

      • NextContinuationToken — (String)

        The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBucketMetricsConfigurations(params = {}, callback) ⇒ AWS.Request

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

Service Reference:

Examples:

Calling the listBucketMetricsConfigurations operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ContinuationToken: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.listBucketMetricsConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket containing the metrics configurations to retrieve.

    • ContinuationToken — (String)

      The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IsTruncated — (Boolean)

        Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

      • ContinuationToken — (String)

        The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.

      • NextContinuationToken — (String)

        The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

      • MetricsConfigurationList — (Array<map>)

        The list of metrics configurations for a bucket.

        • Id — required — (String)

          The ID used to identify the metrics configuration.

        • Filter — (map)

          Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).

          • Prefix — (String)

            The prefix used when evaluating a metrics filter.

          • Tag — (map)

            The tag used when evaluating a metrics filter.

            • Key — required — (String)

              Name of the object key.

            • Value — required — (String)

              Value of the tag.

          • AccessPointArn — (String)

            The access point ARN used when evaluating a metrics filter.

          • And — (map)

            A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

            • Prefix — (String)

              The prefix used when evaluating an AND predicate.

            • Tags — (Array<map>)

              The list of tags used when evaluating an AND predicate.

              • Key — required — (String)

                Name of the object key.

              • Value — required — (String)

                Value of the tag.

            • AccessPointArn — (String)

              The access point ARN used when evaluating an AND predicate.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBuckets(params = {}, callback) ⇒ AWS.Request

Returns a list of all buckets owned by the authenticated sender of the request.

Note: This operation cannot be used in a browser. S3 does not support CORS on this operation.

Service Reference:

Examples:

To list object versions


/* The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions. */

 var params = {};
 s3.listBuckets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Buckets: [
       {
      CreationDate: <Date Representation>, 
      Name: "examplebucket"
     }, 
       {
      CreationDate: <Date Representation>, 
      Name: "examplebucket2"
     }, 
       {
      CreationDate: <Date Representation>, 
      Name: "examplebucket3"
     }
    ], 
    Owner: {
     DisplayName: "own-display-name", 
     ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31"
    }
   }
   */
 });

Calling the listBuckets operation

s3.listBuckets(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Buckets — (Array<map>)

        The list of buckets owned by the requestor.

        • Name — (String)

          The name of the bucket.

        • CreationDate — (Date)

          Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.

      • Owner — (map)

        The owner of the buckets listed.

        • DisplayName — (String)

          Container for the display name of the owner.

        • ID — (String)

          Container for the ID of the owner.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listMultipartUploads(params = {}, callback) ⇒ AWS.Request

This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.

This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters.

In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions.

The following operations are related to ListMultipartUploads:

Service Reference:

Examples:

To list in-progress multipart uploads on a bucket


/* The following example lists in-progress multipart uploads on a specific bucket. */

 var params = {
  Bucket: "examplebucket"
 };
 s3.listMultipartUploads(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Uploads: [
       {
      Initiated: <Date Representation>, 
      Initiator: {
       DisplayName: "display-name", 
       ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      }, 
      Key: "JavaFile", 
      Owner: {
       DisplayName: "display-name", 
       ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      }, 
      StorageClass: "STANDARD", 
      UploadId: "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--"
     }, 
       {
      Initiated: <Date Representation>, 
      Initiator: {
       DisplayName: "display-name", 
       ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      }, 
      Key: "JavaFile", 
      Owner: {
       DisplayName: "display-name", 
       ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      }, 
      StorageClass: "STANDARD", 
      UploadId: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--"
     }
    ]
   }
   */
 });

List next set of multipart uploads when previous result is truncated


/* The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads. */

 var params = {
  Bucket: "examplebucket", 
  KeyMarker: "nextkeyfrompreviousresponse", 
  MaxUploads: 2, 
  UploadIdMarker: "valuefrompreviousresponse"
 };
 s3.listMultipartUploads(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Bucket: "acl1", 
    IsTruncated: true, 
    KeyMarker: "", 
    MaxUploads: 2, 
    NextKeyMarker: "someobjectkey", 
    NextUploadIdMarker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--", 
    UploadIdMarker: "", 
    Uploads: [
       {
      Initiated: <Date Representation>, 
      Initiator: {
       DisplayName: "ownder-display-name", 
       ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      }, 
      Key: "JavaFile", 
      Owner: {
       DisplayName: "mohanataws", 
       ID: "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      }, 
      StorageClass: "STANDARD", 
      UploadId: "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--"
     }, 
       {
      Initiated: <Date Representation>, 
      Initiator: {
       DisplayName: "ownder-display-name", 
       ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      }, 
      Key: "JavaFile", 
      Owner: {
       DisplayName: "ownder-display-name", 
       ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      }, 
      StorageClass: "STANDARD", 
      UploadId: "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--"
     }
    ]
   }
   */
 });

Calling the listMultipartUploads operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Delimiter: 'STRING_VALUE',
  EncodingType: url,
  ExpectedBucketOwner: 'STRING_VALUE',
  KeyMarker: 'STRING_VALUE',
  MaxUploads: 'NUMBER_VALUE',
  Prefix: 'STRING_VALUE',
  UploadIdMarker: 'STRING_VALUE'
};
s3.listMultipartUploads(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket to which the multipart upload was initiated.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • Delimiter — (String)

      Character you use to group keys.

      All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

    • EncodingType — (String)

      Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

      Possible values include:
      • "url"
    • KeyMarker — (String)

      Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

      If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

      If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

    • MaxUploads — (Integer)

      Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

    • Prefix — (String)

      Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

    • UploadIdMarker — (String)

      Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Bucket — (String)

        The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

      • KeyMarker — (String)

        The key at or after which the listing began.

      • UploadIdMarker — (String)

        Upload ID after which listing began.

      • NextKeyMarker — (String)

        When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

      • Prefix — (String)

        When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

      • Delimiter — (String)

        Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

      • NextUploadIdMarker — (String)

        When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

      • MaxUploads — (Integer)

        Maximum number of multipart uploads that could have been included in the response.

      • IsTruncated — (Boolean)

        Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

      • Uploads — (Array<map>)

        Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

        • UploadId — (String)

          Upload ID that identifies the multipart upload.

        • Key — (String)

          Key of the object for which the multipart upload was initiated.

        • Initiated — (Date)

          Date and time at which the multipart upload was initiated.

        • StorageClass — (String)

          The class of storage used to store the object.

          Possible values include:
          • "STANDARD"
          • "REDUCED_REDUNDANCY"
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "INTELLIGENT_TIERING"
          • "GLACIER"
          • "DEEP_ARCHIVE"
          • "OUTPOSTS"
        • Owner — (map)

          Specifies the owner of the object that is part of the multipart upload.

          • DisplayName — (String)

            Container for the display name of the owner.

          • ID — (String)

            Container for the ID of the owner.

        • Initiator — (map)

          Identifies who initiated the multipart upload.

          • ID — (String)

            If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.

          • DisplayName — (String)

            Name of the Principal.

      • CommonPrefixes — (Array<map>)

        If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

        • Prefix — (String)

          Container for the specified common prefix.

      • EncodingType — (String)

        Encoding type used by Amazon S3 to encode object keys in the response.

        If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

        Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

        Possible values include:
        • "url"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listObjects(params = {}, callback) ⇒ AWS.Request

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.

This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects.

The following operations are related to ListObjects:

Service Reference:

Examples:

To list objects in a bucket


/* The following example list two objects in a bucket. */

 var params = {
  Bucket: "examplebucket", 
  MaxKeys: 2
 };
 s3.listObjects(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Contents: [
       {
      ETag: "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"", 
      Key: "example1.jpg", 
      LastModified: <Date Representation>, 
      Owner: {
       DisplayName: "myname", 
       ID: "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      }, 
      Size: 11, 
      StorageClass: "STANDARD"
     }, 
       {
      ETag: "\"9c8af9a76df052144598c115ef33e511\"", 
      Key: "example2.jpg", 
      LastModified: <Date Representation>, 
      Owner: {
       DisplayName: "myname", 
       ID: "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      }, 
      Size: 713193, 
      StorageClass: "STANDARD"
     }
    ], 
    NextMarker: "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
   }
   */
 });

Calling the listObjects operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Delimiter: 'STRING_VALUE',
  EncodingType: url,
  ExpectedBucketOwner: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxKeys: 'NUMBER_VALUE',
  Prefix: 'STRING_VALUE',
  RequestPayer: requester
};
s3.listObjects(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket containing the objects.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • Delimiter — (String)

      A delimiter is a character you use to group keys.

    • EncodingType — (String)

      Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

      Possible values include:
      • "url"
    • Marker — (String)

      Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

    • MaxKeys — (Integer)

      Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

    • Prefix — (String)

      Limits the response to keys that begin with the specified prefix.

    • RequestPayer — (String)

      Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IsTruncated — (Boolean)

        A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.

      • Marker — (String)

        Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

      • NextMarker — (String)

        When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMarker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

      • Contents — (Array<map>)

        Metadata about each object returned.

        • Key — (String)

          The name that you assign to an object. You use the object key to retrieve the object.

        • LastModified — (Date)

          Creation date of the object.

        • ETag — (String)

          The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

          • Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

          • Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

          • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

        • Size — (Integer)

          Size in bytes of the object

        • StorageClass — (String)

          The class of storage used to store the object.

          Possible values include:
          • "STANDARD"
          • "REDUCED_REDUNDANCY"
          • "GLACIER"
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "INTELLIGENT_TIERING"
          • "DEEP_ARCHIVE"
          • "OUTPOSTS"
        • Owner — (map)

          The owner of the object

          • DisplayName — (String)

            Container for the display name of the owner.

          • ID — (String)

            Container for the ID of the owner.

      • Name — (String)

        The bucket name.

      • Prefix — (String)

        Keys that begin with the indicated prefix.

      • Delimiter — (String)

        Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

      • MaxKeys — (Integer)

        The maximum number of keys returned in the response body.

      • CommonPrefixes — (Array<map>)

        All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.

        A response can contain CommonPrefixes only if you specify a delimiter.

        CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter.

        CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

        For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

        • Prefix — (String)

          Container for the specified common prefix.

      • EncodingType — (String)

        Encoding type used by Amazon S3 to encode object keys in the response.

        Possible values include:
        • "url"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listObjectsV2(params = {}, callback) ⇒ AWS.Request

Returns 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 the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the list. For more information about listing objects, see Listing object keys programmatically

To use this operation, you must have READ access to the bucket.

To use this action in an Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

This section describes the latest revision of this action. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.

To get a list of your buckets, see ListBuckets.

The following operations are related to ListObjectsV2:

Service Reference:

Examples:

To get object list


/* The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys.  */

 var params = {
  Bucket: "examplebucket", 
  MaxKeys: 2
 };
 s3.listObjectsV2(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Contents: [
       {
      ETag: "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"", 
      Key: "happyface.jpg", 
      LastModified: <Date Representation>, 
      Size: 11, 
      StorageClass: "STANDARD"
     }, 
       {
      ETag: "\"becf17f89c30367a9a44495d62ed521a-1\"", 
      Key: "test.jpg", 
      LastModified: <Date Representation>, 
      Size: 4192256, 
      StorageClass: "STANDARD"
     }
    ], 
    IsTruncated: true, 
    KeyCount: 2, 
    MaxKeys: 2, 
    Name: "examplebucket", 
    NextContinuationToken: "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==", 
    Prefix: ""
   }
   */
 });

Calling the listObjectsV2 operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ContinuationToken: 'STRING_VALUE',
  Delimiter: 'STRING_VALUE',
  EncodingType: url,
  ExpectedBucketOwner: 'STRING_VALUE',
  FetchOwner: true || false,
  MaxKeys: 'NUMBER_VALUE',
  Prefix: 'STRING_VALUE',
  RequestPayer: requester,
  StartAfter: 'STRING_VALUE'
};
s3.listObjectsV2(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      Bucket name to list.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • Delimiter — (String)

      A delimiter is a character you use to group keys.

    • EncodingType — (String)

      Encoding type used by Amazon S3 to encode object keys in the response.

      Possible values include:
      • "url"
    • MaxKeys — (Integer)

      Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

    • Prefix — (String)

      Limits the response to keys that begin with the specified prefix.

    • ContinuationToken — (String)

      ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

    • FetchOwner — (Boolean)

      The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.

    • StartAfter — (String)

      StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

    • RequestPayer — (String)

      Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IsTruncated — (Boolean)

        Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

      • Contents — (Array<map>)

        Metadata about each object returned.

        • Key — (String)

          The name that you assign to an object. You use the object key to retrieve the object.

        • LastModified — (Date)

          Creation date of the object.

        • ETag — (String)

          The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

          • Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

          • Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

          • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

        • Size — (Integer)

          Size in bytes of the object

        • StorageClass — (String)

          The class of storage used to store the object.

          Possible values include:
          • "STANDARD"
          • "REDUCED_REDUNDANCY"
          • "GLACIER"
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "INTELLIGENT_TIERING"
          • "DEEP_ARCHIVE"
          • "OUTPOSTS"
        • Owner — (map)

          The owner of the object

          • DisplayName — (String)

            Container for the display name of the owner.

          • ID — (String)

            Container for the ID of the owner.

      • Name — (String)

        The bucket name.

        When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

        When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

      • Prefix — (String)

        Keys that begin with the indicated prefix.

      • Delimiter — (String)

        Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

      • MaxKeys — (Integer)

        Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

      • CommonPrefixes — (Array<map>)

        All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.

        A response can contain CommonPrefixes only if you specify a delimiter.

        CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

        CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

        For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

        • Prefix — (String)

          Container for the specified common prefix.

      • EncodingType — (String)

        Encoding type used by Amazon S3 to encode object key names in the XML response.

        If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

        Delimiter, Prefix, Key, and StartAfter.

        Possible values include:
        • "url"
      • KeyCount — (Integer)

        KeyCount is the number of keys returned with this request. KeyCount will always be less than or equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys

      • ContinuationToken — (String)

        If ContinuationToken was sent with the request, it is included in the response.

      • NextContinuationToken — (String)

        NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key

      • StartAfter — (String)

        If StartAfter was sent with the request, it is included in the response.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listObjectVersions(params = {}, callback) ⇒ AWS.Request

Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

To use this operation, you must have permissions to perform the s3:ListBucketVersions action. Be aware of the name difference.

Note: A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.

To use this operation, you must have READ access to the bucket.

This action is not supported by Amazon S3 on Outposts.

The following operations are related to ListObjectVersions:

Service Reference:

Examples:

To list object versions


/* The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions. */

 var params = {
  Bucket: "examplebucket", 
  Prefix: "HappyFace.jpg"
 };
 s3.listObjectVersions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Versions: [
       {
      ETag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
      IsLatest: true, 
      Key: "HappyFace.jpg", 
      LastModified: <Date Representation>, 
      Owner: {
       DisplayName: "owner-display-name", 
       ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      }, 
      Size: 3191, 
      StorageClass: "STANDARD", 
      VersionId: "null"
     }, 
       {
      ETag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
      IsLatest: false, 
      Key: "HappyFace.jpg", 
      LastModified: <Date Representation>, 
      Owner: {
       DisplayName: "owner-display-name", 
       ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      }, 
      Size: 3191, 
      StorageClass: "STANDARD", 
      VersionId: "PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k"
     }
    ]
   }
   */
 });

Calling the listObjectVersions operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Delimiter: 'STRING_VALUE',
  EncodingType: url,
  ExpectedBucketOwner: 'STRING_VALUE',
  KeyMarker: 'STRING_VALUE',
  MaxKeys: 'NUMBER_VALUE',
  Prefix: 'STRING_VALUE',
  VersionIdMarker: 'STRING_VALUE'
};
s3.listObjectVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name that contains the objects.

    • Delimiter — (String)

      A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

    • EncodingType — (String)

      Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

      Possible values include:
      • "url"
    • KeyMarker — (String)

      Specifies the key to start with when listing objects in a bucket.

    • MaxKeys — (Integer)

      Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

    • Prefix — (String)

      Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

    • VersionIdMarker — (String)

      Specifies the object version you want to start listing from.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IsTruncated — (Boolean)

        A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

      • KeyMarker — (String)

        Marks the last key returned in a truncated response.

      • VersionIdMarker — (String)

        Marks the last version of the key returned in a truncated response.

      • NextKeyMarker — (String)

        When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

      • NextVersionIdMarker — (String)

        When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

      • Versions — (Array<map>)

        Container for version information.

        • ETag — (String)

          The entity tag is an MD5 hash of that version of the object.

        • Size — (Integer)

          Size in bytes of the object.

        • StorageClass — (String)

          The class of storage used to store the object.

          Possible values include:
          • "STANDARD"
        • Key — (String)

          The object key.

        • VersionId — (String)

          Version ID of an object.

        • IsLatest — (Boolean)

          Specifies whether the object is (true) or is not (false) the latest version of an object.

        • LastModified — (Date)

          Date and time the object was last modified.

        • Owner — (map)

          Specifies the owner of the object.

          • DisplayName — (String)

            Container for the display name of the owner.

          • ID — (String)

            Container for the ID of the owner.

      • DeleteMarkers — (Array<map>)

        Container for an object that is a delete marker.

        • Owner — (map)

          The account that created the delete marker.>

          • DisplayName — (String)

            Container for the display name of the owner.

          • ID — (String)

            Container for the ID of the owner.

        • Key — (String)

          The object key.

        • VersionId — (String)

          Version ID of an object.

        • IsLatest — (Boolean)

          Specifies whether the object is (true) or is not (false) the latest version of an object.

        • LastModified — (Date)

          Date and time the object was last modified.

      • Name — (String)

        The bucket name.

      • Prefix — (String)

        Selects objects that start with the value supplied by this parameter.

      • Delimiter — (String)

        The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

      • MaxKeys — (Integer)

        Specifies the maximum number of objects to return.

      • CommonPrefixes — (Array<map>)

        All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

        • Prefix — (String)

          Container for the specified common prefix.

      • EncodingType — (String)

        Encoding type used by Amazon S3 to encode object key names in the XML response.

        If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

        KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

        Possible values include:
        • "url"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listParts(params = {}, callback) ⇒ AWS.Request

Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions.

The following operations are related to ListParts:

Service Reference:

Examples:

To list parts of a multipart upload.


/* The following example lists parts uploaded for a specific multipart upload. */

 var params = {
  Bucket: "examplebucket", 
  Key: "bigobject", 
  UploadId: "example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
 };
 s3.listParts(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Initiator: {
     DisplayName: "owner-display-name", 
     ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
    }, 
    Owner: {
     DisplayName: "owner-display-name", 
     ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
    }, 
    Parts: [
       {
      ETag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"", 
      LastModified: <Date Representation>, 
      PartNumber: 1, 
      Size: 26246026
     }, 
       {
      ETag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"", 
      LastModified: <Date Representation>, 
      PartNumber: 2, 
      Size: 26246026
     }
    ], 
    StorageClass: "STANDARD"
   }
   */
 });

Calling the listParts operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  UploadId: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  MaxParts: 'NUMBER_VALUE',
  PartNumberMarker: 'NUMBER_VALUE',
  RequestPayer: requester
};
s3.listParts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket to which the parts are being uploaded.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • Key — (String)

      Object key for which the multipart upload was initiated.

    • MaxParts — (Integer)

      Sets the maximum number of parts to return.

    • PartNumberMarker — (Integer)

      Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

    • UploadId — (String)

      Upload ID identifying the multipart upload whose parts are being listed.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AbortDate — (Date)

        If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

        The response will also include the x-amz-abort-rule-id header that will provide the ID of the lifecycle configuration rule that defines this action.

      • AbortRuleId — (String)

        This header is returned along with the x-amz-abort-date header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

      • Bucket — (String)

        The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

      • Key — (String)

        Object key for which the multipart upload was initiated.

      • UploadId — (String)

        Upload ID identifying the multipart upload whose parts are being listed.

      • PartNumberMarker — (Integer)

        When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

      • NextPartNumberMarker — (Integer)

        When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

      • MaxParts — (Integer)

        Maximum number of parts that were allowed in the response.

      • IsTruncated — (Boolean)

        Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

      • Parts — (Array<map>)

        Container for elements related to a particular part. A response can contain zero or more Part elements.

        • PartNumber — (Integer)

          Part number identifying the part. This is a positive integer between 1 and 10,000.

        • LastModified — (Date)

          Date and time at which the part was uploaded.

        • ETag — (String)

          Entity tag returned when the part was uploaded.

        • Size — (Integer)

          Size in bytes of the uploaded part data.

      • Initiator — (map)

        Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services account, this element provides the same information as the Owner element. If the initiator is an IAM User, this element provides the user ARN and display name.

        • ID — (String)

          If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.

        • DisplayName — (String)

          Name of the Principal.

      • Owner — (map)

        Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.

        • DisplayName — (String)

          Container for the display name of the owner.

        • ID — (String)

          Container for the ID of the owner.

      • StorageClass — (String)

        Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.

        Possible values include:
        • "STANDARD"
        • "REDUCED_REDUNDANCY"
        • "STANDARD_IA"
        • "ONEZONE_IA"
        • "INTELLIGENT_TIERING"
        • "GLACIER"
        • "DEEP_ARCHIVE"
        • "OUTPOSTS"
      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

populateUriFromAccessPointArn(req) ⇒ void

When user supply an access point ARN in the Bucket parameter, we need to populate the URI according to the ARN.

putBucketAccelerateConfiguration(params = {}, callback) ⇒ AWS.Request

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.

To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The Transfer Acceleration state of a bucket can be set to one of the following two values:

  • Enabled – Enables accelerated data transfers to the bucket.

  • Suspended – Disables accelerated data transfers to the bucket.

The GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket.

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").

For more information about transfer acceleration, see Transfer Acceleration.

The following operations are related to PutBucketAccelerateConfiguration:

Service Reference:

Examples:

Calling the putBucketAccelerateConfiguration operation

var params = {
  AccelerateConfiguration: { /* required */
    Status: Enabled | Suspended
  },
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketAccelerateConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which the accelerate configuration is set.

    • AccelerateConfiguration — (map)

      Container for setting the transfer acceleration state.

      • Status — (String)

        Specifies the transfer acceleration status of the bucket.

        Possible values include:
        • "Enabled"
        • "Suspended"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketAcl(params = {}, callback) ⇒ AWS.Request

Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission.

You can use one of the following two ways to set a bucket's permissions:

  • Specify the ACL in the request body

  • Specify permissions using request headers

Note: You cannot specify access permission using both the body and the request headers.

Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

Access Permissions

You can set access permissions using one of the following methods:

  • Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.

  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

    You specify each grantee as a type=value pair, where the type is one of the following:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Note: Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
      • US East (N. Virginia)
      • US West (N. California)
      • US West (Oregon)
      • Asia Pacific (Singapore)
      • Asia Pacific (Sydney)
      • Asia Pacific (Tokyo)
      • Europe (Ireland)
      • South America (São Paulo)
      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.

    x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

Related Resources

Service Reference:

Examples:

Put bucket acl


/* The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console. */

 var params = {
  Bucket: "examplebucket", 
  GrantFullControl: "id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484", 
  GrantWrite: "uri=http://acs.amazonaws.com/groups/s3/LogDelivery"
 };
 s3.putBucketAcl(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the putBucketAcl operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ACL: private | public-read | public-read-write | authenticated-read,
  AccessControlPolicy: {
    Grants: [
      {
        Grantee: {
          Type: CanonicalUser | AmazonCustomerByEmail | Group, /* required */
          DisplayName: 'STRING_VALUE',
          EmailAddress: 'STRING_VALUE',
          ID: 'STRING_VALUE',
          URI: 'STRING_VALUE'
        },
        Permission: FULL_CONTROL | WRITE | WRITE_ACP | READ | READ_ACP
      },
      /* more items */
    ],
    Owner: {
      DisplayName: 'STRING_VALUE',
      ID: 'STRING_VALUE'
    }
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  GrantFullControl: 'STRING_VALUE',
  GrantRead: 'STRING_VALUE',
  GrantReadACP: 'STRING_VALUE',
  GrantWrite: 'STRING_VALUE',
  GrantWriteACP: 'STRING_VALUE'
};
s3.putBucketAcl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ACL — (String)

      The canned ACL to apply to the bucket.

      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
    • AccessControlPolicy — (map)

      Contains the elements that set the ACL permissions for an object per grantee.

      • Grants — (Array<map>)

        A list of grants.

        • Grantee — (map)

          The person being granted permissions.

          • DisplayName — (String)

            Screen name of the grantee.

          • EmailAddress — (String)

            Email address of the grantee.

            Note: Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
            • US East (N. Virginia)
            • US West (N. California)
            • US West (Oregon)
            • Asia Pacific (Singapore)
            • Asia Pacific (Sydney)
            • Asia Pacific (Tokyo)
            • Europe (Ireland)
            • South America (São Paulo)
            For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
          • ID — (String)

            The canonical user ID of the grantee.

          • Type — required — (String)

            Type of grantee

            Possible values include:
            • "CanonicalUser"
            • "AmazonCustomerByEmail"
            • "Group"
          • URI — (String)

            URI of the grantee group.

        • Permission — (String)

          Specifies the permission given to the grantee.

          Possible values include:
          • "FULL_CONTROL"
          • "WRITE"
          • "WRITE_ACP"
          • "READ"
          • "READ_ACP"
      • Owner — (map)

        Container for the bucket owner's display name and ID.

        • DisplayName — (String)

          Container for the display name of the owner.

        • ID — (String)

          Container for the ID of the owner.

    • Bucket — (String)

      The bucket to which to apply the ACL.

    • ContentMD5 — (String)

      The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • GrantFullControl — (String)

      Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    • GrantRead — (String)

      Allows grantee to list the objects in the bucket.

    • GrantReadACP — (String)

      Allows grantee to read the bucket ACL.

    • GrantWrite — (String)

      Allows grantee to create new objects in the bucket.

      For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

    • GrantWriteACP — (String)

      Allows grantee to write the ACL for the applicable bucket.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketAnalyticsConfiguration(params = {}, callback) ⇒ AWS.Request

Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.

You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.

You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

Special Errors

    • HTTP Error: HTTP 400 Bad Request

    • Code: InvalidArgument

    • Cause: Invalid argument.

    • HTTP Error: HTTP 400 Bad Request

    • Code: TooManyConfigurations

    • Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

    • HTTP Error: HTTP 403 Forbidden

    • Code: AccessDenied

    • Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.

Related Resources

Service Reference:

Examples:

Calling the putBucketAnalyticsConfiguration operation

var params = {
  AnalyticsConfiguration: { /* required */
    Id: 'STRING_VALUE', /* required */
    StorageClassAnalysis: { /* required */
      DataExport: {
        Destination: { /* required */
          S3BucketDestination: { /* required */
            Bucket: 'STRING_VALUE', /* required */
            Format: CSV, /* required */
            BucketAccountId: 'STRING_VALUE',
            Prefix: 'STRING_VALUE'
          }
        },
        OutputSchemaVersion: V_1 /* required */
      }
    },
    Filter: {
      And: {
        Prefix: 'STRING_VALUE',
        Tags: [
          {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      Prefix: 'STRING_VALUE',
      Tag: {
        Key: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE' /* required */
      }
    }
  },
  Bucket: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketAnalyticsConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket to which an analytics configuration is stored.

    • Id — (String)

      The ID that identifies the analytics configuration.

    • AnalyticsConfiguration — (map)

      The configuration and any analyses for the analytics filter.

      • Id — required — (String)

        The ID that identifies the analytics configuration.

      • Filter — (map)

        The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

        • Prefix — (String)

          The prefix to use when evaluating an analytics filter.

        • Tag — (map)

          The tag to use when evaluating an analytics filter.

          • Key — required — (String)

            Name of the object key.

          • Value — required — (String)

            Value of the tag.

        • And — (map)

          A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

          • Prefix — (String)

            The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.

          • Tags — (Array<map>)

            The list of tags to use when evaluating an AND predicate.

            • Key — required — (String)

              Name of the object key.

            • Value — required — (String)

              Value of the tag.

      • StorageClassAnalysis — required — (map)

        Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

        • DataExport — (map)

          Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.

          • OutputSchemaVersion — required — (String)

            The version of the output schema to use when exporting data. Must be V_1.

            Possible values include:
            • "V_1"
          • Destination — required — (map)

            The place to store the data for an analysis.

            • S3BucketDestination — required — (map)

              A destination signifying output to an S3 bucket.

              • Format — required — (String)

                Specifies the file format used when exporting data to Amazon S3.

                Possible values include:
                • "CSV"
              • BucketAccountId — (String)

                The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

                Note: Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
              • Bucket — required — (String)

                The Amazon Resource Name (ARN) of the bucket to which data is exported.

              • Prefix — (String)

                The prefix to use when exporting data. The prefix is prepended to all results.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketCors(params = {}, callback) ⇒ AWS.Request

Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.

To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:

  • The request's Origin header must match AllowedOrigin elements.

  • The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements.

  • Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element.

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Related Resources

Service Reference:

Examples:

To set cors configuration on a bucket.


/* The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain. */

 var params = {
  Bucket: "", 
  CORSConfiguration: {
   CORSRules: [
      {
     AllowedHeaders: [
        "*"
     ], 
     AllowedMethods: [
        "PUT", 
        "POST", 
        "DELETE"
     ], 
     AllowedOrigins: [
        "http://www.example.com"
     ], 
     ExposeHeaders: [
        "x-amz-server-side-encryption"
     ], 
     MaxAgeSeconds: 3000
    }, 
      {
     AllowedHeaders: [
        "Authorization"
     ], 
     AllowedMethods: [
        "GET"
     ], 
     AllowedOrigins: [
        "*"
     ], 
     MaxAgeSeconds: 3000
    }
   ]
  }, 
  ContentMD5: ""
 };
 s3.putBucketCors(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the putBucketCors operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  CORSConfiguration: { /* required */
    CORSRules: [ /* required */
      {
        AllowedMethods: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        AllowedOrigins: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        AllowedHeaders: [
          'STRING_VALUE',
          /* more items */
        ],
        ExposeHeaders: [
          'STRING_VALUE',
          /* more items */
        ],
        ID: 'STRING_VALUE',
        MaxAgeSeconds: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketCors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      Specifies the bucket impacted by the corsconfiguration.

    • CORSConfiguration — (map)

      Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

      • CORSRules — required — (Array<map>)

        A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

        • ID — (String)

          Unique identifier for the rule. The value cannot be longer than 255 characters.

        • AllowedHeaders — (Array<String>)

          Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

        • AllowedMethods — required — (Array<String>)

          An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.

        • AllowedOrigins — required — (Array<String>)

          One or more origins you want customers to be able to access the bucket from.

        • ExposeHeaders — (Array<String>)

          One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

        • MaxAgeSeconds — (Integer)

          The time in seconds that your browser is to cache the preflight response for the specified resource.

    • ContentMD5 — (String)

      The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketEncryption(params = {}, callback) ⇒ AWS.Request

This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket.

Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default encryption, see Amazon S3 default bucket encryption in the Amazon S3 User Guide. For more information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4).

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

Related Resources

Service Reference:

Examples:

Calling the putBucketEncryption operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ServerSideEncryptionConfiguration: { /* required */
    Rules: [ /* required */
      {
        ApplyServerSideEncryptionByDefault: {
          SSEAlgorithm: AES256 | aws:kms, /* required */
          KMSMasterKeyID: 'STRING_VALUE'
        },
        BucketKeyEnabled: true || false
      },
      /* more items */
    ]
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketEncryption(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon S3 User Guide.

    • ContentMD5 — (String)

      The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • ServerSideEncryptionConfiguration — (map)

      Specifies the default server-side-encryption configuration.

      • Rules — required — (Array<map>)

        Container for information about a particular server-side encryption configuration rule.

        • ApplyServerSideEncryptionByDefault — (map)

          Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.

          • SSEAlgorithm — required — (String)

            Server-side encryption algorithm to use for the default encryption.

            Possible values include:
            • "AES256"
            • "aws:kms"
          • KMSMasterKeyID — (String)

            Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

            You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account operations, you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

            For example:

            • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

            • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

            Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

        • BucketKeyEnabled — (Boolean)

          Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.

          For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketIntelligentTieringConfiguration(params = {}, callback) ⇒ AWS.Request

Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in two low latency and high throughput access tiers. For data that can be accessed asynchronously, you can choose to activate automatic archiving capabilities within the S3 Intelligent-Tiering storage class.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to PutBucketIntelligentTieringConfiguration include:

Note: You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.

Special Errors

  • HTTP 400 Bad Request Error

    • Code: InvalidArgument

    • Cause: Invalid Argument

  • HTTP 400 Bad Request Error

    • Code: TooManyConfigurations

    • Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

  • HTTP 403 Forbidden Error

    • Code: AccessDenied

    • Cause: You are not the owner of the specified bucket, or you do not have the s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the bucket.

Service Reference:

Examples:

Calling the putBucketIntelligentTieringConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  IntelligentTieringConfiguration: { /* required */
    Id: 'STRING_VALUE', /* required */
    Status: Enabled | Disabled, /* required */
    Tierings: [ /* required */
      {
        AccessTier: ARCHIVE_ACCESS | DEEP_ARCHIVE_ACCESS, /* required */
        Days: 'NUMBER_VALUE' /* required */
      },
      /* more items */
    ],
    Filter: {
      And: {
        Prefix: 'STRING_VALUE',
        Tags: [
          {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      Prefix: 'STRING_VALUE',
      Tag: {
        Key: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE' /* required */
      }
    }
  }
};
s3.putBucketIntelligentTieringConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

    • Id — (String)

      The ID used to identify the S3 Intelligent-Tiering configuration.

    • IntelligentTieringConfiguration — (map)

      Container for S3 Intelligent-Tiering configuration.

      • Id — required — (String)

        The ID used to identify the S3 Intelligent-Tiering configuration.

      • Filter — (map)

        Specifies a bucket filter. The configuration only includes objects that meet the filter's criteria.

        • Prefix — (String)

          An object key name prefix that identifies the subset of objects to which the rule applies.

          Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

        • Tag — (map)

          A container of a key value name pair.

          • Key — required — (String)

            Name of the object key.

          • Value — required — (String)

            Value of the tag.

        • And — (map)

          A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

          • Prefix — (String)

            An object key name prefix that identifies the subset of objects to which the configuration applies.

          • Tags — (Array<map>)

            All of these tags must exist in the object's tag set in order for the configuration to apply.

            • Key — required — (String)

              Name of the object key.

            • Value — required — (String)

              Value of the tag.

      • Status — required — (String)

        Specifies the status of the configuration.

        Possible values include:
        • "Enabled"
        • "Disabled"
      • Tierings — required — (Array<map>)

        Specifies the S3 Intelligent-Tiering storage class tier of the configuration.

        • Days — required — (Integer)

          The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).

        • AccessTier — required — (String)

          S3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class.

          Possible values include:
          • "ARCHIVE_ACCESS"
          • "DEEP_ARCHIVE_ACCESS"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketInventoryConfiguration(params = {}, callback) ⇒ AWS.Request

This implementation of the PUT action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.

When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.

You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

Special Errors

  • HTTP 400 Bad Request Error

    • Code: InvalidArgument

    • Cause: Invalid Argument

  • HTTP 400 Bad Request Error

    • Code: TooManyConfigurations

    • Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

  • HTTP 403 Forbidden Error

    • Code: AccessDenied

    • Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.

Related Resources

Service Reference:

Examples:

Calling the putBucketInventoryConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  InventoryConfiguration: { /* required */
    Destination: { /* required */
      S3BucketDestination: { /* required */
        Bucket: 'STRING_VALUE', /* required */
        Format: CSV | ORC | Parquet, /* required */
        AccountId: 'STRING_VALUE',
        Encryption: {
          SSEKMS: {
            KeyId: 'STRING_VALUE' /* required */
          },
          SSES3: {
          }
        },
        Prefix: 'STRING_VALUE'
      }
    },
    Id: 'STRING_VALUE', /* required */
    IncludedObjectVersions: All | Current, /* required */
    IsEnabled: true || false, /* required */
    Schedule: { /* required */
      Frequency: Daily | Weekly /* required */
    },
    Filter: {
      Prefix: 'STRING_VALUE' /* required */
    },
    OptionalFields: [
      Size | LastModifiedDate | StorageClass | ETag | IsMultipartUploaded | ReplicationStatus | EncryptionStatus | ObjectLockRetainUntilDate | ObjectLockMode | ObjectLockLegalHoldStatus | IntelligentTieringAccessTier | BucketKeyStatus,
      /* more items */
    ]
  },
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketInventoryConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket where the inventory configuration will be stored.

    • Id — (String)

      The ID used to identify the inventory configuration.

    • InventoryConfiguration — (map)

      Specifies the inventory configuration.

      • Destination — required — (map)

        Contains information about where to publish the inventory results.

        • S3BucketDestination — required — (map)

          Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

          • AccountId — (String)

            The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

            Note: Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
          • Bucket — required — (String)

            The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

          • Format — required — (String)

            Specifies the output format of the inventory results.

            Possible values include:
            • "CSV"
            • "ORC"
            • "Parquet"
          • Prefix — (String)

            The prefix that is prepended to all inventory results.

          • Encryption — (map)

            Contains the type of server-side encryption used to encrypt the inventory results.

            • SSES3 — (map)

              Specifies the use of SSE-S3 to encrypt delivered inventory reports.

            • SSEKMS — (map)

              Specifies the use of SSE-KMS to encrypt delivered inventory reports.

              • KeyId — required — (String)

                Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting inventory reports.

      • IsEnabled — required — (Boolean)

        Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

      • Filter — (map)

        Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

        • Prefix — required — (String)

          The prefix that an object must have to be included in the inventory results.

      • Id — required — (String)

        The ID used to identify the inventory configuration.

      • IncludedObjectVersions — required — (String)

        Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

        Possible values include:
        • "All"
        • "Current"
      • OptionalFields — (Array<String>)

        Contains the optional fields that are included in the inventory results.

      • Schedule — required — (map)

        Specifies the schedule for generating inventory results.

        • Frequency — required — (String)

          Specifies how frequently inventory results are produced.

          Possible values include:
          • "Daily"
          • "Weekly"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketLifecycle(params = {}, callback) ⇒ AWS.Request

For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon S3 User Guide.

By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

  • s3:DeleteObject

  • s3:DeleteObjectVersion

  • s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.

Related Resources

Service Reference:

Examples:

Calling the putBucketLifecycle operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  LifecycleConfiguration: {
    Rules: [ /* required */
      {
        Prefix: 'STRING_VALUE', /* required */
        Status: Enabled | Disabled, /* required */
        AbortIncompleteMultipartUpload: {
          DaysAfterInitiation: 'NUMBER_VALUE'
        },
        Expiration: {
          Date: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          Days: 'NUMBER_VALUE',
          ExpiredObjectDeleteMarker: true || false
        },
        ID: 'STRING_VALUE',
        NoncurrentVersionExpiration: {
          NoncurrentDays: 'NUMBER_VALUE'
        },
        NoncurrentVersionTransition: {
          NoncurrentDays: 'NUMBER_VALUE',
          StorageClass: GLACIER | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | DEEP_ARCHIVE
        },
        Transition: {
          Date: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          Days: 'NUMBER_VALUE',
          StorageClass: GLACIER | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | DEEP_ARCHIVE
        }
      },
      /* more items */
    ]
  }
};
s3.putBucketLifecycle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

    • ContentMD5 — (String)

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • LifecycleConfiguration — (map)

      • Rules — required — (Array<map>)

        Specifies lifecycle configuration rules for an Amazon S3 bucket.

        • Expiration — (map)

          Specifies the expiration for the lifecycle of the object.

          • Date — (Date)

            Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.

          • Days — (Integer)

            Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

          • ExpiredObjectDeleteMarker — (Boolean)

            Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

        • ID — (String)

          Unique identifier for the rule. The value can't be longer than 255 characters.

        • Prefix — required — (String)

          Object key prefix that identifies one or more objects to which this rule applies.

          Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

        • Status — required — (String)

          If Enabled, the rule is currently being applied. If Disabled, the rule is not currently being applied.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • Transition — (map)

          Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

          • Date — (Date)

            Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

          • Days — (Integer)

            Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

          • StorageClass — (String)

            The storage class to which you want the object to transition.

            Possible values include:
            • "GLACIER"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
        • NoncurrentVersionTransition — (map)

          Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.

          • NoncurrentDays — (Integer)

            Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.

          • StorageClass — (String)

            The class of storage used to store the object.

            Possible values include:
            • "GLACIER"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
        • NoncurrentVersionExpiration — (map)

          Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

        • AbortIncompleteMultipartUpload — (map)

          Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide.

          • DaysAfterInitiation — (Integer)

            Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketLifecycleConfiguration(params = {}, callback) ⇒ AWS.Request

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.

Note: Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.

Rules

You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:

  • Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.

  • Status whether the rule is in effect.

  • One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.

For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.

Permissions

By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

  • s3:DeleteObject

  • s3:DeleteObjectVersion

  • s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

The following are related to PutBucketLifecycleConfiguration:

Service Reference:

Examples:

Put bucket lifecycle


/* The following example replaces existing lifecycle configuration, if any, on the specified bucket.  */

 var params = {
  Bucket: "examplebucket", 
  LifecycleConfiguration: {
   Rules: [
      {
     Expiration: {
      Days: 3650
     }, 
     Filter: {
      Prefix: "documents/"
     }, 
     ID: "TestOnly", 
     Status: "Enabled", 
     Transitions: [
        {
       Days: 365, 
       StorageClass: "GLACIER"
      }
     ]
    }
   ]
  }
 };
 s3.putBucketLifecycleConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the putBucketLifecycleConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  LifecycleConfiguration: {
    Rules: [ /* required */
      {
        Status: Enabled | Disabled, /* required */
        AbortIncompleteMultipartUpload: {
          DaysAfterInitiation: 'NUMBER_VALUE'
        },
        Expiration: {
          Date: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          Days: 'NUMBER_VALUE',
          ExpiredObjectDeleteMarker: true || false
        },
        Filter: {
          And: {
            Prefix: 'STRING_VALUE',
            Tags: [
              {
                Key: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          },
          Prefix: 'STRING_VALUE',
          Tag: {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          }
        },
        ID: 'STRING_VALUE',
        NoncurrentVersionExpiration: {
          NoncurrentDays: 'NUMBER_VALUE'
        },
        NoncurrentVersionTransitions: [
          {
            NoncurrentDays: 'NUMBER_VALUE',
            StorageClass: GLACIER | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | DEEP_ARCHIVE
          },
          /* more items */
        ],
        Prefix: 'STRING_VALUE',
        Transitions: [
          {
            Date: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
            Days: 'NUMBER_VALUE',
            StorageClass: GLACIER | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | DEEP_ARCHIVE
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  }
};
s3.putBucketLifecycleConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which to set the configuration.

    • LifecycleConfiguration — (map)

      Container for lifecycle rules. You can add as many as 1,000 rules.

      • Rules — required — (Array<map>)

        A lifecycle rule for individual objects in an Amazon S3 bucket.

        • Expiration — (map)

          Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

          • Date — (Date)

            Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.

          • Days — (Integer)

            Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

          • ExpiredObjectDeleteMarker — (Boolean)

            Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

        • ID — (String)

          Unique identifier for the rule. The value cannot be longer than 255 characters.

        • Prefix — (String)

          Prefix identifying one or more objects to which the rule applies. This is no longer used; use Filter instead.

          Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

        • Filter — (map)

          The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified. Filter is required if the LifecycleRule does not containt a Prefix element.

          • Prefix — (String)

            Prefix identifying one or more objects to which the rule applies.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

          • Tag — (map)

            This tag must exist in the object's tag set in order for the rule to apply.

            • Key — required — (String)

              Name of the object key.

            • Value — required — (String)

              Value of the tag.

          • And — (map)

            This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.

            • Prefix — (String)

              Prefix identifying one or more objects to which the rule applies.

            • Tags — (Array<map>)

              All of these tags must exist in the object's tag set in order for the rule to apply.

              • Key — required — (String)

                Name of the object key.

              • Value — required — (String)

                Value of the tag.

        • Status — required — (String)

          If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • Transitions — (Array<map>)

          Specifies when an Amazon S3 object transitions to a specified storage class.

          • Date — (Date)

            Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

          • Days — (Integer)

            Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

          • StorageClass — (String)

            The storage class to which you want the object to transition.

            Possible values include:
            • "GLACIER"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
        • NoncurrentVersionTransitions — (Array<map>)

          Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

          • NoncurrentDays — (Integer)

            Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.

          • StorageClass — (String)

            The class of storage used to store the object.

            Possible values include:
            • "GLACIER"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
        • NoncurrentVersionExpiration — (map)

          Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

        • AbortIncompleteMultipartUpload — (map)

          Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide.

          • DaysAfterInitiation — (Integer)

            Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketLogging(params = {}, callback) ⇒ AWS.Request

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:

<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />

For more information about server access logging, see Server Access Logging.

For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.

The following operations are related to PutBucketLogging:

Service Reference:

Examples:

Set logging configuration for a bucket


/* The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants. */

 var params = {
  Bucket: "sourcebucket", 
  BucketLoggingStatus: {
   LoggingEnabled: {
    TargetBucket: "targetbucket", 
    TargetGrants: [
       {
      Grantee: {
       Type: "Group", 
       URI: "http://acs.amazonaws.com/groups/global/AllUsers"
      }, 
      Permission: "READ"
     }
    ], 
    TargetPrefix: "MyBucketLogs/"
   }
  }
 };
 s3.putBucketLogging(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the putBucketLogging operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  BucketLoggingStatus: { /* required */
    LoggingEnabled: {
      TargetBucket: 'STRING_VALUE', /* required */
      TargetPrefix: 'STRING_VALUE', /* required */
      TargetGrants: [
        {
          Grantee: {
            Type: CanonicalUser | AmazonCustomerByEmail | Group, /* required */
            DisplayName: 'STRING_VALUE',
            EmailAddress: 'STRING_VALUE',
            ID: 'STRING_VALUE',
            URI: 'STRING_VALUE'
          },
          Permission: FULL_CONTROL | READ | WRITE
        },
        /* more items */
      ]
    }
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketLogging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which to set the logging parameters.

    • BucketLoggingStatus — (map)

      Container for logging status information.

      • LoggingEnabled — (map)

        Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference.

        • TargetBucket — required — (String)

          Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.

        • TargetGrants — (Array<map>)

          Container for granting information.

          • Grantee — (map)

            Container for the person being granted permissions.

            • DisplayName — (String)

              Screen name of the grantee.

            • EmailAddress — (String)

              Email address of the grantee.

              Note: Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
              • US East (N. Virginia)
              • US West (N. California)
              • US West (Oregon)
              • Asia Pacific (Singapore)
              • Asia Pacific (Sydney)
              • Asia Pacific (Tokyo)
              • Europe (Ireland)
              • South America (São Paulo)
              For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
            • ID — (String)

              The canonical user ID of the grantee.

            • Type — required — (String)

              Type of grantee

              Possible values include:
              • "CanonicalUser"
              • "AmazonCustomerByEmail"
              • "Group"
            • URI — (String)

              URI of the grantee group.

          • Permission — (String)

            Logging permissions assigned to the grantee for the bucket.

            Possible values include:
            • "FULL_CONTROL"
            • "READ"
            • "WRITE"
        • TargetPrefix — required — (String)

          A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

    • ContentMD5 — (String)

      The MD5 hash of the PutBucketLogging request body.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketMetricsConfiguration(params = {}, callback) ⇒ AWS.Request

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to PutBucketMetricsConfiguration:

GetBucketLifecycle has the following special error:

  • Error code: TooManyConfigurations

    • Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

    • HTTP Status Code: HTTP 400 Bad Request

Service Reference:

Examples:

Calling the putBucketMetricsConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  MetricsConfiguration: { /* required */
    Id: 'STRING_VALUE', /* required */
    Filter: {
      AccessPointArn: 'STRING_VALUE',
      And: {
        AccessPointArn: 'STRING_VALUE',
        Prefix: 'STRING_VALUE',
        Tags: [
          {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      Prefix: 'STRING_VALUE',
      Tag: {
        Key: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE' /* required */
      }
    }
  },
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketMetricsConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket for which the metrics configuration is set.

    • Id — (String)

      The ID used to identify the metrics configuration.

    • MetricsConfiguration — (map)

      Specifies the metrics configuration.

      • Id — required — (String)

        The ID used to identify the metrics configuration.

      • Filter — (map)

        Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).

        • Prefix — (String)

          The prefix used when evaluating a metrics filter.

        • Tag — (map)

          The tag used when evaluating a metrics filter.

          • Key — required — (String)

            Name of the object key.

          • Value — required — (String)

            Value of the tag.

        • AccessPointArn — (String)

          The access point ARN used when evaluating a metrics filter.

        • And — (map)

          A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

          • Prefix — (String)

            The prefix used when evaluating an AND predicate.

          • Tags — (Array<map>)

            The list of tags used when evaluating an AND predicate.

            • Key — required — (String)

              Name of the object key.

            • Value — required — (String)

              Value of the tag.

          • AccessPointArn — (String)

            The access point ARN used when evaluating an AND predicate.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketNotification(params = {}, callback) ⇒ AWS.Request

No longer used, see the PutBucketNotificationConfiguration operation.

Service Reference:

Examples:

Calling the putBucketNotification operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  NotificationConfiguration: { /* required */
    CloudFunctionConfiguration: {
      CloudFunction: 'STRING_VALUE',
      Event: s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold,
      Events: [
        s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold,
        /* more items */
      ],
      Id: 'STRING_VALUE',
      InvocationRole: 'STRING_VALUE'
    },
    QueueConfiguration: {
      Event: s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold,
      Events: [
        s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold,
        /* more items */
      ],
      Id: 'STRING_VALUE',
      Queue: 'STRING_VALUE'
    },
    TopicConfiguration: {
      Event: s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold,
      Events: [
        s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold,
        /* more items */
      ],
      Id: 'STRING_VALUE',
      Topic: 'STRING_VALUE'
    }
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketNotification(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket.

    • ContentMD5 — (String)

      The MD5 hash of the PutPublicAccessBlock request body.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • NotificationConfiguration — (map)

      The container for the configuration.

      • TopicConfiguration — (map)

        This data type is deprecated. A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

        • Id — (String)

          An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        • Events — (Array<String>)

          A collection of events related to objects

        • Event — (String)

          Bucket event for which to send notifications.

          Possible values include:
          • "s3:ReducedRedundancyLostObject"
          • "s3:ObjectCreated:*"
          • "s3:ObjectCreated:Put"
          • "s3:ObjectCreated:Post"
          • "s3:ObjectCreated:Copy"
          • "s3:ObjectCreated:CompleteMultipartUpload"
          • "s3:ObjectRemoved:*"
          • "s3:ObjectRemoved:Delete"
          • "s3:ObjectRemoved:DeleteMarkerCreated"
          • "s3:ObjectRestore:*"
          • "s3:ObjectRestore:Post"
          • "s3:ObjectRestore:Completed"
          • "s3:Replication:*"
          • "s3:Replication:OperationFailedReplication"
          • "s3:Replication:OperationNotTracked"
          • "s3:Replication:OperationMissedThreshold"
          • "s3:Replication:OperationReplicatedAfterThreshold"
        • Topic — (String)

          Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.

      • QueueConfiguration — (map)

        This data type is deprecated. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

        • Id — (String)

          An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        • Event — (String)

          The bucket event for which to send notifications.

          Possible values include:
          • "s3:ReducedRedundancyLostObject"
          • "s3:ObjectCreated:*"
          • "s3:ObjectCreated:Put"
          • "s3:ObjectCreated:Post"
          • "s3:ObjectCreated:Copy"
          • "s3:ObjectCreated:CompleteMultipartUpload"
          • "s3:ObjectRemoved:*"
          • "s3:ObjectRemoved:Delete"
          • "s3:ObjectRemoved:DeleteMarkerCreated"
          • "s3:ObjectRestore:*"
          • "s3:ObjectRestore:Post"
          • "s3:ObjectRestore:Completed"
          • "s3:Replication:*"
          • "s3:Replication:OperationFailedReplication"
          • "s3:Replication:OperationNotTracked"
          • "s3:Replication:OperationMissedThreshold"
          • "s3:Replication:OperationReplicatedAfterThreshold"
        • Events — (Array<String>)

          A collection of bucket events for which to send notifications.

        • Queue — (String)

          The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

      • CloudFunctionConfiguration — (map)

        Container for specifying the Lambda notification configuration.

        • Id — (String)

          An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        • Event — (String)

          The bucket event for which to send notifications.

          Possible values include:
          • "s3:ReducedRedundancyLostObject"
          • "s3:ObjectCreated:*"
          • "s3:ObjectCreated:Put"
          • "s3:ObjectCreated:Post"
          • "s3:ObjectCreated:Copy"
          • "s3:ObjectCreated:CompleteMultipartUpload"
          • "s3:ObjectRemoved:*"
          • "s3:ObjectRemoved:Delete"
          • "s3:ObjectRemoved:DeleteMarkerCreated"
          • "s3:ObjectRestore:*"
          • "s3:ObjectRestore:Post"
          • "s3:ObjectRestore:Completed"
          • "s3:Replication:*"
          • "s3:Replication:OperationFailedReplication"
          • "s3:Replication:OperationNotTracked"
          • "s3:Replication:OperationMissedThreshold"
          • "s3:Replication:OperationReplicatedAfterThreshold"
        • Events — (Array<String>)

          Bucket events for which to send notifications.

        • CloudFunction — (String)

          Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.

        • InvocationRole — (String)

          The role supporting the invocation of the Lambda function

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketNotificationConfiguration(params = {}, callback) ⇒ AWS.Request

Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.

Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.

By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration.

<NotificationConfiguration>

</NotificationConfiguration>

This action replaces the existing notification configuration with the configuration you include in the request body.

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.

You can disable notifications by adding the empty NotificationConfiguration element.

By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission.

Note: The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.

Responses

If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic.

The following action is related to PutBucketNotificationConfiguration:

Service Reference:

Examples:

Set notification configuration for a bucket


/* The following example sets notification configuration on a bucket to publish the object created events to an SNS topic. */

 var params = {
  Bucket: "examplebucket", 
  NotificationConfiguration: {
   TopicConfigurations: [
      {
     Events: [
        "s3:ObjectCreated:*"
     ], 
     TopicArn: "arn:aws:sns:us-west-2:123456789012:s3-notification-topic"
    }
   ]
  }
 };
 s3.putBucketNotificationConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the putBucketNotificationConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  NotificationConfiguration: { /* required */
    LambdaFunctionConfigurations: [
      {
        Events: [ /* required */
          s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold,
          /* more items */
        ],
        LambdaFunctionArn: 'STRING_VALUE', /* required */
        Filter: {
          Key: {
            FilterRules: [
              {
                Name: prefix | suffix,
                Value: 'STRING_VALUE'
              },
              /* more items */
            ]
          }
        },
        Id: 'STRING_VALUE'
      },
      /* more items */
    ],
    QueueConfigurations: [
      {
        Events: [ /* required */
          s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold,
          /* more items */
        ],
        QueueArn: 'STRING_VALUE', /* required */
        Filter: {
          Key: {
            FilterRules: [
              {
                Name: prefix | suffix,
                Value: 'STRING_VALUE'
              },
              /* more items */
            ]
          }
        },
        Id: 'STRING_VALUE'
      },
      /* more items */
    ],
    TopicConfigurations: [
      {
        Events: [ /* required */
          s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold,
          /* more items */
        ],
        TopicArn: 'STRING_VALUE', /* required */
        Filter: {
          Key: {
            FilterRules: [
              {
                Name: prefix | suffix,
                Value: 'STRING_VALUE'
              },
              /* more items */
            ]
          }
        },
        Id: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketNotificationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket.

    • NotificationConfiguration — (map)

      A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

      • TopicConfigurations — (Array<map>)

        The topic to which notifications are sent and the events for which notifications are generated.

        • Id — (String)

          An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        • TopicArn — required — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.

        • Events — required — (Array<String>)

          The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon S3 User Guide.

        • Filter — (map)

          Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon S3 User Guide.

          • Key — (map)

            A container for object key name prefix and suffix filtering rules.

            • FilterRules — (Array<map>)

              A list of containers for the key-value pair that defines the criteria for the filter rule.

              • Name — (String)

                The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.

                Possible values include:
                • "prefix"
                • "suffix"
              • Value — (String)

                The value that the filter searches for in object key names.

      • QueueConfigurations — (Array<map>)

        The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.

        • Id — (String)

          An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        • QueueArn — required — (String)

          The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

        • Events — required — (Array<String>)

          A collection of bucket events for which to send notifications

        • Filter — (map)

          Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon S3 User Guide.

          • Key — (map)

            A container for object key name prefix and suffix filtering rules.

            • FilterRules — (Array<map>)

              A list of containers for the key-value pair that defines the criteria for the filter rule.

              • Name — (String)

                The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.

                Possible values include:
                • "prefix"
                • "suffix"
              • Value — (String)

                The value that the filter searches for in object key names.

      • LambdaFunctionConfigurations — (Array<map>)

        Describes the Lambda functions to invoke and the events for which to invoke them.

        • Id — (String)

          An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

        • LambdaFunctionArn — required — (String)

          The Amazon Resource Name (ARN) of the Lambda function that Amazon S3 invokes when the specified event type occurs.

        • Events — required — (Array<String>)

          The Amazon S3 bucket event for which to invoke the Lambda function. For more information, see Supported Event Types in the Amazon S3 User Guide.

        • Filter — (map)

          Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon S3 User Guide.

          • Key — (map)

            A container for object key name prefix and suffix filtering rules.

            • FilterRules — (Array<map>)

              A list of containers for the key-value pair that defines the criteria for the filter rule.

              • Name — (String)

                The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.

                Possible values include:
                • "prefix"
                • "suffix"
              • Value — (String)

                The value that the filter searches for in object key names.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketOwnershipControls(params = {}, callback) ⇒ AWS.Request

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to PutBucketOwnershipControls:

Service Reference:

Examples:

Calling the putBucketOwnershipControls operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  OwnershipControls: { /* required */
    Rules: [ /* required */
      {
        ObjectOwnership: BucketOwnerPreferred | ObjectWriter /* required */
      },
      /* more items */
    ]
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketOwnershipControls(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the Amazon S3 bucket whose OwnershipControls you want to set.

    • ContentMD5 — (String)

      The MD5 hash of the OwnershipControls request body.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

    • OwnershipControls — (map)

      The OwnershipControls (BucketOwnerPreferred or ObjectWriter) that you want to apply to this Amazon S3 bucket.

      • Rules — required — (Array<map>)

        The container element for an ownership control rule.

        • ObjectOwnership — required — (String)

          The container element for object ownership for a bucket's ownership controls.

          BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.

          ObjectWriter - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.

          Possible values include:
          • "BucketOwnerPreferred"
          • "ObjectWriter"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketPolicy(params = {}, callback) ⇒ AWS.Request

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information, see Bucket policy examples.

The following operations are related to PutBucketPolicy:

Service Reference:

Examples:

Set bucket policy


/* The following example sets a permission policy on a bucket. */

 var params = {
  Bucket: "examplebucket", 
  Policy: "{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"id-1\",\"Effect\": \"Allow\",\"Principal\": {\"AWS\": \"arn:aws:iam::123456789012:root\"}, \"Action\": [ \"s3:PutObject\",\"s3:PutObjectAcl\"], \"Resource\": [\"arn:aws:s3:::acl3/*\" ] } ]}"
 };
 s3.putBucketPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the putBucketPolicy operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE', /* required */
  ConfirmRemoveSelfBucketAccess: true || false,
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket.

    • ContentMD5 — (String)

      The MD5 hash of the request body.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • ConfirmRemoveSelfBucketAccess — (Boolean)

      Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

    • Policy — (String)

      The bucket policy as a JSON document.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketReplication(params = {}, callback) ⇒ AWS.Request

Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.

A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset.

To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority.

Note: If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.

For information about enabling versioning on a bucket, see Using Versioning.

Handling Replication of Encrypted Objects

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using KMS keys.

For information on PutBucketReplication errors, see List of replication-related error codes

Permissions

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration permissions for the bucket.

By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.

Note: To perform this operation, the user or role performing the action must have the iam:PassRole permission.

The following operations are related to PutBucketReplication:

Service Reference:

Examples:

Set replication configuration on a bucket


/* The following example sets replication configuration on a bucket. */

 var params = {
  Bucket: "examplebucket", 
  ReplicationConfiguration: {
   Role: "arn:aws:iam::123456789012:role/examplerole", 
   Rules: [
      {
     Destination: {
      Bucket: "arn:aws:s3:::destinationbucket", 
      StorageClass: "STANDARD"
     }, 
     Prefix: "", 
     Status: "Enabled"
    }
   ]
  }
 };
 s3.putBucketReplication(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the putBucketReplication operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ReplicationConfiguration: { /* required */
    Role: 'STRING_VALUE', /* required */
    Rules: [ /* required */
      {
        Destination: { /* required */
          Bucket: 'STRING_VALUE', /* required */
          AccessControlTranslation: {
            Owner: Destination /* required */
          },
          Account: 'STRING_VALUE',
          EncryptionConfiguration: {
            ReplicaKmsKeyID: 'STRING_VALUE'
          },
          Metrics: {
            Status: Enabled | Disabled, /* required */
            EventThreshold: {
              Minutes: 'NUMBER_VALUE'
            }
          },
          ReplicationTime: {
            Status: Enabled | Disabled, /* required */
            Time: { /* required */
              Minutes: 'NUMBER_VALUE'
            }
          },
          StorageClass: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS
        },
        Status: Enabled | Disabled, /* required */
        DeleteMarkerReplication: {
          Status: Enabled | Disabled
        },
        ExistingObjectReplication: {
          Status: Enabled | Disabled /* required */
        },
        Filter: {
          And: {
            Prefix: 'STRING_VALUE',
            Tags: [
              {
                Key: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          },
          Prefix: 'STRING_VALUE',
          Tag: {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          }
        },
        ID: 'STRING_VALUE',
        Prefix: 'STRING_VALUE',
        Priority: 'NUMBER_VALUE',
        SourceSelectionCriteria: {
          ReplicaModifications: {
            Status: Enabled | Disabled /* required */
          },
          SseKmsEncryptedObjects: {
            Status: Enabled | Disabled /* required */
          }
        }
      },
      /* more items */
    ]
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  Token: 'STRING_VALUE'
};
s3.putBucketReplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the bucket

    • ContentMD5 — (String)

      The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • ReplicationConfiguration — (map)

      A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

      • Role — required — (String)

        The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Replication in the Amazon S3 User Guide.

      • Rules — required — (Array<map>)

        A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.

        • ID — (String)

          A unique identifier for the rule. The maximum value is 255 characters.

        • Priority — (Integer)

          The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

          For more information, see Replication in the Amazon S3 User Guide.

        • Prefix — (String)

          An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.

          Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

        • Filter — (map)

          A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix, Tag, or an And child element.

          • Prefix — (String)

            An object key name prefix that identifies the subset of objects to which the rule applies.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

          • Tag — (map)

            A container for specifying a tag key and value.

            The rule applies only to objects that have the tag in their tag set.

            • Key — required — (String)

              Name of the object key.

            • Value — required — (String)

              Value of the tag.

          • And — (map)

            A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example:

            • If you specify both a Prefix and a Tag filter, wrap these filters in an And tag.

            • If you specify a filter based on multiple tags, wrap the Tag elements in an And tag.

            • Prefix — (String)

              An object key name prefix that identifies the subset of objects to which the rule applies.

            • Tags — (Array<map>)

              An array of tags containing key and value pairs.

              • Key — required — (String)

                Name of the object key.

              • Value — required — (String)

                Value of the tag.

        • Status — required — (String)

          Specifies whether the rule is enabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • SourceSelectionCriteria — (map)

          A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

          • SseKmsEncryptedObjects — (map)

            A container for filter information for the selection of Amazon S3 objects encrypted with Amazon Web Services KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required.

            • Status — required — (String)

              Specifies whether Amazon S3 replicates objects created with server-side encryption using an Amazon Web Services KMS key stored in Amazon Web Services Key Management Service.

              Possible values include:
              • "Enabled"
              • "Disabled"
          • ReplicaModifications — (map)

            A filter that you can specify for selections for modifications on replicas. Amazon S3 doesn't replicate replica modifications by default. In the latest version of replication configuration (when Filter is specified), you can specify this element and set the status to Enabled to replicate modifications on replicas.

            Note: If you don't specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed
            • Status — required — (String)

              Specifies whether Amazon S3 replicates modifications on replicas.

              Possible values include:
              • "Enabled"
              • "Disabled"
        • ExistingObjectReplication — (map)

          • Status — required — (String)

            Possible values include:

            • "Enabled"
            • "Disabled"
        • Destination — required — (map)

          A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).

          • Bucket — required — (String)

            The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.

          • Account — (String)

            Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the Amazon Web Services account that owns the destination bucket by specifying the AccessControlTranslation property, this is the account ID of the destination bucket owner. For more information, see Replication Additional Configuration: Changing the Replica Owner in the Amazon S3 User Guide.

          • StorageClass — (String)

            The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.

            For valid values, see the StorageClass element of the PUT Bucket replication action in the Amazon S3 API Reference.

            Possible values include:
            • "STANDARD"
            • "REDUCED_REDUNDANCY"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "GLACIER"
            • "DEEP_ARCHIVE"
            • "OUTPOSTS"
          • AccessControlTranslation — (map)

            Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the Amazon Web Services account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same Amazon Web Services account that owns the source object.

            • Owner — required — (String)

              Specifies the replica ownership. For default and valid values, see PUT bucket replication in the Amazon S3 API Reference.

              Possible values include:
              • "Destination"
          • EncryptionConfiguration — (map)

            A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element.

            • ReplicaKmsKeyID — (String)

              Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key stored in Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric, customer managed KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

          • ReplicationTime — (map)

            A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a Metrics block.

            • Status — required — (String)

              Specifies whether the replication time is enabled.

              Possible values include:
              • "Enabled"
              • "Disabled"
            • Time — required — (map)

              A container specifying the time by which replication should be complete for all objects and operations on objects.

              • Minutes — (Integer)

                Contains an integer specifying time in minutes.

                Valid value: 15

          • Metrics — (map)

            A container specifying replication metrics-related settings enabling replication metrics and events.

            • Status — required — (String)

              Specifies whether the replication metrics are enabled.

              Possible values include:
              • "Enabled"
              • "Disabled"
            • EventThreshold — (map)

              A container specifying the time threshold for emitting the s3:Replication:OperationMissedThreshold event.

              • Minutes — (Integer)

                Contains an integer specifying time in minutes.

                Valid value: 15

        • DeleteMarkerReplication — (map)

          Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

          For more information about delete marker replication, see Basic Rule Configuration.

          Note: If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.
          • Status — (String)

            Indicates whether to replicate delete markers.

            Note: Indicates whether to replicate delete markers.
            Possible values include:
            • "Enabled"
            • "Disabled"
    • Token — (String)

      A token to allow Object Lock to be enabled for an existing bucket.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketRequestPayment(params = {}, callback) ⇒ AWS.Request

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

The following operations are related to PutBucketRequestPayment:

Service Reference:

Examples:

Set request payment configuration on a bucket.


/* The following example sets request payment configuration on a bucket so that person requesting the download is charged. */

 var params = {
  Bucket: "examplebucket", 
  RequestPaymentConfiguration: {
   Payer: "Requester"
  }
 };
 s3.putBucketRequestPayment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the putBucketRequestPayment operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  RequestPaymentConfiguration: { /* required */
    Payer: Requester | BucketOwner /* required */
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketRequestPayment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name.

    • ContentMD5 — (String)

      The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • RequestPaymentConfiguration — (map)

      Container for Payer.

      • Payer — required — (String)

        Specifies who pays for the download and request fees.

        Possible values include:
        • "Requester"
        • "BucketOwner"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketTagging(params = {}, callback) ⇒ AWS.Request

Sets the tags for a bucket.

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging and Using Cost Allocation in Amazon S3 Bucket Tags.

Note: When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.

To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

PutBucketTagging has the following special errors:

  • Error code: InvalidTagError

  • Error code: MalformedXMLError

    • Description: The XML provided does not match the schema.

  • Error code: OperationAbortedError

    • Description: A conflicting conditional action is currently in progress against this resource. Please try again.

  • Error code: InternalError

    • Description: The service was unable to apply the provided tag to the bucket.

The following operations are related to PutBucketTagging:

Service Reference:

Examples:

Set tags on a bucket


/* The following example sets tags on a bucket. Any existing tags are replaced. */

 var params = {
  Bucket: "examplebucket", 
  Tagging: {
   TagSet: [
      {
     Key: "Key1", 
     Value: "Value1"
    }, 
      {
     Key: "Key2", 
     Value: "Value2"
    }
   ]
  }
 };
 s3.putBucketTagging(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the putBucketTagging operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Tagging: { /* required */
    TagSet: [ /* required */
      {
        Key: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketTagging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name.

    • ContentMD5 — (String)

      The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • Tagging — (map)

      Container for the TagSet and Tag elements.

      • TagSet — required — (Array<map>)

        A collection for a set of tags

        • Key — required — (String)

          Name of the object key.

        • Value — required — (String)

          Value of the tag.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketVersioning(params = {}, callback) ⇒ AWS.Request

Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

You can set the versioning state with one of the following values:

Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.

Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.

If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.

If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket.

If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.

Related Resources

Service Reference:

Examples:

Set versioning configuration on a bucket


/* The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket. */

 var params = {
  Bucket: "examplebucket", 
  VersioningConfiguration: {
   MFADelete: "Disabled", 
   Status: "Enabled"
  }
 };
 s3.putBucketVersioning(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the putBucketVersioning operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  VersioningConfiguration: { /* required */
    MFADelete: Enabled | Disabled,
    Status: Enabled | Suspended
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  MFA: 'STRING_VALUE'
};
s3.putBucketVersioning(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name.

    • ContentMD5 — (String)

      >The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • MFA — (String)

      The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

    • VersioningConfiguration — (map)

      Container for setting the versioning state.

      • MFADelete — (String)

        Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

        Possible values include:
        • "Enabled"
        • "Disabled"
      • Status — (String)

        The versioning state of the bucket.

        Possible values include:
        • "Enabled"
        • "Suspended"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBucketWebsite(params = {}, callback) ⇒ AWS.Request

Sets the configuration of the website that is specified in the website subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3.

This PUT action requires the S3:PutBucketWebsite permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite permission.

To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.

  • WebsiteConfiguration

  • RedirectAllRequestsTo

  • HostName

  • Protocol

If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.

  • WebsiteConfiguration

  • IndexDocument

  • Suffix

  • ErrorDocument

  • Key

  • RoutingRules

  • RoutingRule

  • Condition

  • HttpErrorCodeReturnedEquals

  • KeyPrefixEquals

  • Redirect

  • Protocol

  • HostName

  • ReplaceKeyPrefixWith

  • ReplaceKeyWith

  • HttpRedirectCode

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon S3 User Guide.

Service Reference:

Examples:

Set website configuration on a bucket


/* The following example adds website configuration to a bucket. */

 var params = {
  Bucket: "examplebucket", 
  ContentMD5: "", 
  WebsiteConfiguration: {
   ErrorDocument: {
    Key: "error.html"
   }, 
   IndexDocument: {
    Suffix: "index.html"
   }
  }
 };
 s3.putBucketWebsite(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the putBucketWebsite operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  WebsiteConfiguration: { /* required */
    ErrorDocument: {
      Key: 'STRING_VALUE' /* required */
    },
    IndexDocument: {
      Suffix: 'STRING_VALUE' /* required */
    },
    RedirectAllRequestsTo: {
      HostName: 'STRING_VALUE', /* required */
      Protocol: http | https
    },
    RoutingRules: [
      {
        Redirect: { /* required */
          HostName: 'STRING_VALUE',
          HttpRedirectCode: 'STRING_VALUE',
          Protocol: http | https,
          ReplaceKeyPrefixWith: 'STRING_VALUE',
          ReplaceKeyWith: 'STRING_VALUE'
        },
        Condition: {
          HttpErrorCodeReturnedEquals: 'STRING_VALUE',
          KeyPrefixEquals: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putBucketWebsite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name.

    • ContentMD5 — (String)

      The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • WebsiteConfiguration — (map)

      Container for the request.

      • ErrorDocument — (map)

        The name of the error document for the website.

        • Key — required — (String)

          The object key name to use when a 4XX class error occurs.

          Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

      • IndexDocument — (map)

        The name of the index document for the website.

        • Suffix — required — (String)

          A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.

          Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

      • RedirectAllRequestsTo — (map)

        The redirect behavior for every request to this bucket's website endpoint.

        If you specify this property, you can't specify any other property.
        • HostName — required — (String)

          Name of the host where requests are redirected.

        • Protocol — (String)

          Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

          Possible values include:
          • "http"
          • "https"
      • RoutingRules — (Array<map>)

        Rules that define when a redirect is applied and the redirect behavior.

        • Condition — (map)

          A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

          • HttpErrorCodeReturnedEquals — (String)

            The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

          • KeyPrefixEquals — (String)

            The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

        • Redirect — required — (map)

          Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.

          • HostName — (String)

            The host name to use in the redirect request.

          • HttpRedirectCode — (String)

            The HTTP redirect code to use on the response. Not required if one of the siblings is present.

          • Protocol — (String)

            Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

            Possible values include:
            • "http"
            • "https"
          • ReplaceKeyPrefixWith — (String)

            The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

          • ReplaceKeyWith — (String)

            The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putObject(params = {}, callback) ⇒ AWS.Request

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.

Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.

To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

Note:
  • To successfully complete the PutObject request, you must have the s3:PutObject in your IAM permissions.
  • To successfully change the objects acl of your PutObject request, you must have the s3:PutObjectAcl in your IAM permissions.
  • The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon S3 User Guide.

Server-side Encryption

You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side Encryption.

If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

Access Control List (ACL)-Specific Request Headers

You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

Storage Class Options

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Versioning

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.

For more information about versioning, see Adding Objects to Versioning Enabled Buckets. For information about returning the versioning state of a bucket, see GetBucketVersioning.

Related Resources

Service Reference:

Examples:

To upload an object and specify optional tags


/* The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object. */

 var params = {
  Body: <Binary String>, 
  Bucket: "examplebucket", 
  Key: "HappyFace.jpg", 
  Tagging: "key1=value1&key2=value2"
 };
 s3.putObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ETag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
    VersionId: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
   }
   */
 });

To upload an object and specify canned ACL.


/* The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response. */

 var params = {
  ACL: "authenticated-read", 
  Body: <Binary String>, 
  Bucket: "examplebucket", 
  Key: "exampleobject"
 };
 s3.putObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ETag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
    VersionId: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr"
   }
   */
 });

To upload an object and specify server-side encryption and object tags


/* The following example uploads and object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response. */

 var params = {
  Body: <Binary String>, 
  Bucket: "examplebucket", 
  Key: "exampleobject", 
  ServerSideEncryption: "AES256", 
  Tagging: "key1=value1&key2=value2"
 };
 s3.putObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ETag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
    ServerSideEncryption: "AES256", 
    VersionId: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
   }
   */
 });

To create an object.


/* The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response. */

 var params = {
  Body: <Binary String>, 
  Bucket: "examplebucket", 
  Key: "objectkey"
 };
 s3.putObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ETag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
    VersionId: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
   }
   */
 });

To upload an object


/* The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object. */

 var params = {
  Body: <Binary String>, 
  Bucket: "examplebucket", 
  Key: "HappyFace.jpg"
 };
 s3.putObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ETag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
    VersionId: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk"
   }
   */
 });

To upload an object (specify optional headers)


/* The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption. */

 var params = {
  Body: <Binary String>, 
  Bucket: "examplebucket", 
  Key: "HappyFace.jpg", 
  ServerSideEncryption: "AES256", 
  StorageClass: "STANDARD_IA"
 };
 s3.putObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ETag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
    ServerSideEncryption: "AES256", 
    VersionId: "CG612hodqujkf8FaaNfp8U..FIhLROcp"
   }
   */
 });

To upload object and specify user-defined metadata


/* The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response. */

 var params = {
  Body: <Binary String>, 
  Bucket: "examplebucket", 
  Key: "exampleobject", 
  Metadata: {
   "metadata1": "value1", 
   "metadata2": "value2"
  }
 };
 s3.putObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ETag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
    VersionId: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
   }
   */
 });

Calling the putObject operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ACL: private | public-read | public-read-write | authenticated-read | aws-exec-read | bucket-owner-read | bucket-owner-full-control,
  Body: Buffer.from('...') || 'STRING_VALUE' || streamObject,
  BucketKeyEnabled: true || false,
  CacheControl: 'STRING_VALUE',
  ContentDisposition: 'STRING_VALUE',
  ContentEncoding: 'STRING_VALUE',
  ContentLanguage: 'STRING_VALUE',
  ContentLength: 'NUMBER_VALUE',
  ContentMD5: 'STRING_VALUE',
  ContentType: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  Expires: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  GrantFullControl: 'STRING_VALUE',
  GrantRead: 'STRING_VALUE',
  GrantReadACP: 'STRING_VALUE',
  GrantWriteACP: 'STRING_VALUE',
  Metadata: {
    '<MetadataKey>': 'STRING_VALUE',
    /* '<MetadataKey>': ... */
  },
  ObjectLockLegalHoldStatus: ON | OFF,
  ObjectLockMode: GOVERNANCE | COMPLIANCE,
  ObjectLockRetainUntilDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  RequestPayer: requester,
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SSECustomerKeyMD5: 'STRING_VALUE',
  SSEKMSEncryptionContext: 'STRING_VALUE',
  SSEKMSKeyId: 'STRING_VALUE',
  ServerSideEncryption: AES256 | aws:kms,
  StorageClass: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS,
  Tagging: 'STRING_VALUE',
  WebsiteRedirectLocation: 'STRING_VALUE'
};
s3.putObject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ACL — (String)

      The canned ACL to apply to the object. For more information, see Canned ACL.

      This action is not supported by Amazon S3 on Outposts.

      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
      • "aws-exec-read"
      • "bucket-owner-read"
      • "bucket-owner-full-control"
    • Body — (Buffer, Typed Array, Blob, String, ReadableStream)

      Object data.

    • Bucket — (String)

      The bucket name to which the PUT action was initiated.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • CacheControl — (String)

      Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

    • ContentDisposition — (String)

      Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

    • ContentEncoding — (String)

      Specifies 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, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

    • ContentLanguage — (String)

      The language the content is in.

    • ContentLength — (Integer)

      Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

    • ContentMD5 — (String)

      The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

    • ContentType — (String)

      A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

    • Expires — (Date)

      The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

    • GrantFullControl — (String)

      Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

      This action is not supported by Amazon S3 on Outposts.

    • GrantRead — (String)

      Allows grantee to read the object data and its metadata.

      This action is not supported by Amazon S3 on Outposts.

    • GrantReadACP — (String)

      Allows grantee to read the object ACL.

      This action is not supported by Amazon S3 on Outposts.

    • GrantWriteACP — (String)

      Allows grantee to write the ACL for the applicable object.

      This action is not supported by Amazon S3 on Outposts.

    • Key — (String)

      Object key for which the PUT action was initiated.

    • Metadata — (map<String>)

      A map of metadata to store with the object in S3.

    • ServerSideEncryption — (String)

      The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

      Possible values include:
      • "AES256"
      • "aws:kms"
    • StorageClass — (String)

      By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

      Possible values include:
      • "STANDARD"
      • "REDUCED_REDUNDANCY"
      • "STANDARD_IA"
      • "ONEZONE_IA"
      • "INTELLIGENT_TIERING"
      • "GLACIER"
      • "DEEP_ARCHIVE"
      • "OUTPOSTS"
    • WebsiteRedirectLocation — (String)

      If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

      In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

      x-amz-website-redirect-location: /anotherPage.html

      In the following example, the request header sets the object redirect to another website:

      x-amz-website-redirect-location: http://www.example.com/

      For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

    • SSECustomerAlgorithm — (String)

      Specifies the algorithm to use to when encrypting the object (for example, AES256).

    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 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.

    • SSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    • SSEKMSKeyId — (String)

      If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.

    • SSEKMSEncryptionContext — (String)

      Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    • BucketKeyEnabled — (Boolean)

      Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

      Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • Tagging — (String)

      The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

    • ObjectLockMode — (String)

      The Object Lock mode that you want to apply to this object.

      Possible values include:
      • "GOVERNANCE"
      • "COMPLIANCE"
    • ObjectLockRetainUntilDate — (Date)

      The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.

    • ObjectLockLegalHoldStatus — (String)

      Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

      Possible values include:
      • "ON"
      • "OFF"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Expiration — (String)

        If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL encoded.

      • ETag — (String)

        Entity tag for the uploaded object.

      • ServerSideEncryption — (String)

        If you specified server-side encryption either with an Amazon Web Services KMS key or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

        Possible values include:
        • "AES256"
        • "aws:kms"
      • VersionId — (String)

        Version of the object.

      • SSECustomerAlgorithm — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

      • SSECustomerKeyMD5 — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

      • SSEKMSKeyId — (String)

        If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

      • SSEKMSEncryptionContext — (String)

        If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

      • BucketKeyEnabled — (Boolean)

        Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putObjectAcl(params = {}, callback) ⇒ AWS.Request

Uses the acl subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have WRITE_ACP permission to set the ACL of an object. For more information, see What permissions can I grant? in the Amazon S3 User Guide.

This action is not supported by Amazon S3 on Outposts.

Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

Access Permissions

You can set access permissions using one of the following methods:

  • Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.

  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

    You specify each grantee as a type=value pair, where the type is one of the following:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Note: Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
      • US East (N. Virginia)
      • US West (N. California)
      • US West (Oregon)
      • Asia Pacific (Singapore)
      • Asia Pacific (Sydney)
      • Asia Pacific (Tokyo)
      • Europe (Ireland)
      • South America (São Paulo)
      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-read header grants list objects permission to the two Amazon Web Services accounts identified by their email addresses.

    x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com"

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

Versioning

The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId subresource.

Related Resources

Service Reference:

Examples:

To grant permissions using object ACL


/* The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the AllUsers group READ permission. */

 var params = {
  AccessControlPolicy: {
  }, 
  Bucket: "examplebucket", 
  GrantFullControl: "emailaddress=user1@example.com,emailaddress=user2@example.com", 
  GrantRead: "uri=http://acs.amazonaws.com/groups/global/AllUsers", 
  Key: "HappyFace.jpg"
 };
 s3.putObjectAcl(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the putObjectAcl operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ACL: private | public-read | public-read-write | authenticated-read | aws-exec-read | bucket-owner-read | bucket-owner-full-control,
  AccessControlPolicy: {
    Grants: [
      {
        Grantee: {
          Type: CanonicalUser | AmazonCustomerByEmail | Group, /* required */
          DisplayName: 'STRING_VALUE',
          EmailAddress: 'STRING_VALUE',
          ID: 'STRING_VALUE',
          URI: 'STRING_VALUE'
        },
        Permission: FULL_CONTROL | WRITE | WRITE_ACP | READ | READ_ACP
      },
      /* more items */
    ],
    Owner: {
      DisplayName: 'STRING_VALUE',
      ID: 'STRING_VALUE'
    }
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  GrantFullControl: 'STRING_VALUE',
  GrantRead: 'STRING_VALUE',
  GrantReadACP: 'STRING_VALUE',
  GrantWrite: 'STRING_VALUE',
  GrantWriteACP: 'STRING_VALUE',
  RequestPayer: requester,
  VersionId: 'STRING_VALUE'
};
s3.putObjectAcl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ACL — (String)

      The canned ACL to apply to the object. For more information, see Canned ACL.

      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
      • "aws-exec-read"
      • "bucket-owner-read"
      • "bucket-owner-full-control"
    • AccessControlPolicy — (map)

      Contains the elements that set the ACL permissions for an object per grantee.

      • Grants — (Array<map>)

        A list of grants.

        • Grantee — (map)

          The person being granted permissions.

          • DisplayName — (String)

            Screen name of the grantee.

          • EmailAddress — (String)

            Email address of the grantee.

            Note: Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
            • US East (N. Virginia)
            • US West (N. California)
            • US West (Oregon)
            • Asia Pacific (Singapore)
            • Asia Pacific (Sydney)
            • Asia Pacific (Tokyo)
            • Europe (Ireland)
            • South America (São Paulo)
            For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
          • ID — (String)

            The canonical user ID of the grantee.

          • Type — required — (String)

            Type of grantee

            Possible values include:
            • "CanonicalUser"
            • "AmazonCustomerByEmail"
            • "Group"
          • URI — (String)

            URI of the grantee group.

        • Permission — (String)

          Specifies the permission given to the grantee.

          Possible values include:
          • "FULL_CONTROL"
          • "WRITE"
          • "WRITE_ACP"
          • "READ"
          • "READ_ACP"
      • Owner — (map)

        Container for the bucket owner's display name and ID.

        • DisplayName — (String)

          Container for the display name of the owner.

        • ID — (String)

          Container for the ID of the owner.

    • Bucket — (String)

      The bucket name that contains the object to which you want to attach the ACL.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    • ContentMD5 — (String)

      The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.>

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • GrantFullControl — (String)

      Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

      This action is not supported by Amazon S3 on Outposts.

    • GrantRead — (String)

      Allows grantee to list the objects in the bucket.

      This action is not supported by Amazon S3 on Outposts.

    • GrantReadACP — (String)

      Allows grantee to read the bucket ACL.

      This action is not supported by Amazon S3 on Outposts.

    • GrantWrite — (String)

      Allows grantee to create new objects in the bucket.

      For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

    • GrantWriteACP — (String)

      Allows grantee to write the ACL for the applicable bucket.

      This action is not supported by Amazon S3 on Outposts.

    • Key — (String)

      Key for which the PUT action was initiated.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • VersionId — (String)

      VersionId used to reference a specific version of the object.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putObjectLegalHold(params = {}, callback) ⇒ AWS.Request

Applies a Legal Hold configuration to the specified object. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

Service Reference:

Examples:

Calling the putObjectLegalHold operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  LegalHold: {
    Status: ON | OFF
  },
  RequestPayer: requester,
  VersionId: 'STRING_VALUE'
};
s3.putObjectLegalHold(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name containing the object that you want to place a Legal Hold on.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    • Key — (String)

      The key name for the object that you want to place a Legal Hold on.

    • LegalHold — (map)

      Container element for the Legal Hold configuration you want to apply to the specified object.

      • Status — (String)

        Indicates whether the specified object has a Legal Hold in place.

        Possible values include:
        • "ON"
        • "OFF"
    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • VersionId — (String)

      The version ID of the object that you want to place a Legal Hold on.

    • ContentMD5 — (String)

      The MD5 hash for the request body.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putObjectLockConfiguration(params = {}, callback) ⇒ AWS.Request

Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

Note:
  • The DefaultRetention settings require both a mode and a period.
  • The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
  • You can only enable Object Lock for new buckets. If you want to turn on Object Lock for an existing bucket, contact Amazon Web Services Support.

Service Reference:

Examples:

Calling the putObjectLockConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  ObjectLockConfiguration: {
    ObjectLockEnabled: Enabled,
    Rule: {
      DefaultRetention: {
        Days: 'NUMBER_VALUE',
        Mode: GOVERNANCE | COMPLIANCE,
        Years: 'NUMBER_VALUE'
      }
    }
  },
  RequestPayer: requester,
  Token: 'STRING_VALUE'
};
s3.putObjectLockConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket whose Object Lock configuration you want to create or replace.

    • ObjectLockConfiguration — (map)

      The Object Lock configuration that you want to apply to the specified bucket.

      • ObjectLockEnabled — (String)

        Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

        Possible values include:
        • "Enabled"
      • Rule — (map)

        Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

        • DefaultRetention — (map)

          The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

          • Mode — (String)

            The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.

            Possible values include:
            • "GOVERNANCE"
            • "COMPLIANCE"
          • Days — (Integer)

            The number of days that you want to specify for the default retention period. Must be used with Mode.

          • Years — (Integer)

            The number of years that you want to specify for the default retention period. Must be used with Mode.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • Token — (String)

      A token to allow Object Lock to be enabled for an existing bucket.

    • ContentMD5 — (String)

      The MD5 hash for the request body.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putObjectRetention(params = {}, callback) ⇒ AWS.Request

Places an Object Retention configuration on an object. For more information, see Locking Objects. Users or accounts require the s3:PutObjectRetention permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention permission.

This action is not supported by Amazon S3 on Outposts.

Permissions

When the Object Lock retention mode is set to compliance, you need s3:PutObjectRetention and s3:BypassGovernanceRetention permissions. For other requests to PutObjectRetention, only s3:PutObjectRetention permissions are required.

Service Reference:

Examples:

Calling the putObjectRetention operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  BypassGovernanceRetention: true || false,
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  RequestPayer: requester,
  Retention: {
    Mode: GOVERNANCE | COMPLIANCE,
    RetainUntilDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  VersionId: 'STRING_VALUE'
};
s3.putObjectRetention(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name that contains the object you want to apply this Object Retention configuration to.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    • Key — (String)

      The key name for the object that you want to apply this Object Retention configuration to.

    • Retention — (map)

      The container element for the Object Retention configuration.

      • Mode — (String)

        Indicates the Retention mode for the specified object.

        Possible values include:
        • "GOVERNANCE"
        • "COMPLIANCE"
      • RetainUntilDate — (Date)

        The date on which this Object Lock Retention will expire.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • VersionId — (String)

      The version ID for the object that you want to apply this Object Retention configuration to.

    • BypassGovernanceRetention — (Boolean)

      Indicates whether this action should bypass Governance-mode restrictions.

    • ContentMD5 — (String)

      The MD5 hash for the request body.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putObjectTagging(params = {}, callback) ⇒ AWS.Request

Sets the supplied tag-set to an object that already exists in a bucket.

A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.

For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.

To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others.

To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action.

For information about the Amazon S3 object tagging feature, see Object Tagging.

Special Errors

    • Code: InvalidTagError

    • Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging.

    • Code: MalformedXMLError

    • Cause: The XML provided does not match the schema.

    • Code: OperationAbortedError

    • Cause: A conflicting conditional action is currently in progress against this resource. Please try again.

    • Code: InternalError

    • Cause: The service was unable to apply the provided tag to the object.

Related Resources

Service Reference:

Examples:

To add tags to an existing object


/* The following example adds tags to an existing object. */

 var params = {
  Bucket: "examplebucket", 
  Key: "HappyFace.jpg", 
  Tagging: {
   TagSet: [
      {
     Key: "Key3", 
     Value: "Value3"
    }, 
      {
     Key: "Key4", 
     Value: "Value4"
    }
   ]
  }
 };
 s3.putObjectTagging(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    VersionId: "null"
   }
   */
 });

Calling the putObjectTagging operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  Tagging: { /* required */
    TagSet: [ /* required */
      {
        Key: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  RequestPayer: requester,
  VersionId: 'STRING_VALUE'
};
s3.putObjectTagging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name containing the object.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • Key — (String)

      Name of the object key.

    • VersionId — (String)

      The versionId of the object that the tag-set will be added to.

    • ContentMD5 — (String)

      The MD5 hash for the request body.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • Tagging — (map)

      Container for the TagSet and Tag elements

      • TagSet — required — (Array<map>)

        A collection for a set of tags

        • Key — required — (String)

          Name of the object key.

        • Value — required — (String)

          Value of the tag.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VersionId — (String)

        The versionId of the object the tag-set was added to.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putPublicAccessBlock(params = {}, callback) ⇒ AWS.Request

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".

Related Resources

Service Reference:

Examples:

Calling the putPublicAccessBlock operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  PublicAccessBlockConfiguration: { /* required */
    BlockPublicAcls: true || false,
    BlockPublicPolicy: true || false,
    IgnorePublicAcls: true || false,
    RestrictPublicBuckets: true || false
  },
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE'
};
s3.putPublicAccessBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.

    • ContentMD5 — (String)

      The MD5 hash of the PutPublicAccessBlock request body.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    • PublicAccessBlockConfiguration — (map)

      The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

      • BlockPublicAcls — (Boolean)

        Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior:

        • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

        • PUT Object calls fail if the request includes a public ACL.

        • PUT Bucket calls fail if the request includes a public ACL.

        Enabling this setting doesn't affect existing policies or ACLs.

      • IgnorePublicAcls — (Boolean)

        Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.

        Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

      • BlockPublicPolicy — (Boolean)

        Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

        Enabling this setting doesn't affect existing bucket policies.

      • RestrictPublicBuckets — (Boolean)

        Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only Amazon Web Service principals and authorized users within this account if the bucket has a public policy.

        Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restoreObject(params = {}, callback) ⇒ AWS.Request

Restores an archived copy of an object back into Amazon S3

This action is not supported by Amazon S3 on Outposts.

This action performs the following types of requests:

  • select - Perform a select query on an archived object

  • restore an archive - Restore an archived object

To use this operation, you must have permissions to perform the s3:RestoreObject action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

Querying Archives with Select Requests

You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon S3 User Guide.

When making a select request, do the following:

  • Define an output location for the select query's output. This must be an Amazon S3 bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is being queried. The Amazon Web Services account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon S3 User Guide.

    For more information about the S3 structure in the request body, see the following:

  • Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples.

    • The following expression returns all records from the specified object.

      SELECT * FROM Object

    • Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.

      SELECT s._1, s._2 FROM Object s WHERE s._3 > 100

    • If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names.

      SELECT s.Id, s.FirstName, s.SSN FROM S3Object s

For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide.

When making a select request, you can also do the following:

  • To expedite your queries, specify the Expedited tier. For more information about tiers, see "Restoring Archives," later in this topic.

  • Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.

The following are additional important facts about the select feature:

  • The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.

  • You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.

  • Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409.

Restoring objects

Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in Archive Access or Deep Archive Access tiers you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage classes you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify.

To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.

When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier element of the request body:

  • Expedited - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.

  • Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

  • Bulk - Bulk retrievals are the lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.

For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User Guide.

To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon S3 User Guide.

After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.

If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon S3 User Guide.

Responses

A successful action returns either the 200 OK or 202 Accepted status code.

  • If the object is not previously restored, then Amazon S3 returns 202 Accepted in the response.

  • If the object is previously restored, Amazon S3 returns 200 OK in the response.

Special Errors

    • Code: RestoreAlreadyInProgress

    • Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)

    • HTTP Status Code: 409 Conflict

    • SOAP Fault Code Prefix: Client

    • Code: GlacierExpeditedRetrievalNotAvailable

    • Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)

    • HTTP Status Code: 503

    • SOAP Fault Code Prefix: N/A

Related Resources

Service Reference:

Examples:

To restore an archived object


/* The following example restores for one day an archived copy of an object back into Amazon S3 bucket. */

 var params = {
  Bucket: "examplebucket", 
  Key: "archivedobjectkey", 
  RestoreRequest: {
   Days: 1, 
   GlacierJobParameters: {
    Tier: "Expedited"
   }
  }
 };
 s3.restoreObject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the restoreObject operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  RequestPayer: requester,
  RestoreRequest: {
    Days: 'NUMBER_VALUE',
    Description: 'STRING_VALUE',
    GlacierJobParameters: {
      Tier: Standard | Bulk | Expedited /* required */
    },
    OutputLocation: {
      S3: {
        BucketName: 'STRING_VALUE', /* required */
        Prefix: 'STRING_VALUE', /* required */
        AccessControlList: [
          {
            Grantee: {
              Type: CanonicalUser | AmazonCustomerByEmail | Group, /* required */
              DisplayName: 'STRING_VALUE',
              EmailAddress: 'STRING_VALUE',
              ID: 'STRING_VALUE',
              URI: 'STRING_VALUE'
            },
            Permission: FULL_CONTROL | WRITE | WRITE_ACP | READ | READ_ACP
          },
          /* more items */
        ],
        CannedACL: private | public-read | public-read-write | authenticated-read | aws-exec-read | bucket-owner-read | bucket-owner-full-control,
        Encryption: {
          EncryptionType: AES256 | aws:kms, /* required */
          KMSContext: 'STRING_VALUE',
          KMSKeyId: 'STRING_VALUE'
        },
        StorageClass: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS,
        Tagging: {
          TagSet: [ /* required */
            {
              Key: 'STRING_VALUE', /* required */
              Value: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        UserMetadata: [
          {
            Name: 'STRING_VALUE',
            Value: 'STRING_VALUE'
          },
          /* more items */
        ]
      }
    },
    SelectParameters: {
      Expression: 'STRING_VALUE', /* required */
      ExpressionType: SQL, /* required */
      InputSerialization: { /* required */
        CSV: {
          AllowQuotedRecordDelimiter: true || false,
          Comments: 'STRING_VALUE',
          FieldDelimiter: 'STRING_VALUE',
          FileHeaderInfo: USE | IGNORE | NONE,
          QuoteCharacter: 'STRING_VALUE',
          QuoteEscapeCharacter: 'STRING_VALUE',
          RecordDelimiter: 'STRING_VALUE'
        },
        CompressionType: NONE | GZIP | BZIP2,
        JSON: {
          Type: DOCUMENT | LINES
        },
        Parquet: {
        }
      },
      OutputSerialization: { /* required */
        CSV: {
          FieldDelimiter: 'STRING_VALUE',
          QuoteCharacter: 'STRING_VALUE',
          QuoteEscapeCharacter: 'STRING_VALUE',
          QuoteFields: ALWAYS | ASNEEDED,
          RecordDelimiter: 'STRING_VALUE'
        },
        JSON: {
          RecordDelimiter: 'STRING_VALUE'
        }
      }
    },
    Tier: Standard | Bulk | Expedited,
    Type: SELECT
  },
  VersionId: 'STRING_VALUE'
};
s3.restoreObject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name containing the object to restore.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • Key — (String)

      Object key for which the action was initiated.

    • VersionId — (String)

      VersionId used to reference a specific version of the object.

    • RestoreRequest — (map)

      Container for restore job parameters.

      • Days — (Integer)

        Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

        The Days element is required for regular restores, and must not be provided for select requests.

      • GlacierJobParameters — (map)

        S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

        • Tier — required — (String)

          Retrieval tier at which the restore will be processed.

          Possible values include:
          • "Standard"
          • "Bulk"
          • "Expedited"
      • Type — (String)

        Type of restore request.

        Possible values include:
        • "SELECT"
      • Tier — (String)

        Retrieval tier at which the restore will be processed.

        Possible values include:
        • "Standard"
        • "Bulk"
        • "Expedited"
      • Description — (String)

        The optional description for the job.

      • SelectParameters — (map)

        Describes the parameters for Select job types.

        • InputSerialization — required — (map)

          Describes the serialization format of the object.

          • CSV — (map)

            Describes the serialization of a CSV-encoded object.

            • FileHeaderInfo — (String)

              Describes the first line of input. Valid values are:

              • NONE: First line is not a header.

              • IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as 1, 2, …) to indicate the column (SELECT s._1 FROM OBJECT s).

              • Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

              Possible values include:
              • "USE"
              • "IGNORE"
              • "NONE"
            • Comments — (String)

              A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line.

            • QuoteEscapeCharacter — (String)

              A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

            • RecordDelimiter — (String)

              A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

            • FieldDelimiter — (String)

              A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

            • QuoteCharacter — (String)

              A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

              Type: String

              Default: "

              Ancestors: CSV

            • AllowQuotedRecordDelimiter — (Boolean)

              Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

          • CompressionType — (String)

            Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.

            Possible values include:
            • "NONE"
            • "GZIP"
            • "BZIP2"
          • JSON — (map)

            Specifies JSON as object's input serialization format.

            • Type — (String)

              The type of JSON. Valid values: Document, Lines.

              Possible values include:
              • "DOCUMENT"
              • "LINES"
          • Parquet — (map)

            Specifies Parquet as object's input serialization format.

        • ExpressionType — required — (String)

          The type of the provided expression (for example, SQL).

          Possible values include:
          • "SQL"
        • Expression — required — (String)

          The expression that is used to query the object.

        • OutputSerialization — required — (map)

          Describes how the results of the Select job are serialized.

          • CSV — (map)

            Describes the serialization of CSV-encoded Select results.

            • QuoteFields — (String)

              Indicates whether to use quotation marks around output fields.

              • ALWAYS: Always use quotation marks for output fields.

              • ASNEEDED: Use quotation marks for output fields when needed.

              Possible values include:
              • "ALWAYS"
              • "ASNEEDED"
            • QuoteEscapeCharacter — (String)

              The single character used for escaping the quote character inside an already escaped value.

            • RecordDelimiter — (String)

              A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.

            • FieldDelimiter — (String)

              The value used to separate individual fields in a record. You can specify an arbitrary delimiter.

            • QuoteCharacter — (String)

              A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

          • JSON — (map)

            Specifies JSON as request's output serialization format.

            • RecordDelimiter — (String)

              The value used to separate individual records in the output. If no value is specified, Amazon S3 uses a newline character ('\n').

      • OutputLocation — (map)

        Describes the location where the restore job's output is stored.

        • S3 — (map)

          Describes an S3 location that will receive the results of the restore request.

          • BucketName — required — (String)

            The name of the bucket where the restore results will be placed.

          • Prefix — required — (String)

            The prefix that is prepended to the restore results for this request.

          • Encryption — (map)

            Contains the type of server-side encryption used.

            • EncryptionType — required — (String)

              The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

              Possible values include:
              • "AES256"
              • "aws:kms"
            • KMSKeyId — (String)

              If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed key to use for encryption of job results. Amazon S3 only supports symmetric keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

            • KMSContext — (String)

              If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

          • CannedACL — (String)

            The canned ACL to apply to the restore results.

            Possible values include:
            • "private"
            • "public-read"
            • "public-read-write"
            • "authenticated-read"
            • "aws-exec-read"
            • "bucket-owner-read"
            • "bucket-owner-full-control"
          • AccessControlList — (Array<map>)

            A list of grants that control access to the staged results.

            • Grantee — (map)

              The person being granted permissions.

              • DisplayName — (String)

                Screen name of the grantee.

              • EmailAddress — (String)

                Email address of the grantee.

                Note: Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
                • US East (N. Virginia)
                • US West (N. California)
                • US West (Oregon)
                • Asia Pacific (Singapore)
                • Asia Pacific (Sydney)
                • Asia Pacific (Tokyo)
                • Europe (Ireland)
                • South America (São Paulo)
                For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
              • ID — (String)

                The canonical user ID of the grantee.

              • Type — required — (String)

                Type of grantee

                Possible values include:
                • "CanonicalUser"
                • "AmazonCustomerByEmail"
                • "Group"
              • URI — (String)

                URI of the grantee group.

            • Permission — (String)

              Specifies the permission given to the grantee.

              Possible values include:
              • "FULL_CONTROL"
              • "WRITE"
              • "WRITE_ACP"
              • "READ"
              • "READ_ACP"
          • Tagging — (map)

            The tag-set that is applied to the restore results.

            • TagSet — required — (Array<map>)

              A collection for a set of tags

              • Key — required — (String)

                Name of the object key.

              • Value — required — (String)

                Value of the tag.

          • UserMetadata — (Array<map>)

            A list of metadata to store with the restore results in S3.

            • Name — (String)

              Name of the Object.

            • Value — (String)

              Value of the Object.

          • StorageClass — (String)

            The class of storage used to store the restore results.

            Possible values include:
            • "STANDARD"
            • "REDUCED_REDUNDANCY"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "GLACIER"
            • "DEEP_ARCHIVE"
            • "OUTPOSTS"
    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"
      • RestoreOutputPath — (String)

        Indicates the path in the provided S3 output location where Select results will be restored to.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

selectObjectContent(params = {}, callback) ⇒ AWS.Request

This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

This action is not supported by Amazon S3 on Outposts.

For more information about Amazon S3 Select, see Selecting Content from Objects in the Amazon S3 User Guide.

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide.

Permissions

You must have s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon S3 User Guide.

Object Data Formats

You can use Amazon S3 Select to query objects that have the following format properties:

  • CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.

  • UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.

  • GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.

  • Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption.

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

    For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide.

Working with the Response Body

Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see Appendix: SelectObjectContent Response.

GetObject Support

The SelectObjectContent action does not support the following GetObject functionality. For more information, see GetObject.

  • Range: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), you cannot specify the range of bytes of an object to return.

  • GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For more information, about storage classes see Storage Classes in the Amazon S3 User Guide.

Special Errors

For a list of special errors for this operation, see List of SELECT Object Content Error Codes

Related Resources

Service Reference:

Examples:

Node.js EventStream Example

// In Node.js, events are streamed and can be read as they arrive.
s3.selectObjectContent({/** params **/}, function(err, data) {
  if (err) {
    // handle error
    return console.error(err);
  }

  var eventStream = data.Payload;

  eventStream.on('data', function(event) {
    // Check the top-level field to determine which event this is.
    if (event.Records) {
      // handle Records event
    } else if (event.Stats) {
      // handle Stats event
    } else if (event.Progress) {
      // handle Progress event
    } else if (event.Cont) {
      // handle Cont event
    } else if (event.End) {
      // handle End event
    }
  });
  eventStream.on('error', function(err) { /** Handle error events **/});
  eventStream.on('end', function() { /** Finished reading all events **/});
});

Browser EventStream Example

// In browsers, events aren't processed until the response is fully buffered.
// Events will be accessible as an array.
s3.selectObjectContent({/** params **/}, function(err, data) {
  if (err) {
    // handle error
    return console.error(err);
  }

  var events = data.Payload;

  for (var event of events) {
    // Check the top-level field to determine which event this is.
    if (event.Records) {
      // handle Records event
    } else if (event.Stats) {
      // handle Stats event
    } else if (event.Progress) {
      // handle Progress event
    } else if (event.Cont) {
      // handle Cont event
    } else if (event.End) {
      // handle End event
    }
  }
});

Async Iterator EventStream Example (Experimental)

// In Node.js v10.x, Readable streams have experimental support for async iteration.
// Instead of listening to the event stream's 'data' event, you can use a for...await loop.
async function example() {
  try {
    const result = await s3.selectObjectContent({/** params **/}).promise();

    const events = result.Payload;

    for await (const event of events) {
      // Check the top-level field to determine which event this is.
      if (event.Records) {
        // handle Records event
      } else if (event.Stats) {
        // handle Stats event
      } else if (event.Progress) {
        // handle Progress event
      } else if (event.Cont) {
        // handle Cont event
      } else if (event.End) {
        // handle End event
      }
    }
  } catch (err) {
    // handle error
  }
}

Calling the selectObjectContent operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Expression: 'STRING_VALUE', /* required */
  ExpressionType: SQL, /* required */
  InputSerialization: { /* required */
    CSV: {
      AllowQuotedRecordDelimiter: true || false,
      Comments: 'STRING_VALUE',
      FieldDelimiter: 'STRING_VALUE',
      FileHeaderInfo: USE | IGNORE | NONE,
      QuoteCharacter: 'STRING_VALUE',
      QuoteEscapeCharacter: 'STRING_VALUE',
      RecordDelimiter: 'STRING_VALUE'
    },
    CompressionType: NONE | GZIP | BZIP2,
    JSON: {
      Type: DOCUMENT | LINES
    },
    Parquet: {
    }
  },
  Key: 'STRING_VALUE', /* required */
  OutputSerialization: { /* required */
    CSV: {
      FieldDelimiter: 'STRING_VALUE',
      QuoteCharacter: 'STRING_VALUE',
      QuoteEscapeCharacter: 'STRING_VALUE',
      QuoteFields: ALWAYS | ASNEEDED,
      RecordDelimiter: 'STRING_VALUE'
    },
    JSON: {
      RecordDelimiter: 'STRING_VALUE'
    }
  },
  ExpectedBucketOwner: 'STRING_VALUE',
  RequestProgress: {
    Enabled: true || false
  },
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SSECustomerKeyMD5: 'STRING_VALUE',
  ScanRange: {
    End: 'NUMBER_VALUE',
    Start: 'NUMBER_VALUE'
  }
};
s3.selectObjectContent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The S3 bucket.

    • Key — (String)

      The object key.

    • SSECustomerAlgorithm — (String)

      The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

    • SSECustomerKeyMD5 — (String)

      The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

    • Expression — (String)

      The expression that is used to query the object.

    • ExpressionType — (String)

      The type of the provided expression (for example, SQL).

      Possible values include:
      • "SQL"
    • RequestProgress — (map)

      Specifies if periodic request progress information should be enabled.

      • Enabled — (Boolean)

        Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.

    • InputSerialization — (map)

      Describes the format of the data in the object that is being queried.

      • CSV — (map)

        Describes the serialization of a CSV-encoded object.

        • FileHeaderInfo — (String)

          Describes the first line of input. Valid values are:

          • NONE: First line is not a header.

          • IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as 1, 2, …) to indicate the column (SELECT s._1 FROM OBJECT s).

          • Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

          Possible values include:
          • "USE"
          • "IGNORE"
          • "NONE"
        • Comments — (String)

          A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line.

        • QuoteEscapeCharacter — (String)

          A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

        • RecordDelimiter — (String)

          A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

        • FieldDelimiter — (String)

          A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

        • QuoteCharacter — (String)

          A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

          Type: String

          Default: "

          Ancestors: CSV

        • AllowQuotedRecordDelimiter — (Boolean)

          Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

      • CompressionType — (String)

        Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.

        Possible values include:
        • "NONE"
        • "GZIP"
        • "BZIP2"
      • JSON — (map)

        Specifies JSON as object's input serialization format.

        • Type — (String)

          The type of JSON. Valid values: Document, Lines.

          Possible values include:
          • "DOCUMENT"
          • "LINES"
      • Parquet — (map)

        Specifies Parquet as object's input serialization format.

    • OutputSerialization — (map)

      Describes the format of the data that you want Amazon S3 to return in response.

      • CSV — (map)

        Describes the serialization of CSV-encoded Select results.

        • QuoteFields — (String)

          Indicates whether to use quotation marks around output fields.

          • ALWAYS: Always use quotation marks for output fields.

          • ASNEEDED: Use quotation marks for output fields when needed.

          Possible values include:
          • "ALWAYS"
          • "ASNEEDED"
        • QuoteEscapeCharacter — (String)

          The single character used for escaping the quote character inside an already escaped value.

        • RecordDelimiter — (String)

          A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.

        • FieldDelimiter — (String)

          The value used to separate individual fields in a record. You can specify an arbitrary delimiter.

        • QuoteCharacter — (String)

          A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

      • JSON — (map)

        Specifies JSON as request's output serialization format.

        • RecordDelimiter — (String)

          The value used to separate individual records in the output. If no value is specified, Amazon S3 uses a newline character ('\n').

    • ScanRange — (map)

      Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

      ScanRangemay be used in the following ways:

      • <scanrange><start>50</start><end>100</end></scanrange> - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)

      • <scanrange><start>50</start></scanrange> - process only the records starting after the byte 50

      • <scanrange><end>50</end></scanrange> - process only the records within the last 50 bytes of the file.

      • Start — (Integer)

        Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file.For example; <scanrange><start>50</start></scanrange> means scan from byte 50 until the end of the file.

      • End — (Integer)

        Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. If only the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file. For example, <scanrange><end>50</end></scanrange> means scan the last 50 bytes.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Payload — (ReadableStream<Events> | Array<Events>)

        The array of results.

        Payload is an object-mode Readable stream in Node.js v0.10.x and higher. Attach a listener to the data event to receive events. Payload is an array of events in browsers. The possible events that may be returned are listed below. Note that the top-level field in each event matches the event name.
        • Records — (map)

          The Records Event.

          • Payload — (Buffer)

            The byte array of partial, one or more result records.

        • Stats — (map)

          The Stats Event.

          • Details — (map)

            The Stats event details.

            • BytesScanned — (Integer)

              The total number of object bytes scanned.

            • BytesProcessed — (Integer)

              The total number of uncompressed object bytes processed.

            • BytesReturned — (Integer)

              The total number of bytes of records payload data returned.

        • Progress — (map)

          The Progress Event.

          • Details — (map)

            The Progress event details.

            • BytesScanned — (Integer)

              The current number of object bytes scanned.

            • BytesProcessed — (Integer)

              The current number of uncompressed object bytes processed.

            • BytesReturned — (Integer)

              The current number of bytes of records payload data returned.

        • Cont — (map)

          The Continuation Event.

        • End — (map)

          The End Event.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

upload(params = {}, [options], [callback]) ⇒ AWS.S3.ManagedUpload

Uploads an arbitrarily sized buffer, blob, or stream, using intelligent concurrent handling of parts if the payload is large enough. You can configure the concurrent queue size by setting options. Note that this is the only operation for which the SDK can retry requests with stream bodies.

Examples:

Uploading a stream object

var params = {Bucket: 'bucket', Key: 'key', Body: stream};
s3.upload(params, function(err, data) {
  console.log(err, data);
});

Uploading a stream with concurrency of 1 and partSize of 10mb

var params = {Bucket: 'bucket', Key: 'key', Body: stream};
var options = {partSize: 10 * 1024 * 1024, queueSize: 1};
s3.upload(params, options, function(err, data) {
  console.log(err, data);
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ACL — (String)

      The canned ACL to apply to the object. For more information, see Canned ACL.

      This action is not supported by Amazon S3 on Outposts.

      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
      • "aws-exec-read"
      • "bucket-owner-read"
      • "bucket-owner-full-control"
    • Body — (Buffer, Typed Array, Blob, String, ReadableStream)

      Object data.

    • Bucket — (String)

      The bucket name to which the PUT action was initiated.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • CacheControl — (String)

      Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

    • ContentDisposition — (String)

      Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

    • ContentEncoding — (String)

      Specifies 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, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

    • ContentLanguage — (String)

      The language the content is in.

    • ContentLength — (Integer)

      Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

    • ContentMD5 — (String)

      The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

    • ContentType — (String)

      A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

    • Expires — (Date)

      The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

    • GrantFullControl — (String)

      Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

      This action is not supported by Amazon S3 on Outposts.

    • GrantRead — (String)

      Allows grantee to read the object data and its metadata.

      This action is not supported by Amazon S3 on Outposts.

    • GrantReadACP — (String)

      Allows grantee to read the object ACL.

      This action is not supported by Amazon S3 on Outposts.

    • GrantWriteACP — (String)

      Allows grantee to write the ACL for the applicable object.

      This action is not supported by Amazon S3 on Outposts.

    • Key — (String)

      Object key for which the PUT action was initiated.

    • Metadata — (map<String>)

      A map of metadata to store with the object in S3.

    • ServerSideEncryption — (String)

      The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

      Possible values include:
      • "AES256"
      • "aws:kms"
    • StorageClass — (String)

      By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

      Possible values include:
      • "STANDARD"
      • "REDUCED_REDUNDANCY"
      • "STANDARD_IA"
      • "ONEZONE_IA"
      • "INTELLIGENT_TIERING"
      • "GLACIER"
      • "DEEP_ARCHIVE"
      • "OUTPOSTS"
    • WebsiteRedirectLocation — (String)

      If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

      In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

      x-amz-website-redirect-location: /anotherPage.html

      In the following example, the request header sets the object redirect to another website:

      x-amz-website-redirect-location: http://www.example.com/

      For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

    • SSECustomerAlgorithm — (String)

      Specifies the algorithm to use to when encrypting the object (for example, AES256).

    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 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.

    • SSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    • SSEKMSKeyId — (String)

      If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.

    • SSEKMSEncryptionContext — (String)

      Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    • BucketKeyEnabled — (Boolean)

      Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

      Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • Tagging — (String)

      The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

    • ObjectLockMode — (String)

      The Object Lock mode that you want to apply to this object.

      Possible values include:
      • "GOVERNANCE"
      • "COMPLIANCE"
    • ObjectLockRetainUntilDate — (Date)

      The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.

    • ObjectLockLegalHoldStatus — (String)

      Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

      Possible values include:
      • "ON"
      • "OFF"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

  • (AWS.S3.ManagedUpload) —

    the managed upload object that can call send() or track progress.

Callback (callback):

  • function(err, data) { ... }

    Parameters:

    • err (Error) —

      an error or null if no error occurred.

    • data (map) —

      The response data from the successful upload:

    • data.Location (String) —

      the URL of the uploaded object

    • data.ETag (String) —

      the ETag of the uploaded object

    • data.Bucket (String) —

      the bucket to which the object was uploaded

    • data.Key (String) —

      the key to which the object was uploaded

See Also:

uploadPart(params = {}, callback) ⇒ AWS.Request

Uploads a part in a multipart upload.

Note: In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.

You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.

To ensure that data is not corrupted when traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error.

If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a checksum instead of Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

For more information on multipart uploads, go to Multipart Upload Overview in the Amazon S3 User Guide .

For information on the permissions required to use the multipart upload API, go to Multipart Upload and Permissions in the Amazon S3 User Guide.

You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption in the Amazon S3 User Guide.

Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload.

If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

Special Errors

    • Code: NoSuchUpload

    • Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • HTTP Status Code: 404 Not Found

    • SOAP Fault Code Prefix: Client

Related Resources

Service Reference:

Examples:

To upload a part


/* The following example uploads part 1 of a multipart upload. The example specifies a file name for the part data. The Upload ID is same that is returned by the initiate multipart upload. */

 var params = {
  Body: <Binary String>, 
  Bucket: "examplebucket", 
  Key: "examplelargeobject", 
  PartNumber: 1, 
  UploadId: "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
 };
 s3.uploadPart(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ETag: "\"d8c2eafd90c266e19ab9dcacc479f8af\""
   }
   */
 });

Calling the uploadPart operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  PartNumber: 'NUMBER_VALUE', /* required */
  UploadId: 'STRING_VALUE', /* required */
  Body: Buffer.from('...') || 'STRING_VALUE' || streamObject,
  ContentLength: 'NUMBER_VALUE',
  ContentMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  RequestPayer: requester,
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SSECustomerKeyMD5: 'STRING_VALUE'
};
s3.uploadPart(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Body — (Buffer, Typed Array, Blob, String, ReadableStream)

      Object data.

    • Bucket — (String)

      The name of the bucket to which the multipart upload was initiated.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • ContentLength — (Integer)

      Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

    • ContentMD5 — (String)

      The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

    • Key — (String)

      Object key for which the multipart upload was initiated.

    • PartNumber — (Integer)

      Part number of part being uploaded. This is a positive integer between 1 and 10,000.

    • UploadId — (String)

      Upload ID identifying the multipart upload whose part is being uploaded.

    • SSECustomerAlgorithm — (String)

      Specifies the algorithm to use to when encrypting the object (for example, AES256).

    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 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. This must be the same encryption key specified in the initiate multipart upload request.

    • SSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServerSideEncryption — (String)

        The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

        Possible values include:
        • "AES256"
        • "aws:kms"
      • ETag — (String)

        Entity tag for the uploaded object.

      • SSECustomerAlgorithm — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

      • SSECustomerKeyMD5 — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

      • SSEKMSKeyId — (String)

        If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key was used for the object.

      • BucketKeyEnabled — (Boolean)

        Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

uploadPartCopy(params = {}, callback) ⇒ AWS.Request

Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request.

The minimum allowable part size for a multipart upload is 5 MB. For more information about multipart upload limits, go to Quick Facts in the Amazon S3 User Guide.

Note: Instead of using an existing object as part data, you might use the UploadPart action and provide data in your request.

You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.

For more information about using the UploadPartCopy operation, see the following:

  • For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

  • For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • For information about copying objects using a single atomic action vs. the multipart upload, see Operations on Objects in the Amazon S3 User Guide.

  • For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.

Note the following additional considerations about the request headers x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, and x-amz-copy-source-if-modified-since:

  • Consideration 1 - If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows:

    x-amz-copy-source-if-match condition evaluates to true, and;

    x-amz-copy-source-if-unmodified-since condition evaluates to false;

    Amazon S3 returns 200 OK and copies the data.

  • Consideration 2 - If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows:

    x-amz-copy-source-if-none-match condition evaluates to false, and;

    x-amz-copy-source-if-modified-since condition evaluates to true;

    Amazon S3 returns 412 Precondition Failed response code.

Versioning

If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source.

You can optionally specify a specific version of the source object to copy by adding the versionId subresource as shown in the following example:

x-amz-copy-source: /bucket/object?versionId=version id

Special Errors

    • Code: NoSuchUpload

    • Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • HTTP Status Code: 404 Not Found

    • Code: InvalidRequest

    • Cause: The specified copy source is not supported as a byte-range copy source.

    • HTTP Status Code: 400 Bad Request

Related Resources

Service Reference:

Examples:

To upload a part by copying data from an existing object as data source


/* The following example uploads a part of a multipart upload by copying data from an existing object as data source. */

 var params = {
  Bucket: "examplebucket", 
  CopySource: "/bucketname/sourceobjectkey", 
  Key: "examplelargeobject", 
  PartNumber: 1, 
  UploadId: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"
 };
 s3.uploadPartCopy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CopyPartResult: {
     ETag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"", 
     LastModified: <Date Representation>
    }
   }
   */
 });

To upload a part by copying byte range from an existing object as data source


/* The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source. */

 var params = {
  Bucket: "examplebucket", 
  CopySource: "/bucketname/sourceobjectkey", 
  CopySourceRange: "bytes=1-100000", 
  Key: "examplelargeobject", 
  PartNumber: 2, 
  UploadId: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"
 };
 s3.uploadPartCopy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CopyPartResult: {
     ETag: "\"65d16d19e65a7508a51f043180edcc36\"", 
     LastModified: <Date Representation>
    }
   }
   */
 });

Calling the uploadPartCopy operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  CopySource: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  PartNumber: 'NUMBER_VALUE', /* required */
  UploadId: 'STRING_VALUE', /* required */
  CopySourceIfMatch: 'STRING_VALUE',
  CopySourceIfModifiedSince: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CopySourceIfNoneMatch: 'STRING_VALUE',
  CopySourceIfUnmodifiedSince: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CopySourceRange: 'STRING_VALUE',
  CopySourceSSECustomerAlgorithm: 'STRING_VALUE',
  CopySourceSSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  CopySourceSSECustomerKeyMD5: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  ExpectedSourceBucketOwner: 'STRING_VALUE',
  RequestPayer: requester,
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SSECustomerKeyMD5: 'STRING_VALUE'
};
s3.uploadPartCopy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Bucket — (String)

      The bucket name.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • CopySource — (String)

      Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

      • For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

      • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

        Note: Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

        Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

      To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

    • CopySourceIfMatch — (String)

      Copies the object if its entity tag (ETag) matches the specified tag.

    • CopySourceIfModifiedSince — (Date)

      Copies the object if it has been modified since the specified time.

    • CopySourceIfNoneMatch — (String)

      Copies the object if its entity tag (ETag) is different than the specified ETag.

    • CopySourceIfUnmodifiedSince — (Date)

      Copies the object if it hasn't been modified since the specified time.

    • CopySourceRange — (String)

      The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.

    • Key — (String)

      Object key for which the multipart upload was initiated.

    • PartNumber — (Integer)

      Part number of part being copied. This is a positive integer between 1 and 10,000.

    • UploadId — (String)

      Upload ID identifying the multipart upload whose part is being copied.

    • SSECustomerAlgorithm — (String)

      Specifies the algorithm to use to when encrypting the object (for example, AES256).

    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 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. This must be the same encryption key specified in the initiate multipart upload request.

    • SSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    • CopySourceSSECustomerAlgorithm — (String)

      Specifies the algorithm to use when decrypting the source object (for example, AES256).

    • CopySourceSSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

    • CopySourceSSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

    • ExpectedSourceBucketOwner — (String)

      The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CopySourceVersionId — (String)

        The version of the source object that was copied, if you have enabled versioning on the source bucket.

      • CopyPartResult — (map)

        Container for all response elements.

        • ETag — (String)

          Entity tag of the object.

        • LastModified — (Date)

          Date and time at which the object was uploaded.

      • ServerSideEncryption — (String)

        The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

        Possible values include:
        • "AES256"
        • "aws:kms"
      • SSECustomerAlgorithm — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

      • SSECustomerKeyMD5 — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

      • SSEKMSKeyId — (String)

        If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

      • BucketKeyEnabled — (Boolean)

        Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

validateArnResourceType(req) ⇒ void

Validate resource-type supplied in S3 ARN

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given S3 resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the bucketExists state

var params = {
  Bucket: 'STRING_VALUE', /* required */
};
s3.waitFor('bucketExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

writeGetObjectResponse(params, callback) ⇒ AWS.Request

Passes transformed objects to a GetObject operation when using Object Lambda access points. For information about Object Lambda access points, see Transforming objects with Object Lambda access points in the Amazon S3 User Guide.

This operation supports metadata that can be returned by GetObject, in addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. The GetObject response metadata is supported so that the WriteGetObjectResponse caller, typically an Lambda function, can provide the same metadata when it internally invokes GetObject. When WriteGetObjectResponse is called by a customer-owned Lambda function, the metadata returned to the end user GetObject call might differ from what Amazon S3 would normally return.

You can include any number of metadata headers. When including a metadata header, it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this is to forward GetObject metadata.

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.

For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.

Service Reference:

Examples:

Calling the writeGetObjectResponse operation

var params = {
  RequestRoute: 'STRING_VALUE', /* required */
  RequestToken: 'STRING_VALUE', /* required */
  AcceptRanges: 'STRING_VALUE',
  Body: Buffer.from('...') || 'STRING_VALUE' || streamObject,
  BucketKeyEnabled: true || false,
  CacheControl: 'STRING_VALUE',
  ContentDisposition: 'STRING_VALUE',
  ContentEncoding: 'STRING_VALUE',
  ContentLanguage: 'STRING_VALUE',
  ContentLength: 'NUMBER_VALUE',
  ContentRange: 'STRING_VALUE',
  ContentType: 'STRING_VALUE',
  DeleteMarker: true || false,
  ETag: 'STRING_VALUE',
  ErrorCode: 'STRING_VALUE',
  ErrorMessage: 'STRING_VALUE',
  Expiration: 'STRING_VALUE',
  Expires: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  LastModified: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Metadata: {
    '<MetadataKey>': 'STRING_VALUE',
    /* '<MetadataKey>': ... */
  },
  MissingMeta: 'NUMBER_VALUE',
  ObjectLockLegalHoldStatus: ON | OFF,
  ObjectLockMode: GOVERNANCE | COMPLIANCE,
  ObjectLockRetainUntilDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  PartsCount: 'NUMBER_VALUE',
  ReplicationStatus: COMPLETE | PENDING | FAILED | REPLICA,
  RequestCharged: requester,
  Restore: 'STRING_VALUE',
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKeyMD5: 'STRING_VALUE',
  SSEKMSKeyId: 'STRING_VALUE',
  ServerSideEncryption: AES256 | aws:kms,
  StatusCode: 'NUMBER_VALUE',
  StorageClass: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS,
  TagCount: 'NUMBER_VALUE',
  VersionId: 'STRING_VALUE'
};
s3.writeGetObjectResponse(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • RequestRoute — (String)

      Route prefix to the HTTP URL generated.

    • RequestToken — (String)

      A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.

    • Body — (Buffer, Typed Array, Blob, String, ReadableStream)

      The object data.

    • StatusCode — (Integer)

      The integer status code for an HTTP response of a corresponding GetObject request.

      Status Codes

      • 200 - OK

      • 206 - Partial Content

      • 304 - Not Modified

      • 400 - Bad Request

      • 401 - Unauthorized

      • 403 - Forbidden

      • 404 - Not Found

      • 405 - Method Not Allowed

      • 409 - Conflict

      • 411 - Length Required

      • 412 - Precondition Failed

      • 416 - Range Not Satisfiable

      • 500 - Internal Server Error

      • 503 - Service Unavailable

    • ErrorCode — (String)

      A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. Regex value is "^[A-Z][a-zA-Z]+$".

    • ErrorMessage — (String)

      Contains a generic description of the error condition. Returned in the <Message> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.

    • AcceptRanges — (String)

      Indicates that a range of bytes was specified.

    • CacheControl — (String)

      Specifies caching behavior along the request/reply chain.

    • ContentDisposition — (String)

      Specifies presentational information for the object.

    • ContentEncoding — (String)

      Specifies 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.

    • ContentLanguage — (String)

      The language the content is in.

    • ContentLength — (Integer)

      The size of the content body in bytes.

    • ContentRange — (String)

      The portion of the object returned in the response.

    • ContentType — (String)

      A standard MIME type describing the format of the object data.

    • DeleteMarker — (Boolean)

      Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.

    • ETag — (String)

      An opaque identifier assigned by a web server to a specific version of a resource found at a URL.

    • Expires — (Date)

      The date and time at which the object is no longer cacheable.

    • Expiration — (String)

      If object stored in Amazon S3 expiration is configured (see PUT Bucket lifecycle) it includes expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.

    • LastModified — (Date)

      The date and time that the object was last modified.

    • MissingMeta — (Integer)

      Set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

    • Metadata — (map<String>)

      A map of metadata to store with the object in S3.

    • ObjectLockMode — (String)

      Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.

      Possible values include:
      • "GOVERNANCE"
      • "COMPLIANCE"
    • ObjectLockLegalHoldStatus — (String)

      Indicates whether an object stored in Amazon S3 has an active legal hold.

      Possible values include:
      • "ON"
      • "OFF"
    • ObjectLockRetainUntilDate — (Date)

      The date and time when Object Lock is configured to expire.

    • PartsCount — (Integer)

      The count of parts this object has.

    • ReplicationStatus — (String)

      Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.

      Possible values include:
      • "COMPLETE"
      • "PENDING"
      • "FAILED"
      • "REPLICA"
    • RequestCharged — (String)

      If present, indicates that the requester was successfully charged for the request.

      Possible values include:
      • "requester"
    • Restore — (String)

      Provides information about object restoration operation and expiration time of the restored object copy.

    • ServerSideEncryption — (String)

      The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).

      Possible values include:
      • "AES256"
      • "aws:kms"
    • SSECustomerAlgorithm — (String)

      Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.

    • SSEKMSKeyId — (String)

      If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for stored in Amazon S3 object.

    • SSECustomerKeyMD5 — (String)

      128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).

    • StorageClass — (String)

      The class of storage used to store object in Amazon S3.

      Possible values include:
      • "STANDARD"
      • "REDUCED_REDUNDANCY"
      • "STANDARD_IA"
      • "ONEZONE_IA"
      • "INTELLIGENT_TIERING"
      • "GLACIER"
      • "DEEP_ARCHIVE"
      • "OUTPOSTS"
    • TagCount — (Integer)

      The number of tags, if any, on the object.

    • VersionId — (String)

      An ID used to reference a specific version of the object.

    • BucketKeyEnabled — (Boolean)

      Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource Details

s3.waitFor('bucketExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the bucketExists state by periodically calling the underlying S3.headBucket() operation every 5 seconds (at most 20 times).

Examples:

Waiting for the bucketExists state

var params = {
  Bucket: 'STRING_VALUE', /* required */
};
s3.waitFor('bucketExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • Bucket — (String)

      The bucket name.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

s3.waitFor('bucketNotExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the bucketNotExists state by periodically calling the underlying S3.headBucket() operation every 5 seconds (at most 20 times).

Examples:

Waiting for the bucketNotExists state

var params = {
  Bucket: 'STRING_VALUE', /* required */
};
s3.waitFor('bucketNotExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • Bucket — (String)

      The bucket name.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

s3.waitFor('objectExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the objectExists state by periodically calling the underlying S3.headObject() operation every 5 seconds (at most 20 times).

Examples:

Waiting for the objectExists state

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
};
s3.waitFor('objectExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • Bucket — (String)

      The name of the bucket containing the object.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • IfMatch — (String)

      Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

    • IfModifiedSince — (Date)

      Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

    • IfNoneMatch — (String)

      Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

    • IfUnmodifiedSince — (Date)

      Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

    • Key — (String)

      The object key.

    • Range — (String)

      Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

      Note: Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
    • VersionId — (String)

      VersionId used to reference a specific version of the object.

    • SSECustomerAlgorithm — (String)

      Specifies the algorithm to use to when encrypting the object (for example, AES256).

    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 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.

    • SSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • PartNumber — (Integer)

      Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeleteMarker — (Boolean)

        Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

      • AcceptRanges — (String)

        Indicates that a range of bytes was specified.

      • Expiration — (String)

        If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.

      • Restore — (String)

        If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

        If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

        x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

        If the object restoration is in progress, the header returns the value ongoing-request="true".

        For more information about archiving objects, see Transitioning Objects: General Considerations.

      • ArchiveStatus — (String)

        The archive state of the head object.

        Possible values include:
        • "ARCHIVE_ACCESS"
        • "DEEP_ARCHIVE_ACCESS"
      • LastModified — (Date)

        Creation date of the object.

      • ContentLength — (Integer)

        Size of the body in bytes.

      • ETag — (String)

        An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

      • MissingMeta — (Integer)

        This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

      • VersionId — (String)

        Version of the object.

      • CacheControl — (String)

        Specifies caching behavior along the request/reply chain.

      • ContentDisposition — (String)

        Specifies presentational information for the object.

      • ContentEncoding — (String)

        Specifies 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.

      • ContentLanguage — (String)

        The language the content is in.

      • ContentType — (String)

        A standard MIME type describing the format of the object data.

      • Expires — (Date)

        The date and time at which the object is no longer cacheable.

      • WebsiteRedirectLocation — (String)

        If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

      • ServerSideEncryption — (String)

        If the object is stored using server-side encryption either with an Amazon Web Services KMS key or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

        Possible values include:
        • "AES256"
        • "aws:kms"
      • Metadata — (map<String>)

        A map of metadata to store with the object in S3.

      • SSECustomerAlgorithm — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

      • SSECustomerKeyMD5 — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

      • SSEKMSKeyId — (String)

        If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

      • BucketKeyEnabled — (Boolean)

        Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

      • StorageClass — (String)

        Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

        For more information, see Storage Classes.

        Possible values include:
        • "STANDARD"
        • "REDUCED_REDUNDANCY"
        • "STANDARD_IA"
        • "ONEZONE_IA"
        • "INTELLIGENT_TIERING"
        • "GLACIER"
        • "DEEP_ARCHIVE"
        • "OUTPOSTS"
      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"
      • ReplicationStatus — (String)

        Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

        In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

        • If requesting an object from the source bucket — Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

          For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

        • If requesting an object from a destination bucket — Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

        • When replicating objects to multiple destination buckets the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

        For more information, see Replication.

        Possible values include:
        • "COMPLETE"
        • "PENDING"
        • "FAILED"
        • "REPLICA"
      • PartsCount — (Integer)

        The count of parts this object has.

      • ObjectLockMode — (String)

        The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

        Possible values include:
        • "GOVERNANCE"
        • "COMPLIANCE"
      • ObjectLockRetainUntilDate — (Date)

        The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

      • ObjectLockLegalHoldStatus — (String)

        Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

        Possible values include:
        • "ON"
        • "OFF"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

s3.waitFor('objectNotExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the objectNotExists state by periodically calling the underlying S3.headObject() operation every 5 seconds (at most 20 times).

Examples:

Waiting for the objectNotExists state

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
};
s3.waitFor('objectNotExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • Bucket — (String)

      The name of the bucket containing the object.

      When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

      When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

    • IfMatch — (String)

      Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

    • IfModifiedSince — (Date)

      Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

    • IfNoneMatch — (String)

      Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

    • IfUnmodifiedSince — (Date)

      Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

    • Key — (String)

      The object key.

    • Range — (String)

      Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

      Note: Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
    • VersionId — (String)

      VersionId used to reference a specific version of the object.

    • SSECustomerAlgorithm — (String)

      Specifies the algorithm to use to when encrypting the object (for example, AES256).

    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 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.

    • SSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    • RequestPayer — (String)

      Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

      Possible values include:
      • "requester"
    • PartNumber — (Integer)

      Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeleteMarker — (Boolean)

        Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

      • AcceptRanges — (String)

        Indicates that a range of bytes was specified.

      • Expiration — (String)

        If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.

      • Restore — (String)

        If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

        If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

        x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

        If the object restoration is in progress, the header returns the value ongoing-request="true".

        For more information about archiving objects, see Transitioning Objects: General Considerations.

      • ArchiveStatus — (String)

        The archive state of the head object.

        Possible values include:
        • "ARCHIVE_ACCESS"
        • "DEEP_ARCHIVE_ACCESS"
      • LastModified — (Date)

        Creation date of the object.

      • ContentLength — (Integer)

        Size of the body in bytes.

      • ETag — (String)

        An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

      • MissingMeta — (Integer)

        This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

      • VersionId — (String)

        Version of the object.

      • CacheControl — (String)

        Specifies caching behavior along the request/reply chain.

      • ContentDisposition — (String)

        Specifies presentational information for the object.

      • ContentEncoding — (String)

        Specifies 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.

      • ContentLanguage — (String)

        The language the content is in.

      • ContentType — (String)

        A standard MIME type describing the format of the object data.

      • Expires — (Date)

        The date and time at which the object is no longer cacheable.

      • WebsiteRedirectLocation — (String)

        If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

      • ServerSideEncryption — (String)

        If the object is stored using server-side encryption either with an Amazon Web Services KMS key or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

        Possible values include:
        • "AES256"
        • "aws:kms"
      • Metadata — (map<String>)

        A map of metadata to store with the object in S3.

      • SSECustomerAlgorithm — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

      • SSECustomerKeyMD5 — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

      • SSEKMSKeyId — (String)

        If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

      • BucketKeyEnabled — (Boolean)

        Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

      • StorageClass — (String)

        Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

        For more information, see Storage Classes.

        Possible values include:
        • "STANDARD"
        • "REDUCED_REDUNDANCY"
        • "STANDARD_IA"
        • "ONEZONE_IA"
        • "INTELLIGENT_TIERING"
        • "GLACIER"
        • "DEEP_ARCHIVE"
        • "OUTPOSTS"
      • RequestCharged — (String)

        If present, indicates that the requester was successfully charged for the request.

        Possible values include:
        • "requester"
      • ReplicationStatus — (String)

        Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

        In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

        • If requesting an object from the source bucket — Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

          For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

        • If requesting an object from a destination bucket — Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

        • When replicating objects to multiple destination buckets the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

        For more information, see Replication.

        Possible values include:
        • "COMPLETE"
        • "PENDING"
        • "FAILED"
        • "REPLICA"
      • PartsCount — (Integer)

        The count of parts this object has.

      • ObjectLockMode — (String)

        The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

        Possible values include:
        • "GOVERNANCE"
        • "COMPLIANCE"
      • ObjectLockRetainUntilDate — (Date)

        The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

      • ObjectLockLegalHoldStatus — (String)

        Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

        Possible values include:
        • "ON"
        • "OFF"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also: