We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

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

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.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 operation 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 and prevent getting charged for the part storage, you should call the ListParts API operation and ensure that the parts list is empty.

Note: Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions
  • General purpose bucket permissions - For information about permissions required to use the multipart upload, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

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.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        Note: This functionality is not supported for directory buckets.
        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 or the UploadPartCopy operation. After successfully uploading all relevant parts of an upload, you call this CompleteMultipartUpload operation 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 CompleteMultipartUpload request, you must provide the parts list and ensure that the parts list is complete. The CompleteMultipartUpload API operation concatenates the parts that you provide in the list. For each part in the list, you must provide the PartNumber value and the ETag value that are returned after that part was uploaded.

The processing of a CompleteMultipartUpload request could take several minutes to finalize. 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. A request could fail after the initial 200 OK response has been sent. This means that a 200 OK response can contain either a success or an error. The error response might be embedded in the 200 OK response. If you call this API operation directly, make sure to design your application to parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an error).

Note that if CompleteMultipartUpload fails, applications should be prepared to retry any failed requests (including 500 error responses). For more information, see Amazon S3 Error Best Practices.

You can't use Content-Type: application/x-www-form-urlencoded for the CompleteMultipartUpload requests. Also, if you don't provide a Content-Type header, CompleteMultipartUpload can still return a 200 OK response.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

Note: Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions
  • General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

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.

    • HTTP Status Code: 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 ETag might not have matched the uploaded part's ETag.

    • HTTP Status Code: 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.

    • HTTP Status Code: 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.

    • HTTP Status Code: 404 Not Found

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

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 */
  ChecksumCRC32: 'STRING_VALUE',
  ChecksumCRC32C: 'STRING_VALUE',
  ChecksumSHA1: 'STRING_VALUE',
  ChecksumSHA256: 'STRING_VALUE',
  ExpectedBucketOwner: 'STRING_VALUE',
  MultipartUpload: {
    Parts: [
      {
        ChecksumCRC32: 'STRING_VALUE',
        ChecksumCRC32C: 'STRING_VALUE',
        ChecksumSHA1: 'STRING_VALUE',
        ChecksumSHA256: 'STRING_VALUE',
        ETag: 'STRING_VALUE',
        PartNumber: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  },
  RequestPayer: requester,
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SSECustomerKeyMD5: 'STRING_VALUE'
};
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.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is 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.

        If you do not supply a valid Part with your request, the service sends back an HTTP 400 response.

        • ETag — (String)

          Entity tag returned when the part was uploaded.

        • ChecksumCRC32 — (String)

          The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

        • ChecksumCRC32C — (String)

          The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

        • ChecksumSHA1 — (String)

          The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

        • ChecksumSHA256 — (String)

          The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

        • PartNumber — (Integer)

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

          Note:
          • General purpose buckets - In CompleteMultipartUpload, when a additional checksum (including x-amz-checksum-crc32, x-amz-checksum-crc32c, x-amz-checksum-sha1, or x-amz-checksum-sha256) is applied to each part, the PartNumber must start at 1 and the part numbers must be consecutive. Otherwise, Amazon S3 generates an HTTP 400 Bad Request status code and an InvalidPartOrder error code.
          • Directory buckets - In CompleteMultipartUpload, the PartNumber must start at 1 and the part numbers must be consecutive.
    • UploadId — (String)

      ID for the initiated multipart upload.

    • ChecksumCRC32 — (String)

      This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

    • ChecksumCRC32C — (String)

      This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

    • ChecksumSHA1 — (String)

      This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

    • ChecksumSHA256 — (String)

      This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • SSECustomerAlgorithm — (String)

      The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is required only when the object was created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
    • SSECustomerKeyMD5 — (String)

      The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.

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.

        Note: Access points are not supported by directory buckets.
      • 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.

        Note: This functionality is not supported for directory buckets.
      • 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. For more information about how the entity tag is calculated, see Checking object integrity in the Amazon S3 User Guide.

      • ChecksumCRC32 — (String)

        The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      • ChecksumCRC32C — (String)

        The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      • ChecksumSHA1 — (String)

        The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      • ChecksumSHA256 — (String)

        The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      • ServerSideEncryption — (String)

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

        Note: For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
        Possible values include:
        • "AES256"
        • "aws:kms"
        • "aws:kms:dsse"
      • VersionId — (String)

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

        Note: This functionality is not supported for directory buckets.
      • SSEKMSKeyId — (String)

        If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

        Note: This functionality is not supported for directory buckets.
      • BucketKeyEnabled — (Boolean)

        Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

        Note: This functionality is not supported for directory buckets.
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        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 (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API.

You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets.

Note: Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

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. For more information about how to enable a Region for your account, see Enable or disable a Region for standalone accounts in the Amazon Web Services Account Management Guide.

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.

Authentication and authorization

All CopyObject requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.

Directory buckets - You must use the IAM credentials to authenticate and authorize your access to the CopyObject API operation, instead of using the temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

You must have read access to the source object and write access to the destination bucket.

  • General purpose bucket permissions - You must have permissions in an IAM policy based on the source and destination bucket types in a CopyObject operation.

    • If the source object is in a general purpose bucket, you must have s3:GetObject permission to read the source object that is being copied.

    • If the destination bucket is a general purpose bucket, you must have s3:PutObject permission to write the object copy to the destination bucket.

  • Directory bucket permissions - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in a CopyObject operation.

    • If the source object that you want to copy is in a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to read the object. By default, the session is in the ReadWrite mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode condition key to ReadOnly on the copy source bucket.

    • If the copy destination is a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to write the object to the destination. The s3express:SessionMode condition key can't be set to ReadOnly on the copy destination bucket.

    For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.

Response and special errors

When the request is an HTTP 1.1 request, the response is chunk encoded. When the request is not an HTTP 1.1 request, the response would not contain the Content-Length. You always need to read the entire response body to check if the copy succeeds.

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

  • A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. A 200 OK response can contain either a success or an error.

    • 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. For example, in a cross-region copy, you may encounter throttling and receive a 200 OK response. For more information, see Resolve the Error 200 response when copying objects to Amazon S3. The 200 OK status code means the copy was accepted, but it doesn't mean the copy is complete. Another example is when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the copy and you may receive a 200 OK response. You must stay connected to Amazon S3 until the entire response is successfully received and processed.

      If you call this API operation directly, make sure to design your application to parse the content of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an error).

Charge

The copy request charge is based on the storage class and Region that you specify for the destination object. The request can also result in a data retrieval charge for the source if the source storage class bills for data retrieval. If the copy source is in a different region, the data transfer is billed to the copy source account. For pricing information, see Amazon S3 pricing.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to CopyObject:

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',
  ChecksumAlgorithm: CRC32 | CRC32C | SHA1 | SHA256,
  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 | aws:kms:dsse,
  StorageClass: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOW | EXPRESS_ONEZONE,
  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 access control list (ACL) to apply to the object.

      When you copy an object, the ACL metadata is not preserved and is set to private by default. Only the owner has full access control. To override the default ACL setting, specify a new ACL when you generate a copy request. For more information, see Using ACLs.

      If the destination bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

      Note:
      • If your destination bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.
      • This functionality is not supported for directory buckets.
      • This functionality is not supported for 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.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

    • CacheControl — (String)

      Specifies the caching behavior along the request/reply chain.

    • ChecksumAlgorithm — (String)

      Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      When you copy an object, if the source object has a checksum, that checksum value will be copied to the new object by default. If the CopyObject request does not include this x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source object to the destination object (if it's present on the source object). You can optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm header. Unrecognized or unsupported values will respond with the HTTP status code 400 Bad Request.

      Note: For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
      Possible values include:
      • "CRC32"
      • "CRC32C"
      • "SHA1"
      • "SHA256"
    • ContentDisposition — (String)

      Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.

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

      Note: For directory buckets, only the aws-chunked value is supported in this header field.
    • ContentLanguage — (String)

      The language the content is in.

    • ContentType — (String)

      A standard MIME type that describes the format of the object data.

    • CopySource — (String)

      Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket.

      You specify the value of the copy source 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 general purpose bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded. To copy the object reports/january.pdf from the directory bucket awsexamplebucket--use1-az5--x-s3, use awsexamplebucket--use1-az5--x-s3/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.
        • Access points are not supported by directory buckets.

        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.

      If your source bucket versioning is enabled, the x-amz-copy-source header by default 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 query parameter. Specifically, 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.

      If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the copied object. 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 destination bucket, the version ID that Amazon S3 generates in the x-amz-version-id response header is always null.

      Note: Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
    • CopySourceIfMatch — (String)

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

      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

    • CopySourceIfModifiedSince — (Date)

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

      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

    • CopySourceIfNoneMatch — (String)

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

      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

    • CopySourceIfUnmodifiedSince — (Date)

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

      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

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

      Note:
      • This functionality is not supported for directory buckets.
      • This functionality is not supported for Amazon S3 on Outposts.
    • GrantRead — (String)

      Allows grantee to read the object data and its metadata.

      Note:
      • This functionality is not supported for directory buckets.
      • This functionality is not supported for Amazon S3 on Outposts.
    • GrantReadACP — (String)

      Allows grantee to read the object ACL.

      Note:
      • This functionality is not supported for directory buckets.
      • This functionality is not supported for Amazon S3 on Outposts.
    • GrantWriteACP — (String)

      Allows grantee to write the ACL for the applicable object.

      Note:
      • This functionality is not supported for directory buckets.
      • This functionality is not supported for 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 that's provided in the request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If this header isn’t specified, COPY is the default behavior.

      General purpose bucket - For general purpose buckets, 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 Amazon S3 condition key examples in the Amazon S3 User Guide.

      Note: x-amz-website-redirect-location is unique to each object and is not copied when using the x-amz-metadata-directive header. To copy the value, you must specify x-amz-website-redirect-location in the request header.
      Possible values include:
      • "COPY"
      • "REPLACE"
    • TaggingDirective — (String)

      Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's provided in the request.

      The default value is COPY.

      Note: Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations:
      • When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
      • When you attempt to REPLACE the tag-set of a source object and set a non-empty value to x-amz-tagging.
      • When you don't set the x-amz-tagging-directive header and the source object has non-empty tags. This is because the default value of x-amz-tagging-directive is COPY.
      Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed:
      • When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object.
      • When you attempt to REPLACE the tag-set of a directory bucket source object and set the x-amz-tagging value of the directory bucket destination object to empty.
      • When you attempt to REPLACE the tag-set of a general purpose bucket source object that has non-empty tags and set the x-amz-tagging value of the directory bucket destination object to empty.
      • When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the x-amz-tagging value of the directory bucket destination object. This is because the default value of x-amz-tagging is the empty value.
      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, aws:kms:dsse). Unrecognized or unsupported values won’t write a destination object and will receive a 400 Bad Request response.

      Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you don't specify encryption information in your copy request, the encryption setting of the target object is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target object copy.

      When you perform a CopyObject operation, if you want to use a different type of encryption setting for the target object, you can specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence.

      With server-side encryption, Amazon S3 encrypts your data as it writes your data 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 in the Amazon S3 User Guide.

      Note: For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
      Possible values include:
      • "AES256"
      • "aws:kms"
      • "aws:kms:dsse"
    • StorageClass — (String)

      If the x-amz-storage-class header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class.

      Note:
      • Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. Unsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.
      • Amazon S3 on Outposts - S3 on Outposts only uses the OUTPOSTS Storage Class.

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

      Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any of the following conditions:

      • The storage class of the source object is GLACIER or DEEP_ARCHIVE.

      • The storage class of the source object is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access.

      For more information, see RestoreObject and Copying Objects in the Amazon S3 User Guide.

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

      If the destination bucket is configured as a website, redirects requests for this object copy to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive header. Instead, you may opt to provide this header in combination with the x-amz-metadata-directive header.

      Note: This functionality is not supported for directory buckets.
    • SSECustomerAlgorithm — (String)

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

      When you perform a CopyObject operation, if you want to use a different type of encryption setting for the target object, you can specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence.

      Note: This functionality is not supported when the destination bucket is a directory bucket.
    • 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.

      Note: This functionality is not supported when the destination bucket is a directory bucket.
    • 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.

      Note: This functionality is not supported when the destination bucket is a directory bucket.
    • SSEKMSKeyId — (String)

      Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring 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.

      Note: This functionality is not supported when the destination bucket is a directory bucket.
    • 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. This value must be explicitly added to specify encryption context for CopyObject requests.

      Note: This functionality is not supported when the destination bucket is a directory bucket.
    • BucketKeyEnabled — (Boolean)

      Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object.

      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.

      For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

      Note: This functionality is not supported when the destination bucket is a directory bucket.
    • CopySourceSSECustomerAlgorithm — (String)

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

      If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

      Note: This functionality is not supported when the source object is in a directory bucket.
    • 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 the same one that was used when the source object was created.

      If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

      Note: This functionality is not supported when the source object is in a directory bucket.
    • 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.

      If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

      Note: This functionality is not supported when the source object is in a directory bucket.
    • 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "requester"
    • Tagging — (String)

      The tag-set for the object copy in the destination bucket. This value must be used in conjunction with the x-amz-tagging-directive if you choose REPLACE for the x-amz-tagging-directive. If you choose COPY for the x-amz-tagging-directive, you don't need to set the x-amz-tagging header, because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query parameters.

      The default value is the empty value.

      Note: Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations:
      • When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
      • When you attempt to REPLACE the tag-set of a source object and set a non-empty value to x-amz-tagging.
      • When you don't set the x-amz-tagging-directive header and the source object has non-empty tags. This is because the default value of x-amz-tagging-directive is COPY.
      Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed:
      • When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object.
      • When you attempt to REPLACE the tag-set of a directory bucket source object and set the x-amz-tagging value of the directory bucket destination object to empty.
      • When you attempt to REPLACE the tag-set of a general purpose bucket source object that has non-empty tags and set the x-amz-tagging value of the directory bucket destination object to empty.
      • When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the x-amz-tagging value of the directory bucket destination object. This is because the default value of x-amz-tagging is the empty value.
    • ObjectLockMode — (String)

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

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "GOVERNANCE"
      • "COMPLIANCE"
    • ObjectLockRetainUntilDate — (Date)

      The date and time when you want the Object Lock of the object copy to expire.

      Note: This functionality is not supported for directory buckets.
    • ObjectLockLegalHoldStatus — (String)

      Specifies whether you want to apply a legal hold to the object copy.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "ON"
      • "OFF"
    • ExpectedBucketOwner — (String)

      The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • ExpectedSourceBucketOwner — (String)

      The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • ChecksumCRC32 — (String)

          The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

        • ChecksumCRC32C — (String)

          The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

        • ChecksumSHA1 — (String)

          The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

        • ChecksumSHA256 — (String)

          The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      • Expiration — (String)

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

        Note: This functionality is not supported for directory buckets.
      • CopySourceVersionId — (String)

        Version ID of the source object that was copied.

        Note: This functionality is not supported when the source object is in a directory bucket.
      • VersionId — (String)

        Version ID of the newly created copy.

        Note: This functionality is not supported for directory buckets.
      • ServerSideEncryption — (String)

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

        Note: For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
        Possible values include:
        • "AES256"
        • "aws:kms"
        • "aws:kms:dsse"
      • SSECustomerAlgorithm — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

        Note: This functionality is not supported for directory buckets.
      • SSECustomerKeyMD5 — (String)

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

        Note: This functionality is not supported for directory buckets.
      • SSEKMSKeyId — (String)

        If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

        Note: This functionality is not supported for directory buckets.
      • SSEKMSEncryptionContext — (String)

        If present, indicates 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.

        Note: This functionality is not supported for directory buckets.
      • BucketKeyEnabled — (Boolean)

        Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

        Note: This functionality is not supported for directory buckets.
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "requester"

Returns:

  • (AWS.Request)

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

createBucket(params, callback) ⇒ AWS.Request

Note: This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see CreateBucket .

Creates a new S3 bucket. To create a bucket, you must set up 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.

There are two types of buckets: general purpose buckets and directory buckets. For more information about these bucket types, see Creating, configuring, and working with Amazon S3 buckets in the Amazon S3 User Guide.

Note:
  • General purpose buckets - If you send your CreateBucket request to the s3.amazonaws.com global endpoint, the request goes to the us-east-1 Region. So 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 in the Amazon S3 User Guide.
  • Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions
  • General purpose bucket permissions - In addition to the s3:CreateBucket permission, the following permissions are required in a policy when your CreateBucket request includes specific headers:

    • Access control lists (ACLs) - In your CreateBucket request, if you specify an access control list (ACL) and set it to public-read, public-read-write, authenticated-read, or if you explicitly specify any other custom ACLs, both s3:CreateBucket and s3:PutBucketAcl permissions are required. In your CreateBucket request, if you set the ACL to private, or if you don't specify any ACLs, only the s3:CreateBucket permission is required.

    • Object Lock - In your CreateBucket request, if you set x-amz-bucket-object-lock-enabled to true, the s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.

    • S3 Object Ownership - If your CreateBucket request includes the x-amz-object-ownership header, then the s3:PutBucketOwnershipControls permission is required.

      To set an ACL on a bucket as part of a CreateBucket request, you must explicitly set S3 Object Ownership for the bucket to a different value than the default, BucketOwnerEnforced. Additionally, if your desired bucket ACL grants public access, you must first create the bucket (without the bucket ACL) and then explicitly disable Block Public Access on the bucket before using PutBucketAcl to set the ACL. If you try to create a bucket with a public ACL, the request will fail.

      For the majority of modern use cases in S3, we recommend that you keep all Block Public Access settings enabled and keep ACLs disabled. If you would like to share data with users outside of your account, you can use bucket policies as needed. For more information, see Controlling ownership of objects and disabling ACLs for your bucket and Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.

    • S3 Block Public Access - If your specific use case requires granting public access to your S3 resources, you can disable Block Public Access. Specifically, you can create a new bucket with Block Public Access enabled, then separately call the DeletePublicAccessBlock API. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.

  • Directory bucket permissions - You must have the s3express:CreateBucket permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 Block Public Access are not supported for directory buckets. For directory buckets, all Block Public Access settings are enabled at the bucket level and S3 Object Ownership is set to Bucket owner enforced (ACLs disabled). These settings can't be modified.

    For more information about permissions for creating and working with directory buckets, see Directory buckets in the Amazon S3 User Guide. For more information about supported S3 features for directory buckets, see Features of S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

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 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/"
   }
   */
 });

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"
   }
   */
 });

Calling the createBucket operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ACL: private | public-read | public-read-write | authenticated-read,
  CreateBucketConfiguration: {
    Bucket: {
      DataRedundancy: SingleAvailabilityZone,
      Type: Directory
    },
    Location: {
      Name: 'STRING_VALUE',
      Type: AvailabilityZone
    },
    LocationConstraint: af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | EU | eu-central-1 | eu-north-1 | eu-south-1 | eu-south-2 | 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,
  ObjectOwnership: BucketOwnerPreferred | ObjectWriter | BucketOwnerEnforced
};
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.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
    • Bucket — (String)

      The name of the bucket to create.

      General purpose buckets - For information about bucket naming restrictions, see Bucket naming rules in the Amazon S3 User Guide.

      Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

    • CreateBucketConfiguration — (map)

      The configuration information for the bucket.

      • LocationConstraint — (String)

        Specifies the Region where the bucket will be created. 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 in the Amazon S3 User Guide.

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

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "af-south-1"
        • "ap-east-1"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "ap-northeast-3"
        • "ap-south-1"
        • "ap-south-2"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-southeast-3"
        • "ca-central-1"
        • "cn-north-1"
        • "cn-northwest-1"
        • "EU"
        • "eu-central-1"
        • "eu-north-1"
        • "eu-south-1"
        • "eu-south-2"
        • "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"
      • Location — (map)

        Specifies the location where the bucket will be created.

        For directory buckets, the location type is Availability Zone.

        Note: This functionality is only supported by directory buckets.
        • Type — (String)

          The type of location where the bucket will be created.

          Possible values include:
          • "AvailabilityZone"
        • Name — (String)

          The name of the location where the bucket will be created.

          For directory buckets, the name of the location is the AZ ID of the Availability Zone where the bucket will be created. An example AZ ID value is usw2-az1.

      • Bucket — (map)

        Specifies the information about the bucket that will be created.

        Note: This functionality is only supported by directory buckets.
        • DataRedundancy — (String)

          The number of Availability Zone that's used for redundancy for the bucket.

          Possible values include:
          • "SingleAvailabilityZone"
        • Type — (String)

          The type of bucket.

          Possible values include:
          • "Directory"
    • GrantFullControl — (String)

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

      Note: This functionality is not supported for directory buckets.
    • GrantRead — (String)

      Allows grantee to list the objects in the bucket.

      Note: This functionality is not supported for directory buckets.
    • GrantReadACP — (String)

      Allows grantee to read the bucket ACL.

      Note: This functionality is not supported for directory buckets.
    • 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.

      Note: This functionality is not supported for directory buckets.
    • GrantWriteACP — (String)

      Allows grantee to write the ACL for the applicable bucket.

      Note: This functionality is not supported for directory buckets.
    • ObjectLockEnabledForBucket — (Boolean)

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

      Note: This functionality is not supported for directory buckets.
    • ObjectOwnership — (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.

      BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or specify bucket owner full control ACLs (such as the predefined bucket-owner-full-control canned ACL or a custom ACL in XML format that grants the same permissions).

      By default, ObjectOwnership is set to BucketOwnerEnforced and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.
      Possible values include:
      • "BucketOwnerPreferred"
      • "ObjectWriter"
      • "BucketOwnerEnforced"

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)

        A forward slash followed by the name of the bucket.

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 in the Amazon S3 User Guide.

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 stops charging you for storing them only after you either complete or abort a multipart upload.

If you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart upload must be completed 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 Configuration.

Note:
  • Directory buckets - S3 Lifecycle is not supported by directory buckets.
  • Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Request signing

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) in the Amazon S3 User Guide.

Permissions
  • General purpose bucket permissions - For information about the permissions required to use the multipart upload API, see Multipart upload and permissions in the Amazon S3 User Guide.

    To perform a multipart upload with encryption by 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 and Protecting data using server-side encryption with Amazon Web Services KMS in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Encryption
  • General purpose buckets - 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. Amazon S3 automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a multipart upload, if you don't specify encryption information in your request, the encryption setting of the uploaded parts is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded parts. When you perform a CreateMultipartUpload operation, if you want to use a different type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the object with a different encryption key (such as an Amazon S3 managed key, a KMS key, or a customer-provided key). When the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence. 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 CreateMultipartUpload request.

    • Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (aws/s3) and KMS customer managed keys stored in Key Management Service (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 (aws/s3 key) in KMS to protect the data.
      • To perform a multipart upload with encryption by 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 and Protecting data using server-side encryption with Amazon Web Services KMS 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 is in a different account from the key, then you must have the permissions on both the key policy and your IAM user or role.
      • All GET and PUT requests for an object protected by KMS fail if you don't make them by using Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version 4. For information about configuring 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.

      For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys in the Amazon S3 User Guide.

    • Use customer-provided encryption keys (SSE-C) – 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 customer-provided encryption keys (SSE-C), see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C) in the Amazon S3 User Guide.

  • Directory buckets -For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

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',
  ChecksumAlgorithm: CRC32 | CRC32C | SHA1 | SHA256,
  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 | aws:kms:dsse,
  StorageClass: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOW | EXPRESS_ONEZONE,
  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. 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 in the Amazon S3 User Guide.

      By default, all objects are private. Only the owner has full access control. When uploading an object, you can grant access 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 new object. For more information, see Using ACLs. One way to grant the permissions using the request headers is to specify a canned ACL with the x-amz-acl request header.

      Note:
      • This functionality is not supported for directory buckets.
      • This functionality is not supported for 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 where the multipart upload is initiated and where the object is uploaded.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is 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.

      Note: For directory buckets, only the aws-chunked value is supported in this header field.
    • ContentLanguage — (String)

      The language that 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)

      Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

      By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

      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:
      • This functionality is not supported for directory buckets.
      • This functionality is not supported for Amazon S3 on Outposts.
    • GrantRead — (String)

      Specify access permissions explicitly to allow grantee to read the object data and its metadata.

      By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

      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:
      • This functionality is not supported for directory buckets.
      • This functionality is not supported for Amazon S3 on Outposts.
    • GrantReadACP — (String)

      Specify access permissions explicitly to allows grantee to read the object ACL.

      By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

      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:
      • This functionality is not supported for directory buckets.
      • This functionality is not supported for Amazon S3 on Outposts.
    • GrantWriteACP — (String)

      Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.

      By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

      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:
      • This functionality is not supported for directory buckets.
      • This functionality is not supported for 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 you store this object in Amazon S3 (for example, AES256, aws:kms).

      Note: For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
      Possible values include:
      • "AES256"
      • "aws:kms"
      • "aws:kms:dsse"
    • 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. For more information, see Storage Classes in the Amazon S3 User Guide.

      Note:
      • For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
      • Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
      Possible values include:
      • "STANDARD"
      • "REDUCED_REDUNDANCY"
      • "STANDARD_IA"
      • "ONEZONE_IA"
      • "INTELLIGENT_TIERING"
      • "GLACIER"
      • "DEEP_ARCHIVE"
      • "OUTPOSTS"
      • "GLACIER_IR"
      • "SNOW"
      • "EXPRESS_ONEZONE"
    • 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.

      Note: This functionality is not supported for directory buckets.
    • SSECustomerAlgorithm — (String)

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

      Note: This functionality is not supported for directory buckets.
    • 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.

      Note: This functionality is not supported for directory buckets.
    • SSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the customer-provided 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.

      Note: This functionality is not supported for directory buckets.
    • SSEKMSKeyId — (String)

      Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption customer managed key to use for object encryption.

      Note: This functionality is not supported for directory buckets.
    • 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.

      Note: This functionality is not supported for directory buckets.
    • BucketKeyEnabled — (Boolean)

      Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (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.

      Note: This functionality is not supported for directory buckets.
    • 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "requester"
    • Tagging — (String)

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

      Note: This functionality is not supported for directory buckets.
    • ObjectLockMode — (String)

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

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "GOVERNANCE"
      • "COMPLIANCE"
    • ObjectLockRetainUntilDate — (Date)

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

      Note: This functionality is not supported for directory buckets.
    • ObjectLockLegalHoldStatus — (String)

      Specifies whether you want to apply a legal hold to the uploaded object.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "ON"
      • "OFF"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • ChecksumAlgorithm — (String)

      Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      Possible values include:
      • "CRC32"
      • "CRC32C"
      • "SHA1"
      • "SHA256"

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 Configuration in the Amazon S3 User Guide.

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

        Note: This functionality is not supported for directory buckets.
      • 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.

        Note: This functionality is not supported for directory buckets.
      • 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.

        Note: Access points are not supported by directory buckets.
      • 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 you store this object in Amazon S3 (for example, AES256, aws:kms).

        Note: For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
        Possible values include:
        • "AES256"
        • "aws:kms"
        • "aws:kms:dsse"
      • SSECustomerAlgorithm — (String)

        If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

        Note: This functionality is not supported for directory buckets.
      • SSECustomerKeyMD5 — (String)

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

        Note: This functionality is not supported for directory buckets.
      • SSEKMSKeyId — (String)

        If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

        Note: This functionality is not supported for directory buckets.
      • SSEKMSEncryptionContext — (String)

        If present, indicates 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.

        Note: This functionality is not supported for directory buckets.
      • BucketKeyEnabled — (Boolean)

        Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

        Note: This functionality is not supported for directory buckets.
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "requester"
      • ChecksumAlgorithm — (String)

        The algorithm that was used to create a checksum of the object.

        Possible values include:
        • "CRC32"
        • "CRC32C"
        • "SHA1"
        • "SHA256"

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:

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

Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint APIs on directory buckets. For more information about Zonal endpoint APIs that include the Availability Zone in the request endpoint, see S3 Express One Zone APIs in the Amazon S3 User Guide.

To make Zonal endpoint API requests on a directory bucket, use the CreateSession API operation. Specifically, you grant s3express:CreateSession permission to a bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the CreateSession API request on the bucket, which returns temporary security credentials that include the access key ID, secret access key, session token, and expiration. These credentials have associated permissions to access the Zonal endpoint APIs. After the session is created, you don’t need to use other policies to grant permissions to each Zonal endpoint API individually. Instead, in your Zonal endpoint API requests, you sign your requests by applying the temporary security credentials of the session to the request headers and following the SigV4 protocol for authentication. You also apply the session token to the x-amz-s3session-token request header for authorization. Temporary security credentials are scoped to the bucket and expire after 5 minutes. After the expiration time, any calls that you make with those credentials will fail. You must use IAM credentials again to make a CreateSession API request that generates a new set of temporary credentials for use. Temporary credentials cannot be extended or refreshed beyond the original specified interval.

If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to initiate and manage requests to the CreateSession API. For more information, see Performance guidelines and design patterns in the Amazon S3 User Guide.

Note:
  • You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
  • CopyObject API operation - Unlike other Zonal endpoint APIs, the CopyObject API operation doesn't use the temporary security credentials returned from the CreateSession API operation for authentication and authorization. For information about authentication and authorization of the CopyObject API operation on directory buckets, see CopyObject.
  • HeadBucket API operation - Unlike other Zonal endpoint APIs, the HeadBucket API operation doesn't use the temporary security credentials returned from the CreateSession API operation for authentication and authorization. For information about authentication and authorization of the HeadBucket API operation on directory buckets, see HeadBucket.
Permissions

To obtain temporary security credentials, you must create a bucket policy or an IAM identity-based policy that grants s3express:CreateSession permission to the bucket. In a policy, you can have the s3express:SessionMode condition key to control who can create a ReadWrite or ReadOnly session. For more information about ReadWrite or ReadOnly sessions, see x-amz-create-session-mode . For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.

To grant cross-account access to Zonal endpoint APIs, the bucket policy should also grant both accounts the s3express:CreateSession permission.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

Service Reference:

Examples:

Calling the createSession operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  SessionMode: ReadOnly | ReadWrite
};
s3.createSession(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: {})
    • SessionMode — (String)

      Specifies the mode of the session that will be created, either ReadWrite or ReadOnly. By default, a ReadWrite session is created. A ReadWrite session is capable of executing all the Zonal endpoint APIs on a directory bucket. A ReadOnly session is constrained to execute the following Zonal endpoint APIs: GetObject, HeadObject, ListObjectsV2, GetObjectAttributes, ListParts, and ListMultipartUploads.

      Possible values include:
      • "ReadOnly"
      • "ReadWrite"
    • Bucket — (String)

      The name of the bucket that you create a session for.

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:

      • Credentials — (map)

        The established temporary security credentials for the created session.

        • AccessKeyIdrequired — (String)

          A unique identifier that's associated with a secret access key. The access key ID and the secret access key are used together to sign programmatic Amazon Web Services requests cryptographically.

        • SecretAccessKeyrequired — (String)

          A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services requests. Signing a request identifies the sender and prevents the request from being altered.

        • SessionTokenrequired — (String)

          A part of the temporary security credentials. The session token is used to validate the temporary security credentials.

        • Expirationrequired — (Date)

          Temporary security credentials expire after a specified interval. After temporary credentials expire, any calls that you make with those credentials will fail. So you must generate a new set of temporary credentials. Temporary credentials cannot be extended or refreshed beyond the original specified interval.

Returns:

  • (AWS.Request)

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

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.

Note:
  • Directory buckets - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed.
  • Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions
  • General purpose bucket permissions - You must have the s3:DeleteBucket permission on the specified bucket in a policy.

  • Directory bucket permissions - You must have the s3express:DeleteBucket permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to DeleteBucket:

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.

      Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

      Note: For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

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

Note: This operation is not supported by directory buckets.

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:

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default 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.

The following operations are related to DeleteBucketEncryption:

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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 three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

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 monitored and 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:

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

Note: This operation is not supported by directory buckets.

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:

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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:

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. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Deletes the policy of a specified bucket.

Note: Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

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 both have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order 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.

To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

  • General purpose bucket permissions - The s3:DeleteBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:DeleteBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

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.

      Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

      Note: For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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 an object from a bucket. The behavior depends on the bucket's versioning state:

  • If bucket versioning is not enabled, the operation permanently deletes the object.

  • If bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object. To permanently delete an object in a versioned bucket, you must include the object’s versionId in the request. For more information about versioning-enabled buckets, see Deleting object versions from a versioning-enabled bucket.

  • If bucket versioning is suspended, the operation removes the object that has a null versionId, if there is one, and inserts a delete marker that becomes the current version of the object. If there isn't an object with a null versionId, and all versions of the object have a versionId, Amazon S3 does not remove the object and only inserts a delete marker. To permanently delete an object that has a versionId, you must include the object’s versionId in the request. For more information about versioning-suspended buckets, see Deleting objects from versioning-suspended buckets.

Note:
  • Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
  • Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

To remove a specific version, you must use the versionId query parameter. Using this query parameter 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 in the Amazon S3 User Guide. To see sample requests that use versioning, see Sample Request.

Note: Directory buckets - MFA delete is not supported by directory buckets.

You can delete objects by explicitly calling DELETE Object or calling (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.

Note: Directory buckets - S3 Lifecycle is not supported by directory buckets.
Permissions
  • General purpose bucket permissions - The following permissions are required in your policies when your DeleteObjects request includes specific headers.

    • s3:DeleteObject - To delete an object from a bucket, you must always have the s3:DeleteObject permission.

    • s3:DeleteObjectVersion - To delete a specific version of an object from a versioning-enabled bucket, you must have the s3:DeleteObjectVersion permission.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following action is related to DeleteObject:

Service Reference:

Examples:

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 = {
   }
   */
 });

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 = {
   }
   */
 });

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.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is 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.

      Note: This functionality is not supported for directory buckets.
    • VersionId — (String)

      Version ID used to reference a specific version of the object.

      Note: For directory buckets in this API operation, only the null value of the version ID is supported.
    • 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      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:BypassGovernanceRetention permission.

      Note: This functionality is not supported for directory buckets.
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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)

        Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.

        Note: This functionality is not supported for directory buckets.
      • VersionId — (String)

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

        Note: This functionality is not supported for directory buckets.
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "requester"

Returns:

  • (AWS.Request)

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

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

This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.

The request can contain 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 operation 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.

Note:
  • Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
  • Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

The operation supports two modes for the response: verbose and quiet. By default, the operation 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 operation encountered an error. For a successful deletion in a quiet mode, the operation 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 in the Amazon S3 User Guide.

Note: Directory buckets - MFA delete is not supported by directory buckets.
Permissions
  • General purpose bucket permissions - The following permissions are required in your policies when your DeleteObjects request includes specific headers.

    • s3:DeleteObject - To delete an object from a bucket, you must always specify the s3:DeleteObject permission.

    • s3:DeleteObjectVersion - To delete a specific version of an object from a versioning-enabled bucket, you must specify the s3:DeleteObjectVersion permission.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Content-MD5 request header
  • General purpose bucket - The Content-MD5 request 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.

  • Directory bucket - The Content-MD5 request header or a additional checksum request header (including x-amz-checksum-crc32, x-amz-checksum-crc32c, x-amz-checksum-sha1, or x-amz-checksum-sha256) is required for all Multi-Object Delete requests.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to DeleteObjects:

Service Reference:

Examples:

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"
     }
    ]
   }
   */
 });

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"
     }
    ]
   }
   */
 });

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,
  ChecksumAlgorithm: CRC32 | CRC32C | SHA1 | SHA256,
  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.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

    • Delete — (map)

      Container for the request.

      • Objectsrequired — (Array<map>)

        The object to delete.

        Note: Directory buckets - For directory buckets, an object that's composed entirely of whitespace characters is not supported by the DeleteObjects API operation. The request will receive a 400 Bad Request error and none of the objects in the request will be deleted.
        • Keyrequired — (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)

          Version ID for the specific version of the object to delete.

          Note: This functionality is not supported for directory buckets.
      • 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.

      When performing the DeleteObjects operation on an MFA delete enabled bucket, which attempts to delete the specified versioned objects, you must include an MFA token. If you don't provide an MFA token, the entire request will fail, even if there are non-versioned objects that you are trying to delete. If you provide an invalid token, whether there are versioned object keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
    • 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      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:BypassGovernanceRetention permission.

      Note: This functionality is not supported for directory buckets.
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • ChecksumAlgorithm — (String)

      Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

      For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:

      • CRC32

      • CRC32C

      • SHA1

      • SHA256

      For more information, see Checking object integrity in the Amazon S3 User Guide.

      If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .

      If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

      Possible values include:
      • "CRC32"
      • "CRC32C"
      • "SHA1"
      • "SHA256"

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.

          Note: This functionality is not supported for directory buckets.
        • DeleteMarker — (Boolean)

          Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.

          Note: This functionality is not supported for directory buckets.
        • 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.

          Note: This functionality is not supported for directory buckets.
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        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.

          Note: This functionality is not supported for directory buckets.
        • 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. The following is a list of Amazon S3 error codes. For more information, see Error responses.

            • 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: Service is unable to handle request.

            • 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

Note: This operation is not supported by directory buckets.

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 DeleteObjectTagging:

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.

      Access points - When you use this action with 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 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.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is 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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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.

The following operations are related to GetBucketAccelerateConfiguration:

Examples:

Calling the getBucketAccelerateConfiguration operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ExpectedBucketOwner: 'STRING_VALUE',
  RequestPayer: requester
};
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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      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:

      • Status — (String)

        The accelerate configuration of the bucket.

        Possible values include:
        • "Enabled"
        • "Suspended"
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "requester"

Returns:

  • (AWS.Request)

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

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

Note: This operation is not supported by directory buckets.

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

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

Note: If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

The following operations are related to GetBucketAcl:

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.

      When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

      When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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. This value 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)

          Note: This functionality is not supported for directory buckets.
        • 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.

          • Typerequired — (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

Note: This operation is not supported by directory buckets.

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.

The following operations are related to GetBucketAnalyticsConfiguration:

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • Idrequired — (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.

            • Keyrequired — (String)

              Name of the object key.

            • Valuerequired — (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.

              • Keyrequired — (String)

                Name of the object key.

              • Valuerequired — (String)

                Value of the tag.

        • StorageClassAnalysisrequired — (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.

            • OutputSchemaVersionrequired — (String)

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

              Possible values include:
              • "V_1"
            • Destinationrequired — (map)

              The place to store the data for an analysis.

              • S3BucketDestinationrequired — (map)

                A destination signifying output to an S3 bucket.

                • Formatrequired — (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.
                • Bucketrequired — (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

Note: This operation is not supported by directory buckets.

Returns the Cross-Origin Resource Sharing (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.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

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.

      When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

      When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • AllowedMethodsrequired — (Array<String>)

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

        • AllowedOriginsrequired — (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

Note: This operation is not supported by directory buckets.

Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • Rulesrequired — (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.

            • SSEAlgorithmrequired — (String)

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

              Possible values include:
              • "AES256"
              • "aws:kms"
              • "aws:kms:dsse"
            • 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 or aws:kms:dsse.

              You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.

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

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

              • Key Alias: alias/alias-name

              If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.

              If you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

              Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS 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

Note: This operation is not supported by directory buckets.

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 three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

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 monitored and 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:

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.

        • Idrequired — (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.

            • Keyrequired — (String)

              Name of the object key.

            • Valuerequired — (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.

              • Keyrequired — (String)

                Name of the object key.

              • Valuerequired — (String)

                Value of the tag.

        • Statusrequired — (String)

          Specifies the status of the configuration.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • Tieringsrequired — (Array<map>)

          Specifies the S3 Intelligent-Tiering storage class tier of the configuration.

          • Daysrequired — (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).

          • AccessTierrequired — (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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • Destinationrequired — (map)

          Contains information about where to publish the inventory results.

          • S3BucketDestinationrequired — (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.
            • Bucketrequired — (String)

              The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

            • Formatrequired — (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.

                • KeyIdrequired — (String)

                  Specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key to use for encrypting inventory reports.

        • IsEnabledrequired — (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.

          • Prefixrequired — (String)

            The prefix that an object must have to be included in the inventory results.

        • Idrequired — (String)

          The ID used to identify the inventory configuration.

        • IncludedObjectVersionsrequired — (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.

        • Schedulerequired — (map)

          Specifies the schedule for generating inventory results.

          • Frequencyrequired — (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.

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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. The date value must conform to the ISO 8601 format. The time is always midnight UTC.

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

        • Prefixrequired — (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.

        • Statusrequired — (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"
            • "GLACIER_IR"
        • NoncurrentVersionTransition — (map)

          Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, 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_IR, 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"
            • "GLACIER_IR"
          • NewerNoncurrentVersions — (Integer)

            Specifies how many noncurrent versions Amazon S3 will retain in the same storage class before transitioning objects. You can specify up to 100 noncurrent versions to retain. Amazon S3 will transition any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.

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

          • NoncurrentDays — (Integer)

            Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.

          • NewerNoncurrentVersions — (Integer)

            Specifies how many noncurrent versions Amazon S3 will retain. You can specify up to 100 noncurrent versions to retain. Amazon S3 will permanently delete any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.

        • 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 Configuration 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: This operation is not supported by directory buckets.

Note: Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. 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 GetBucketLifecycle. 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,

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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. The date value must conform to the ISO 8601 format. The time is always midnight UTC.

          • 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 contain 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.

            • Keyrequired — (String)

              Name of the object key.

            • Valuerequired — (String)

              Value of the tag.

          • ObjectSizeGreaterThan — (Integer)

            Minimum object size to which the rule applies.

          • ObjectSizeLessThan — (Integer)

            Maximum object size to which the rule applies.

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

              • Keyrequired — (String)

                Name of the object key.

              • Valuerequired — (String)

                Value of the tag.

            • ObjectSizeGreaterThan — (Integer)

              Minimum object size to which the rule applies.

            • ObjectSizeLessThan — (Integer)

              Maximum object size to which the rule applies.

        • Statusrequired — (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"
            • "GLACIER_IR"
        • 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"
            • "GLACIER_IR"
          • NewerNoncurrentVersions — (Integer)

            Specifies how many noncurrent versions Amazon S3 will retain in the same storage class before transitioning objects. You can specify up to 100 noncurrent versions to retain. Amazon S3 will transition any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.

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

          • NoncurrentDays — (Integer)

            Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.

          • NewerNoncurrentVersions — (Integer)

            Specifies how many noncurrent versions Amazon S3 will retain. You can specify up to 100 noncurrent versions to retain. Amazon S3 will permanently delete any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.

        • 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 Configuration 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

Note: This operation is not supported by directory buckets.

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.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

Note: We recommend that you use HeadBucket to return the Region that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.

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.

      When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

      When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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-south-2"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-southeast-3"
        • "ca-central-1"
        • "cn-north-1"
        • "cn-northwest-1"
        • "EU"
        • "eu-central-1"
        • "eu-north-1"
        • "eu-south-1"
        • "eu-south-2"
        • "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

Note: This operation is not supported by directory buckets.

Returns the logging status of a bucket and the permissions users have to view and modify that status.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • TargetBucketrequired — (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.

          Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.

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

            • Typerequired — (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"
        • TargetPrefixrequired — (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.

        • TargetObjectKeyFormat — (map)

          Amazon S3 key format for log objects.

          • SimplePrefix — (map)

            To use the simple format for S3 keys for log objects. To specify SimplePrefix format, set SimplePrefix to {}.

          • PartitionedPrefix — (map)

            Partitioned S3 key for log objects.

            • PartitionDateSource — (String)

              Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.

              Possible values include:
              • "EventTime"
              • "DeliveryTime"

Returns:

  • (AWS.Request)

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

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

Note: This operation is not supported by directory buckets.

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. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • Idrequired — (String)

          The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

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

            • Keyrequired — (String)

              Name of the object key.

            • Valuerequired — (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.

              • Keyrequired — (String)

                Name of the object key.

              • Valuerequired — (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

Note: This operation is not supported by directory buckets.

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.

      When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

      When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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"
          • "s3:ObjectRestore:Delete"
          • "s3:LifecycleTransition"
          • "s3:IntelligentTiering"
          • "s3:ObjectAcl:Put"
          • "s3:LifecycleExpiration:*"
          • "s3:LifecycleExpiration:Delete"
          • "s3:LifecycleExpiration:DeleteMarkerCreated"
          • "s3:ObjectTagging:*"
          • "s3:ObjectTagging:Put"
          • "s3:ObjectTagging:Delete"
        • 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"
          • "s3:ObjectRestore:Delete"
          • "s3:LifecycleTransition"
          • "s3:IntelligentTiering"
          • "s3:ObjectAcl:Put"
          • "s3:LifecycleExpiration:*"
          • "s3:LifecycleExpiration:Delete"
          • "s3:LifecycleExpiration:DeleteMarkerCreated"
          • "s3:ObjectTagging:*"
          • "s3:ObjectTagging:Put"
          • "s3:ObjectTagging:Delete"
        • 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"
          • "s3:ObjectRestore:Delete"
          • "s3:LifecycleTransition"
          • "s3:IntelligentTiering"
          • "s3:ObjectAcl:Put"
          • "s3:LifecycleExpiration:*"
          • "s3:LifecycleExpiration:Delete"
          • "s3:LifecycleExpiration:DeleteMarkerCreated"
          • "s3:ObjectTagging:*"
          • "s3:ObjectTagging:Put"
          • "s3:ObjectTagging:Delete"
        • 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

Note: This operation is not supported by directory buckets.

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.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

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:

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.

      When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

      When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • TopicArnrequired — (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.

        • Eventsrequired — (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 using object key name filtering 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.

        • QueueArnrequired — (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.

        • Eventsrequired — (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 using object key name filtering 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.

        • LambdaFunctionArnrequired — (String)

          The Amazon Resource Name (ARN) of the Lambda function that Amazon S3 invokes when the specified event type occurs.

        • Eventsrequired — (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 using object key name filtering 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.

      • EventBridgeConfiguration — (map)

        Enables delivery of events to Amazon EventBridge.

Returns:

  • (AWS.Request)

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

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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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 (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.

        • Rulesrequired — (Array<map>)

          The container element for an ownership control rule.

          • ObjectOwnershiprequired — (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.

            BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or specify bucket owner full control ACLs (such as the predefined bucket-owner-full-control canned ACL or a custom ACL in XML format that grants the same permissions).

            By default, ObjectOwnership is set to BucketOwnerEnforced and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.

            Note: This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.
            Possible values include:
            • "BucketOwnerPreferred"
            • "ObjectWriter"
            • "BucketOwnerEnforced"

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.

Note: Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

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

To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

  • General purpose bucket permissions - The s3:GetBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:GetBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

Example bucket policies

General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.

Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

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 to get the bucket policy for.

      Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

      Access points - When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

      Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

      Note: Access points and Object Lambda access points are not supported by directory buckets.
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

      Note: For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • Rolerequired — (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.

        • Rulesrequired — (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.

              • Keyrequired — (String)

                Name of the object key.

              • Valuerequired — (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.

                • Keyrequired — (String)

                  Name of the object key.

                • Valuerequired — (String)

                  Value of the tag.

          • Statusrequired — (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.

              • Statusrequired — (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
              • Statusrequired — (String)

                Specifies whether Amazon S3 replicates modifications on replicas.

                Possible values include:
                • "Enabled"
                • "Disabled"
          • ExistingObjectReplication — (map)

            Optional configuration to replicate existing source bucket objects. For more information, see Replicating Existing Objects in the Amazon S3 User Guide.

            • Statusrequired — (String)

              Specifies whether Amazon S3 replicates existing source bucket objects.

              Possible values include:
              • "Enabled"
              • "Disabled"
          • Destinationrequired — (map)

            A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).

            • Bucketrequired — (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"
              • "GLACIER_IR"
              • "SNOW"
              • "EXPRESS_ONEZONE"
            • 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.

              • Ownerrequired — (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 encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS 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.

              • Statusrequired — (String)

                Specifies whether the replication time is enabled.

                Possible values include:
                • "Enabled"
                • "Disabled"
              • Timerequired — (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.

              • Statusrequired — (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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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: NoSuchTagSet

    • 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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • Keyrequired — (String)

          Name of the object key.

        • Valuerequired — (String)

          Value of the tag.

Returns:

  • (AWS.Request)

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

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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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 GetBucketWebsite:

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • HostNamerequired — (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).

        • Suffixrequired — (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.

        • Keyrequired — (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.

        • Redirectrequired — (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 an object from Amazon S3.

In the GetObject request, specify the full key name for the object.

General purpose buckets - Both the virtual-hosted-style requests and the path-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the object key name 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 object key name as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification in the Amazon S3 User Guide.

Directory buckets - Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket--use1-az5--x-s3, specify the object key name as /photos/2006/February/sample.jpg. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

Permissions
  • General purpose bucket permissions - You must have the required permissions in a policy. To use GetObject, you must have the READ access to the object (or version). If you grant READ access to the anonymous user, the GetObject operation returns the object without using an authorization header. For more information, see Specifying permissions in a policy in the Amazon S3 User Guide.

    If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.

    If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.

    If the object that you request doesn’t exist, the error that 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 Not Found error.

    • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Access Denied error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Storage classes

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.

Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. Unsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for the GetObject requests, if your object uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your GetObject requests for the object that uses these types of keys, you’ll get an HTTP 400 Bad Request error.

Overriding response header values through the request

There are times when you want to override certain response header values of a GetObject response. For example, you might override the Content-Disposition response header value through your GetObject request.

You can override values for a set of response headers. These modified response header values are included only in a successful response, that is, when the HTTP status code 200 OK is returned. The headers you can override using the following query parameters in the request are a subset of the headers that Amazon S3 accepts when you create an object.

The response headers that you can override for the GetObject response are Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, and Expires.

To override values for a set of response headers in the GetObject response, you can use the following query parameters in the request.

  • response-cache-control

  • response-content-disposition

  • response-content-encoding

  • response-content-language

  • response-content-type

  • response-expires

Note: When you use these parameters, you must sign the request by using either an Authorization header or a presigned URL. These parameters cannot be used with an unsigned (anonymous) request.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to GetObject:

Service Reference:

Examples:

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"
   }
   */
 });

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"
   }
   */
 });

Calling the getObject operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ChecksumMode: ENABLED,
  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.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Object Lambda access points - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is 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 in this header; otherwise, return a 412 Precondition Failed error.

      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.

      For more information about conditional requests, see RFC 7232.

    • IfModifiedSince — (Date)

      Return the object only if it has been modified since the specified time; otherwise, return a 304 Not Modified error.

      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 status code.

      For more information about conditional requests, see RFC 7232.

    • IfNoneMatch — (String)

      Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a 304 Not Modified error.

      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 HTTP status code.

      For more information about conditional requests, see RFC 7232.

    • IfUnmodifiedSince — (Date)

      Return the object only if it has not been modified since the specified time; otherwise, return a 412 Precondition Failed error.

      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.

      For more information about conditional requests, see RFC 7232.

    • Key — (String)

      Key of the object to get.

    • Range — (String)

      Downloads the specified byte range of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.

      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)

      Version ID used to reference a specific version of the object.

      By default, the GetObject operation returns the current version of an object. To return a different version, use the versionId subresource.

      Note:
      • If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.
      • If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.
      • Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

      For more information about versioning, see PutBucketVersioning.

    • SSECustomerAlgorithm — (String)

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

      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) in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. 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.

      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) in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
    • SSECustomerKeyMD5 — (String)

      Specifies the 128-bit MD5 digest of the customer-provided 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.

      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) in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
    • 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • ChecksumMode — (String)

      To retrieve the checksum, this mode must be enabled.

      Possible values include:
      • "ENABLED"

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)

        Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

        Note:
        • 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.
        • If the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
      • AcceptRanges — (String)

        Indicates that a range of bytes was specified in the request.

      • Expiration — (String)

        If the object expiration is configured (see PutBucketLifecycleConfiguration ), 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.

        Note: This functionality is not supported for directory buckets.
      • Restore — (String)

        Provides information about object restoration action and expiration time of the restored object copy.

        Note: This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
      • LastModified — (Date)

        Date and time when the object was last modified.

        General purpose buckets - When you specify a versionId of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

      • ContentLength — (Integer)

        Size of the body in bytes.

      • ETag — (String)

        An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

      • ChecksumCRC32 — (String)

        The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      • ChecksumCRC32C — (String)

        The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      • ChecksumSHA1 — (String)

        The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      • ChecksumSHA256 — (String)

        The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      • MissingMeta — (Integer)

        This is set to the number of metadata entries not returned in the headers that are prefixed with x-amz-meta-. 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.

        Note: This functionality is not supported for directory buckets.
      • VersionId — (String)

        Version ID of the object.

        Note: This functionality is not supported for directory buckets.
      • CacheControl — (String)

        Specifies caching behavior along the request/reply chain.

      • ContentDisposition — (String)

        Specifies presentational information for the object.

      • ContentEncoding — (String)

        Indicates 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) Deprecated in favor of ExpiresString.
      • ExpiresString — (String)

        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.

        Note: This functionality is not supported for directory buckets.
      • ServerSideEncryption — (String)

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

        Note: For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
        Possible values include:
        • "AES256"
        • "aws:kms"
        • "aws:kms:dsse"
      • 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 to confirm the encryption algorithm that's used.

        Note: This functionality is not supported for directory buckets.
      • SSECustomerKeyMD5 — (String)

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

        Note: This functionality is not supported for directory buckets.
      • SSEKMSKeyId — (String)

        If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

        Note: This functionality is not supported for directory buckets.
      • BucketKeyEnabled — (Boolean)

        Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

        Note: This functionality is not supported for directory buckets.
      • StorageClass — (String)

        Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

        Note: Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
        Possible values include:
        • "STANDARD"
        • "REDUCED_REDUNDANCY"
        • "STANDARD_IA"
        • "ONEZONE_IA"
        • "INTELLIGENT_TIERING"
        • "GLACIER"
        • "DEEP_ARCHIVE"
        • "OUTPOSTS"
        • "GLACIER_IR"
        • "SNOW"
        • "EXPRESS_ONEZONE"
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        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.

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "COMPLETE"
        • "PENDING"
        • "FAILED"
        • "REPLICA"
        • "COMPLETED"
      • PartsCount — (Integer)

        The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

      • TagCount — (Integer)

        The number of tags, if any, on the object, when you have the relevant permission to read object tags.

        You can use GetObjectTagging to retrieve the tag set associated with an object.

        Note: This functionality is not supported for directory buckets.
      • ObjectLockMode — (String)

        The Object Lock mode that's currently in place for this object.

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "GOVERNANCE"
        • "COMPLIANCE"
      • ObjectLockRetainUntilDate — (Date)

        The date and time when this object's Object Lock will expire.

        Note: This functionality is not supported for directory buckets.
      • 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.

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "ON"
        • "OFF"

Returns:

  • (AWS.Request)

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

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

Note: This operation is not supported by directory buckets.

Returns the access control list (ACL) of an object. To use this operation, you must have s3:GetObjectAcl permissions or READ_ACP access to the object. For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3 User Guide

This functionality is not supported for Amazon S3 on Outposts.

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.

Note: If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

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.

      Access points - When you use this action with 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 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)

      Version ID used to reference a specific version of the object.

      Note: This functionality is not supported for directory buckets.
    • 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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. This value 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)

          Note: This functionality is not supported for directory buckets.
        • 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.

          • Typerequired — (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.

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "requester"

Returns:

  • (AWS.Request)

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

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

Retrieves all the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.

GetObjectAttributes combines the functionality of HeadObject and ListParts. All of the data returned with each of those individual calls can be returned with a single call to GetObjectAttributes.

Note: Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions
  • General purpose bucket permissions - To use GetObjectAttributes, you must have READ access to the object. The permissions that you need to use this operation with depend on whether the bucket is versioned. If the bucket is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a Policy in the Amazon S3 User Guide. If the object that 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 Not Found ("no such key") error.

    • If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden ("access denied") error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Encryption
Note: Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a GET request for an object that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.

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 to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:

  • 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) in the Amazon S3 User Guide.

Note: Directory bucket permissions - For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
Versioning

Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

Conditional request headers

Consider the following when using request headers:

  • If both of the If-Match and If-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested:

    • If-Match condition evaluates to true.

    • If-Unmodified-Since condition evaluates to false.

    For more information about conditional requests, see RFC 7232.

  • If both of the If-None-Match and If-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 304 Not Modified:

    • If-None-Match condition evaluates to false.

    • If-Modified-Since condition evaluates to true.

    For more information about conditional requests, see RFC 7232.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following actions are related to GetObjectAttributes:

Service Reference:

Examples:

Calling the getObjectAttributes operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  ObjectAttributes: [ /* required */
    ETag | Checksum | ObjectParts | StorageClass | ObjectSize,
    /* more items */
  ],
  ExpectedBucketOwner: 'STRING_VALUE',
  MaxParts: 'NUMBER_VALUE',
  PartNumberMarker: 'NUMBER_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.getObjectAttributes(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 that contains the object.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

    • Key — (String)

      The object key.

    • VersionId — (String)

      The version ID used to reference a specific version of the object.

      Note: S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
    • 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.

    • SSECustomerAlgorithm — (String)

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

      Note: This functionality is not supported for directory buckets.
    • 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.

      Note: This functionality is not supported for directory buckets.
    • 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.

      Note: This functionality is not supported for directory buckets.
    • 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • ObjectAttributes — (Array<String>)

      Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

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.

        Note: This functionality is not supported for directory buckets.
      • LastModified — (Date)

        The creation date of the object.

      • VersionId — (String)

        The version ID of the object.

        Note: This functionality is not supported for directory buckets.
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "requester"
      • ETag — (String)

        An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

      • Checksum — (map)

        The checksum or digest of the object.

        • ChecksumCRC32 — (String)

          The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

        • ChecksumCRC32C — (String)

          The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

        • ChecksumSHA1 — (String)

          The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

        • ChecksumSHA256 — (String)

          The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      • ObjectParts — (map)

        A collection of parts associated with a multipart upload.

        • TotalPartsCount — (Integer)

          The total number of parts.

        • PartNumberMarker — (Integer)

          The marker for the current part.

        • 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 PartNumberMarker request parameter in a subsequent request.

        • MaxParts — (Integer)

          The maximum number of parts allowed in the response.

        • IsTruncated — (Boolean)

          Indicates whether the returned list of parts is truncated. A value of true 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>)

          A container for elements related to a particular part. A response can contain zero or more Parts elements.

          Note:
          • General purpose buckets - For GetObjectAttributes, if a additional checksum (including x-amz-checksum-crc32, x-amz-checksum-crc32c, x-amz-checksum-sha1, or x-amz-checksum-sha256) isn't applied to the object specified in the request, the response doesn't return Part.
          • Directory buckets - For GetObjectAttributes, no matter whether a additional checksum is applied to the object specified in the request, the response returns Part.
          • PartNumber — (Integer)

            The part number identifying the part. This value is a positive integer between 1 and 10,000.

          • Size — (Integer)

            The size of the uploaded part in bytes.

          • ChecksumCRC32 — (String)

            This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

          • ChecksumCRC32C — (String)

            The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

          • ChecksumSHA1 — (String)

            The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

          • ChecksumSHA256 — (String)

            The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      • StorageClass — (String)

        Provides the 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.

        Note: Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
        Possible values include:
        • "STANDARD"
        • "REDUCED_REDUNDANCY"
        • "STANDARD_IA"
        • "ONEZONE_IA"
        • "INTELLIGENT_TIERING"
        • "GLACIER"
        • "DEEP_ARCHIVE"
        • "OUTPOSTS"
        • "GLACIER_IR"
        • "SNOW"
        • "EXPRESS_ONEZONE"
      • ObjectSize — (Integer)

        The size of the object in bytes.

Returns:

  • (AWS.Request)

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

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

Note: This operation is not supported by directory buckets.

Gets an object's current legal hold status. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to GetObjectLegalHold:

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.

      Access points - When you use this action with 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 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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.

The following action is related to GetObjectLockConfiguration:

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.

      Access points - When you use this action with 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 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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

Retrieves an object's retention settings. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to GetObjectRetention:

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.

      Access points - When you use this action with 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 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Note: This operation is not supported by directory buckets.

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 actions are 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.

      Access points - When you use this action with 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 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.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is 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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      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.

        • Keyrequired — (String)

          Name of the object key.

        • Valuerequired — (String)

          Value of the tag.

Returns:

  • (AWS.Request)

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

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

Note: This operation is not supported by directory buckets.

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.

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 functionality is not supported for 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "requester"

Returns:

  • (AWS.Request)

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

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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

You can use this operation to determine if a bucket exists and if 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 400 Bad Request, 403 Forbidden or 404 Not Found code. A message body is not included, so you cannot determine the exception beyond these HTTP response codes.

Note: Directory buckets - You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Authentication and authorization

All HeadBucket requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.

Directory bucket - You must use IAM credentials to authenticate and authorize your access to the HeadBucket API operation, instead of using the temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

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
   /*
   data = {
   }
   */
 });

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.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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:

      • BucketLocationType — (String)

        The type of location where the bucket is created.

        Note: This functionality is only supported by directory buckets.
        Possible values include:
        • "AvailabilityZone"
      • BucketLocationName — (String)

        The name of the location where the bucket will be created.

        For directory buckets, the AZ ID of the Availability Zone where the bucket is created. An example AZ ID value is usw2-az1.

        Note: This functionality is only supported by directory buckets.
      • BucketRegion — (String)

        The Region that the bucket is located.

        Note: This functionality is not supported for directory buckets.
      • AccessPointAlias — (Boolean)

        Indicates whether the bucket name used in the request is an access point alias.

        Note: This functionality is not supported for directory buckets.

Returns:

  • (AWS.Request)

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

Waiter Resource States:

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

The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.

A HEAD request has the same options as a GET operation 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 code, such as 400 Bad Request, 403 Forbidden, 404 Not Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. It's not possible to retrieve the exact exception of these error codes.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

Note: Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - To use HEAD, you must have the s3:GetObject permission. You need the relevant read object (or version) permission for this operation. For more information, see Actions, resources, and condition keys for Amazon S3 in the Amazon S3 User Guide.

    If the object you request doesn't exist, the error that 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 Not Found error.

    • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Encryption
Note: Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a HEAD request for an object that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.

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 to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:

  • 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) in the Amazon S3 User Guide.

Note: Directory bucket permissions - For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
Versioning
  • 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.

  • If the specified version is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

Note:
  • Directory buckets - Delete marker is not supported by directory buckets.
  • Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following actions are 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 */
  ChecksumMode: ENABLED,
  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.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 that contains the object.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is 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) error.

      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.

      For more information about conditional requests, see RFC 7232.

    • IfModifiedSince — (Date)

      Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

      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.

    • IfNoneMatch — (String)

      Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

      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.

    • IfUnmodifiedSince — (Date)

      Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

      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.

      For more information about conditional requests, see RFC 7232.

    • Key — (String)

      The object key.

    • Range — (String)

      HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

    • 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)

      Version ID used to reference a specific version of the object.

      Note: For directory buckets in this API operation, only the null value of the version ID is supported.
    • SSECustomerAlgorithm — (String)

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

      Note: This functionality is not supported for directory buckets.
    • 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.

      Note: This functionality is not supported for directory buckets.
    • 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.

      Note: This functionality is not supported for directory buckets.
    • 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • ChecksumMode — (String)

      To retrieve the checksum, this parameter must be enabled.

      In addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt action for the request to succeed.

      Possible values include:
      • "ENABLED"

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.

        Note: This functionality is not supported for directory buckets.
      • AcceptRanges — (String)

        Indicates that a range of bytes was specified.

      • Expiration — (String)

        If the object expiration is configured (see PutBucketLifecycleConfiguration ), 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.

        Note: This functionality is not supported for directory buckets.
      • 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.

        Note: This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
      • ArchiveStatus — (String)

        The archive state of the head object.

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "ARCHIVE_ACCESS"
        • "DEEP_ARCHIVE_ACCESS"
      • LastModified — (Date)

        Date and time when the object was last modified.

      • ContentLength — (Integer)

        Size of the body in bytes.

      • ChecksumCRC32 — (String)

        The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      • ChecksumCRC32C — (String)

        The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      • ChecksumSHA1 — (String)

        The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      • ChecksumSHA256 — (String)

        The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      • ETag — (String)

        An entity tag (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.

        Note: This functionality is not supported for directory buckets.
      • VersionId — (String)

        Version ID of the object.

        Note: This functionality is not supported for directory buckets.
      • CacheControl — (String)

        Specifies caching behavior along the request/reply chain.

      • ContentDisposition — (String)

        Specifies presentational information for the object.

      • ContentEncoding — (String)

        Indicates 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) Deprecated in favor of ExpiresString.
      • ExpiresString — (String)

        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.

        Note: This functionality is not supported for directory buckets.
      • ServerSideEncryption — (String)

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

        Note: For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
        Possible values include:
        • "AES256"
        • "aws:kms"
        • "aws:kms:dsse"
      • 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 to confirm the encryption algorithm that's used.

        Note: This functionality is not supported for directory buckets.
      • SSECustomerKeyMD5 — (String)

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

        Note: This functionality is not supported for directory buckets.
      • SSEKMSKeyId — (String)

        If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

        Note: This functionality is not supported for directory buckets.
      • BucketKeyEnabled — (Boolean)

        Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

        Note: This functionality is not supported for directory buckets.
      • 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.

        Note: Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
        Possible values include:
        • "STANDARD"
        • "REDUCED_REDUNDANCY"
        • "STANDARD_IA"
        • "ONEZONE_IA"
        • "INTELLIGENT_TIERING"
        • "GLACIER"
        • "DEEP_ARCHIVE"
        • "OUTPOSTS"
        • "GLACIER_IR"
        • "SNOW"
        • "EXPRESS_ONEZONE"
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        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.

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "COMPLETE"
        • "PENDING"
        • "FAILED"
        • "REPLICA"
        • "COMPLETED"
      • PartsCount — (Integer)

        The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

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

        Note: This functionality is not supported for directory buckets.
        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.

        Note: This functionality is not supported for directory buckets.
      • 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.

        Note: This functionality is not supported for directory buckets.
        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

Note: This operation is not supported by directory buckets.

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:

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • Idrequired — (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.

            • Keyrequired — (String)

              Name of the object key.

            • Valuerequired — (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.

              • Keyrequired — (String)

                Name of the object key.

              • Valuerequired — (String)

                Value of the tag.

        • StorageClassAnalysisrequired — (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.

            • OutputSchemaVersionrequired — (String)

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

              Possible values include:
              • "V_1"
            • Destinationrequired — (map)

              The place to store the data for an analysis.

              • S3BucketDestinationrequired — (map)

                A destination signifying output to an S3 bucket.

                • Formatrequired — (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.
                • Bucketrequired — (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

Note: This operation is not supported by directory buckets.

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 three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

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 monitored and 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:

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.

        • Idrequired — (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.

            • Keyrequired — (String)

              Name of the object key.

            • Valuerequired — (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.

              • Keyrequired — (String)

                Name of the object key.

              • Valuerequired — (String)

                Value of the tag.

        • Statusrequired — (String)

          Specifies the status of the configuration.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • Tieringsrequired — (Array<map>)

          Specifies the S3 Intelligent-Tiering storage class tier of the configuration.

          • Daysrequired — (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).

          • AccessTierrequired — (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

Note: This operation is not supported by directory buckets.

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:

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • Destinationrequired — (map)

          Contains information about where to publish the inventory results.

          • S3BucketDestinationrequired — (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.
            • Bucketrequired — (String)

              The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

            • Formatrequired — (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.

                • KeyIdrequired — (String)

                  Specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key to use for encrypting inventory reports.

        • IsEnabledrequired — (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.

          • Prefixrequired — (String)

            The prefix that an object must have to be included in the inventory results.

        • Idrequired — (String)

          The ID used to identify the inventory configuration.

        • IncludedObjectVersionsrequired — (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.

        • Schedulerequired — (map)

          Specifies the schedule for generating inventory results.

          • Frequencyrequired — (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

Note: This operation is not supported by directory buckets.

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

        • Idrequired — (String)

          The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

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

            • Keyrequired — (String)

              Name of the object key.

            • Valuerequired — (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.

              • Keyrequired — (String)

                Name of the object key.

              • Valuerequired — (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

Note: This operation is not supported by directory buckets.

Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the s3:ListAllMyBuckets permission.

For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets.

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

Service Reference:

Examples:

To list all buckets


/* The following example returns all the buckets owned by the sender of this request. */

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

        • 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. This value 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)

          Note: This functionality is not supported for directory buckets.
        • ID — (String)

          Container for the ID of the owner.

Returns:

  • (AWS.Request)

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

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

Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

Note: Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

You must have the s3express:ListAllMyDirectoryBuckets permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

Service Reference:

Examples:

Calling the listDirectoryBuckets operation

var params = {
  ContinuationToken: 'STRING_VALUE',
  MaxDirectoryBuckets: 'NUMBER_VALUE'
};
s3.listDirectoryBuckets(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: {})
    • ContinuationToken — (String)

      ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

    • MaxDirectoryBuckets — (Integer)

      Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.

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

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

      • ContinuationToken — (String)

        If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response.

Returns:

  • (AWS.Request)

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

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

This operation lists in-progress multipart uploads in a bucket. An in-progress multipart upload is a multipart upload that has been initiated by the CreateMultipartUpload request, but has not yet been completed or aborted.

Note: Directory buckets - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed.

The ListMultipartUploads operation returns a maximum of 1,000 multipart uploads in the response. The limit of 1,000 multipart uploads is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads request parameter. If there are more than 1,000 multipart uploads that satisfy your ListMultipartUploads request, the response returns an IsTruncated element with the value of true, a NextKeyMarker element, and a NextUploadIdMarker element. To list the remaining multipart uploads, you need to make subsequent ListMultipartUploads requests. In these requests, include two query parameters: key-marker and upload-id-marker. Set the value of key-marker to the NextKeyMarker value from the previous response. Similarly, set the value of upload-id-marker to the NextUploadIdMarker value from the previous response.

Note: Directory buckets - The upload-id-marker element and the NextUploadIdMarker element aren't supported by directory buckets. To list the additional multipart uploads, you only need to set the value of key-marker to the NextKeyMarker value from the previous response.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

Note: Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions
  • General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Sorting of multipart uploads in response
  • General purpose bucket - In the ListMultipartUploads response, the multipart uploads are sorted based on two criteria:

    • Key-based sorting - Multipart uploads are initially sorted in ascending order based on their object keys.

    • Time-based sorting - For uploads that share the same object key, they are further sorted in ascending order based on the upload initiation time. Among uploads with the same key, the one that was initiated first will appear before the ones that were initiated later.

  • Directory bucket - In the ListMultipartUploads response, the multipart uploads aren't sorted lexicographically based on the object keys.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

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',
  RequestPayer: requester,
  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.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is 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.

      Note: Directory buckets - For directory buckets, / is the only supported delimiter.
    • EncodingType — (String)

      Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the 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 multipart upload after which listing should begin.

      Note:
      • General purpose buckets - For general purpose buckets, key-marker is an object key. 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.
      • Directory buckets - For directory buckets, key-marker is obfuscated and isn't a real object key. The upload-id-marker parameter isn't supported by directory buckets. To list the additional multipart uploads, you only need to set the value of key-marker to the NextKeyMarker value from the previous response. In the ListMultipartUploads response, the multipart uploads aren't sorted lexicographically based on the object keys.
    • 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 that you'd use a folder in a file system.)

      Note: Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
    • 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.

      Note: This functionality is not supported for directory buckets.
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      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:

      • 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)

        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.

        Note: This functionality is not supported for directory buckets.
      • 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.

        Note: Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
      • 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.

        Note: Directory buckets - For directory buckets, / is the only supported delimiter.
      • 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.

        Note: This functionality is not supported for directory buckets.
      • 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.

          Note: Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
          Possible values include:
          • "STANDARD"
          • "REDUCED_REDUNDANCY"
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "INTELLIGENT_TIERING"
          • "GLACIER"
          • "DEEP_ARCHIVE"
          • "OUTPOSTS"
          • "GLACIER_IR"
          • "SNOW"
          • "EXPRESS_ONEZONE"
        • Owner — (map)

          Specifies the owner of the object that is part of the multipart upload.

          Note: Directory buckets - The bucket owner is returned as the object owner for all the objects.
          • DisplayName — (String)

            Container for the display name of the owner. This value 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)

            Note: This functionality is not supported for directory buckets.
          • 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.

            Note: Directory buckets - If the principal is an Amazon Web Services account, it provides the Amazon Web Services account ID. If the principal is an IAM User, it provides a user ARN value.
          • DisplayName — (String)

            Name of the Principal.

            Note: This functionality is not supported for directory buckets.
        • ChecksumAlgorithm — (String)

          The algorithm that was used to create a checksum of the object.

          Possible values include:
          • "CRC32"
          • "CRC32C"
          • "SHA1"
          • "SHA256"
      • 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.

        Note: Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
        • 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 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, KeyMarker, Prefix, NextKeyMarker, Key.

        Possible values include:
        • "url"
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "requester"

Returns:

  • (AWS.Request)

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

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

Note: This operation is not supported by directory buckets.

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',
  OptionalObjectAttributes: [
    RestoreStatus,
    /* more items */
  ],
  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.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

    • Delimiter — (String)

      A delimiter is a character that 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 can contain any Unicode character; however, the 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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • OptionalObjectAttributes — (Array<String>)

      Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

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 the response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as the marker parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.

        Note: This element is returned only if you have the delimiter request parameter specified. If the response does not include the NextMarker element and it is truncated, you can use the value of the last Key element in the response as the marker parameter 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. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.

          Note: Directory buckets - MD5 is not supported by directory buckets.
        • ChecksumAlgorithm — (Array<String>)

          The algorithm that was used to create a checksum of the object.

        • Size — (Integer)

          Size in bytes of the object

        • StorageClass — (String)

          The class of storage used to store the object.

          Note: Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
          Possible values include:
          • "STANDARD"
          • "REDUCED_REDUNDANCY"
          • "GLACIER"
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "INTELLIGENT_TIERING"
          • "DEEP_ARCHIVE"
          • "OUTPOSTS"
          • "GLACIER_IR"
          • "SNOW"
          • "EXPRESS_ONEZONE"
        • Owner — (map)

          The owner of the object

          Note: Directory buckets - The bucket owner is returned as the object owner.
          • DisplayName — (String)

            Container for the display name of the owner. This value 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)

            Note: This functionality is not supported for directory buckets.
          • ID — (String)

            Container for the ID of the owner.

        • RestoreStatus — (map)

          Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

          Note: This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
          • IsRestoreInProgress — (Boolean)

            Specifies whether the object is currently being restored. If the object restoration is in progress, the header returns the value TRUE. For example:

            x-amz-optional-object-attributes: IsRestoreInProgress="true"

            If the object restoration has completed, the header returns the value FALSE. For example:

            x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

            If the object hasn't been restored, there is no header response.

          • RestoreExpiryDate — (Date)

            Indicates when the restored copy will expire. This value is populated only if the object has already been restored. For example:

            x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

      • 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. If using url, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png.

        Possible values include:
        • "url"
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "requester"

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. For more information about listing objects, see Listing object keys programmatically in the Amazon S3 User Guide. To get a list of your buckets, see ListBuckets.

Note: Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions
  • General purpose bucket permissions - To use this operation, you must have READ access to the bucket. You must have permission 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 in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Sorting order of returned objects
  • General purpose bucket - For general purpose buckets, ListObjectsV2 returns objects in lexicographical order based on their key names.

  • Directory bucket - For directory buckets, ListObjectsV2 does not return objects in lexicographical order.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, ListObjects.

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: "DOC-EXAMPLE-BUCKET", 
  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: "DOC-EXAMPLE-BUCKET", 
    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',
  OptionalObjectAttributes: [
    RestoreStatus,
    /* more items */
  ],
  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)

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

    • Delimiter — (String)

      A delimiter is a character that you use to group keys.

      Note:
      • Directory buckets - For directory buckets, / is the only supported delimiter.
      • Directory buckets - When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the CommonPrefixes response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
    • EncodingType — (String)

      Encoding type used by Amazon S3 to encode object keys in the response. If using url, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png.

      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.

      Note: Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
    • ContinuationToken — (String)

      ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

    • FetchOwner — (Boolean)

      The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

      Note: Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.
    • 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.

      Note: This functionality is not supported for directory buckets.
    • 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.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • OptionalObjectAttributes — (Array<String>)

      Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

      Note: This functionality is not supported for directory buckets.

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. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.

          Note: Directory buckets - MD5 is not supported by directory buckets.
        • ChecksumAlgorithm — (Array<String>)

          The algorithm that was used to create a checksum of the object.

        • Size — (Integer)

          Size in bytes of the object

        • StorageClass — (String)

          The class of storage used to store the object.

          Note: Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
          Possible values include:
          • "STANDARD"
          • "REDUCED_REDUNDANCY"
          • "GLACIER"
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "INTELLIGENT_TIERING"
          • "DEEP_ARCHIVE"
          • "OUTPOSTS"
          • "GLACIER_IR"
          • "SNOW"
          • "EXPRESS_ONEZONE"
        • Owner — (map)

          The owner of the object

          Note: Directory buckets - The bucket owner is returned as the object owner.
          • DisplayName — (String)

            Container for the display name of the owner. This value 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)

            Note: This functionality is not supported for directory buckets.
          • ID — (String)

            Container for the ID of the owner.

        • RestoreStatus — (map)

          Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

          Note: This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
          • IsRestoreInProgress — (Boolean)

            Specifies whether the object is currently being restored. If the object restoration is in progress, the header returns the value TRUE. For example:

            x-amz-optional-object-attributes: IsRestoreInProgress="true"

            If the object restoration has completed, the header returns the value FALSE. For example:

            x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

            If the object hasn't been restored, there is no header response.

          • RestoreExpiryDate — (Date)

            Indicates when the restored copy will expire. This value is populated only if the object has already been restored. For example:

            x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

      • Name — (String)

        The bucket name.

      • Prefix — (String)

        Keys that begin with the indicated prefix.

        Note: Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
      • 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.

        Note: Directory buckets - For directory buckets, / is the only supported delimiter.
      • 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) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.

        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.

        Note:
        • Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
        • Directory buckets - When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the CommonPrefixes response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
        • 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 equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.

      • ContinuationToken — (String)

        If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response. You can use this ContinuationToken for pagination of the list results.

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

        Note: This functionality is not supported for directory buckets.
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "requester"

Returns:

  • (AWS.Request)

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

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

Note: This operation is not supported by directory buckets.

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

The following operations are related to ListObjectVersions:

Service Reference:

Examples:

To list object versions


/* The following example returns versions of an object with specific key name prefix. */

 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',
  OptionalObjectAttributes: [
    RestoreStatus,
    /* more items */
  ],
  Prefix: 'STRING_VALUE',
  RequestPayer: requester,
  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 can contain any Unicode character; however, the 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 that 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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "requester"
    • OptionalObjectAttributes — (Array<String>)

      Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

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

        • ChecksumAlgorithm — (Array<String>)

          The algorithm that was used to create a checksum 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 when the object was last modified.

        • Owner — (map)

          Specifies the owner of the object.

          • DisplayName — (String)

            Container for the display name of the owner. This value 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)

            Note: This functionality is not supported for directory buckets.
          • ID — (String)

            Container for the ID of the owner.

        • RestoreStatus — (map)

          Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

          • IsRestoreInProgress — (Boolean)

            Specifies whether the object is currently being restored. If the object restoration is in progress, the header returns the value TRUE. For example:

            x-amz-optional-object-attributes: IsRestoreInProgress="true"

            If the object restoration has completed, the header returns the value FALSE. For example:

            x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

            If the object hasn't been restored, there is no header response.

          • RestoreExpiryDate — (Date)

            Indicates when the restored copy will expire. This value is populated only if the object has already been restored. For example:

            x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

      • 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. This value 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)

            Note: This functionality is not supported for directory buckets.
          • 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 when 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 the 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"
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "requester"

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.

To use this operation, you must provide the upload ID in the request. You obtain this uploadID by sending the initiate multipart upload request through CreateMultipartUpload.

The ListParts request returns a maximum of 1,000 uploaded parts. The limit of 1,000 parts is also the default value. You can restrict the number of parts in a response 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. To list remaining uploaded parts, in subsequent ListParts requests, 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 in the Amazon S3 User Guide.

Note: Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions
  • General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

    If the upload was created using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), you must have permission to the kms:Decrypt action for the ListParts request to succeed.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

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,
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SSECustomerKeyMD5: 'STRING_VALUE'
};
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.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

      Access points - When you use this action with 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 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.

      Note: Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
      Possible values include:
      • "requester"
    • ExpectedBucketOwner — (String)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • SSECustomerAlgorithm — (String)

      The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
    • SSECustomerKey — (Buffer, Typed Array, Blob, String)

      The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.
    • SSECustomerKeyMD5 — (String)

      The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

      Note: This functionality is not supported for directory buckets.

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

        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.

        Note: This functionality is not supported for directory buckets.
      • 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.

        Note: This functionality is not supported for directory buckets.
      • 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)

        Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

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

        • ChecksumCRC32 — (String)

          This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

        • ChecksumCRC32C — (String)

          The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

        • ChecksumSHA1 — (String)

          The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

        • ChecksumSHA256 — (String)

          This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

          Note: Directory buckets - If the principal is an Amazon Web Services account, it provides the Amazon Web Services account ID. If the principal is an IAM User, it provides a user ARN value.
        • DisplayName — (String)

          Name of the Principal.

          Note: This functionality is not supported for directory buckets.
      • 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.

        Note: Directory buckets - The bucket owner is returned as the object owner for all the parts.
        • DisplayName — (String)

          Container for the display name of the owner. This value 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)

          Note: This functionality is not supported for directory buckets.
        • ID — (String)

          Container for the ID of the owner.

      • StorageClass — (String)

        The class of storage used to store the uploaded object.

        Note: Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
        Possible values include:
        • "STANDARD"
        • "REDUCED_REDUNDANCY"
        • "STANDARD_IA"
        • "ONEZONE_IA"
        • "INTELLIGENT_TIERING"
        • "GLACIER"
        • "DEEP_ARCHIVE"
        • "OUTPOSTS"
        • "GLACIER_IR"
        • "SNOW"
        • "EXPRESS_ONEZONE"
      • RequestCharged — (String)

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

        Note: This functionality is not supported for directory buckets.
        Possible values include:
        • "requester"
      • ChecksumAlgorithm — (String)

        The algorithm that was used to create a checksum of the object.

        Possible values include:
        • "CRC32"
        • "CRC32C"
        • "SHA1"
        • "SHA256"

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

Note: This operation is not supported by directory buckets.

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:

Examples:

Calling the putBucketAccelerateConfiguration operation

var params = {
  AccelerateConfiguration: { /* required */
    Status: Enabled | Suspended
  },
  Bucket: 'STRING_VALUE', /* required */
  ChecksumAlgorithm: CRC32 | CRC32C | SHA1 | SHA256,
  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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

    • ChecksumAlgorithm — (String)

      Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

      If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

      Possible values include:
      • "CRC32"
      • "CRC32C"
      • "SHA1"
      • "SHA256"

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

Note: This operation is not supported by directory buckets.

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

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.

Permissions

You can set access permissions by 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: