Class: AWS.S3

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

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.

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

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  UploadId: 'STRING_VALUE', /* required */
  IfNoneMatch: 'STRING_VALUE',
  MultipartUpload: {
    Parts: [
      {
        ETag: 'STRING_VALUE',
        PartNumber: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  },
  RetentionExpirationDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  RetentionLegalHoldId: 'STRING_VALUE',
  RetentionPeriod: 'NUMBER_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.

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

    Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed error.

    If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should re-initiate the multipart upload with CreateMultipartUpload and re-upload each part.

    Expects the '*' (asterisk) character.

    For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

  • RetentionExpirationDate — (Date) Date on which it will be legal to delete or modify the object. You can only specify this or the Retention-Period header. If both are specified a 400 error will be returned. If neither is specified the bucket's DefaultRetention period will be used. This header should be used to calculate a retention period in seconds and then stored in that manner.
  • RetentionLegalHoldId — (String) A single legal hold to apply to the object. A legal hold is a character long string of max length 64. The object cannot be overwritten or deleted until all legal holds associated with the object are removed.
  • RetentionPeriod — (Integer) Retention period to store on the object in seconds. If this field and Retention-Expiration-Date are specified a 400 error is returned. If neither is specified the bucket's DefaultRetention period will be used. 0 is a legal value assuming the bucket's minimum retention period is also 0.
  • UploadId — (String)

    ID for the initiated multipart upload.

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.

    • ServerSideEncryption — (String)

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

      Possible values include:
      • "AES256"
      • "aws:kms"
    • 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 KMS key that was used for object encryption.

Returns:

• (AWS.Request) —

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

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

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,
  CacheControl: 'STRING_VALUE',
  ContentDisposition: 'STRING_VALUE',
  ContentEncoding: 'STRING_VALUE',
  ContentLanguage: 'STRING_VALUE',
  ContentType: 'STRING_VALUE',
  CopySourceIfMatch: 'STRING_VALUE',
  CopySourceIfModifiedSince: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CopySourceIfNoneMatch: 'STRING_VALUE',
  CopySourceIfUnmodifiedSince: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CopySourceSSECustomerAlgorithm: 'STRING_VALUE',
  CopySourceSSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  CopySourceSSECustomerKeyMD5: 'STRING_VALUE',
  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,
  RetentionDirective: COPY | REPLACE,
  RetentionExpirationDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  RetentionLegalHoldId: 'STRING_VALUE',
  RetentionPeriod: 'NUMBER_VALUE',
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SSECustomerKeyMD5: 'STRING_VALUE',
  SSEKMSKeyId: 'STRING_VALUE',
  ServerSideEncryption: AES256 | aws:kms,
  StorageClass: ACCELERATED | STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE,
  Tagging: 'STRING_VALUE',
  TaggingDirective: COPY | REPLACE,
  VersionId: 'STRING_VALUE',
  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.

  • 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"
  • RetentionDirective — (String) This header controls how the Protection state of the source object is copied to the destination object.If copied, the retention period and all legal holds are copied onto the new object. The legal hold date's is set to the date of the copy. Possible values include:
    • "COPY"
    • "REPLACE"
  • RetentionExpirationDate — (Date) Date on which it will be legal to delete or modify the object. You can only specify this or the Retention-Period header. If both are specified a 400 error will be returned. If neither is specified the bucket's DefaultRetention period will be used. This header should be used to calculate a retention period in seconds and then stored in that manner.
  • RetentionLegalHoldId — (String) A single legal hold to apply to the object. A legal hold is a Y character long string. The object cannot be overwritten or deleted until all legal holds associated with the object are removed.
  • RetentionPeriod — (Integer) Retention period to store on the object in seconds. If this field and Retention-Expiration-Date are specified a 400 error is returned. If neither is specified the bucket's DefaultRetention period will be used. 0 is a legal value assuming the bucket's minimum retention period is also 0.
  • ServerSideEncryption — (String)

    The server-side encryption algorithm used when storing this object in Amazon S3. 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 different default encryption configuration, Amazon S3 uses the corresponding encryption key to encrypt the target object copy.

    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.

    General purpose buckets

    • For general purpose buckets, there are the following supported options for server-side encryption: server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), and 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.

    Directory buckets

    • For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

    • To encrypt new object copies to a directory bucket with SSE-KMS, we recommend you specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a customer managed key). The Amazon Web Services managed key (aws/s3) isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. After you specify a customer managed key for SSE-KMS, you can't override the customer managed key for the bucket's SSE-KMS configuration. Then, when you perform a CopyObject operation and want to specify server-side encryption settings for new object copies with SSE-KMS in the encryption-related request headers, you must ensure the encryption key is the same customer managed key that you specified for the directory bucket's default encryption configuration.

    Possible values include:
    • "AES256"
    • "aws:kms"
  • 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:
    • "ACCELERATED"
    • "STANDARD"
    • "REDUCED_REDUNDANCY"
    • "STANDARD_IA"
    • "ONEZONE_IA"
    • "INTELLIGENT_TIERING"
    • "GLACIER"
    • "DEEP_ARCHIVE"
  • VersionId — (String) VersionId used to reference a specific version of the object.
  • 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 key 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.

    Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. If you want to specify the x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn't supported.

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • CopyObjectResult — (map)

      Container for all response elements.

      • ETag — (String)

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

      • LastModified — (Date)

        Creation date of the object.

    • Expiration — (String)

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

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

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

      If server-side encryption with a customer-provided encryption key was requested, the response will include this header 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 KMS key that was used for object encryption.

Returns:

• (AWS.Request) —

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

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

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

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ACL: private | public-read | public-read-write | authenticated-read,
  CreateBucketConfiguration: {
    LocationConstraint: au-syd-onerate_active | ca-tor-onerate_active | br-sao-onerate_active | jp-osa-onerate_active | jp-tok-onerate_active | us-standard | us-vault | us-cold | us-flex | us-east-standard | us-east-vault | us-east-cold | us-east-flex | us-east-onerate_active | us-south-standard | us-south-vault | us-south-cold | us-south-flex | us-south-onerate_active | eu-standard | eu-vault | eu-cold | eu-flex | eu-gb-standard | eu-gb-vault | eu-gb-cold | eu-gb-flex | eu-gb-onerate_active | eu-de-standard | eu-de-vault | eu-de-cold | eu-de-flex | eu-de-onerate_active | ap-standard | ap-vault | ap-cold | ap-flex | ams03-standard | ams03-vault | ams03-cold | ams03-flex | ams03-onerate_active | che01-standard | che01-vault | che01-cold | che01-flex | che01-onerate_active | mel01-standard | mel01-vault | mel01-cold | mel01-flex | mil01-onerate_active | mon01-onerate_active | osl01-standard | osl01-vault | osl01-cold | osl01-flex | par01-onerate_active | sao01-standard | sao01-vault | sao01-cold | sao01-flex | sjc04-onerate_active | sng01-onerate_active | tor01-standard | tor01-vault | tor01-cold | tor01-flex
  },
  GrantFullControl: 'STRING_VALUE',
  GrantRead: 'STRING_VALUE',
  GrantReadACP: 'STRING_VALUE',
  GrantWrite: 'STRING_VALUE',
  GrantWriteACP: 'STRING_VALUE',
  IBMSSEKPCustomerRootKeyCrn: 'STRING_VALUE',
  IBMSSEKPEncryptionAlgorithm: 'STRING_VALUE',
  IBMServiceInstanceId: 'STRING_VALUE',
  ObjectLockEnabledForBucket: true || false
};
s3.createBucket(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The canned ACL to apply to the bucket.

    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:
      • "au-syd-onerate_active"
      • "ca-tor-onerate_active"
      • "br-sao-onerate_active"
      • "jp-osa-onerate_active"
      • "jp-tok-onerate_active"
      • "us-standard"
      • "us-vault"
      • "us-cold"
      • "us-flex"
      • "us-east-standard"
      • "us-east-vault"
      • "us-east-cold"
      • "us-east-flex"
      • "us-east-onerate_active"
      • "us-south-standard"
      • "us-south-vault"
      • "us-south-cold"
      • "us-south-flex"
      • "us-south-onerate_active"
      • "eu-standard"
      • "eu-vault"
      • "eu-cold"
      • "eu-flex"
      • "eu-gb-standard"
      • "eu-gb-vault"
      • "eu-gb-cold"
      • "eu-gb-flex"
      • "eu-gb-onerate_active"
      • "eu-de-standard"
      • "eu-de-vault"
      • "eu-de-cold"
      • "eu-de-flex"
      • "eu-de-onerate_active"
      • "ap-standard"
      • "ap-vault"
      • "ap-cold"
      • "ap-flex"
      • "ams03-standard"
      • "ams03-vault"
      • "ams03-cold"
      • "ams03-flex"
      • "ams03-onerate_active"
      • "che01-standard"
      • "che01-vault"
      • "che01-cold"
      • "che01-flex"
      • "che01-onerate_active"
      • "mel01-standard"
      • "mel01-vault"
      • "mel01-cold"
      • "mel01-flex"
      • "mil01-onerate_active"
      • "mon01-onerate_active"
      • "osl01-standard"
      • "osl01-vault"
      • "osl01-cold"
      • "osl01-flex"
      • "par01-onerate_active"
      • "sao01-standard"
      • "sao01-vault"
      • "sao01-cold"
      • "sao01-flex"
      • "sjc04-onerate_active"
      • "sng01-onerate_active"
      • "tor01-standard"
      • "tor01-vault"
      • "tor01-cold"
      • "tor01-flex"
  • 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.
  • IBMServiceInstanceId — (String) The storage account who will be the owner of the bucket.
  • IBMSSEKPEncryptionAlgorithm — (String)
  • IBMSSEKPCustomerRootKeyCrn — (String)

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.

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

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,
  CacheControl: 'STRING_VALUE',
  ContentDisposition: 'STRING_VALUE',
  ContentEncoding: 'STRING_VALUE',
  ContentLanguage: 'STRING_VALUE',
  ContentType: '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,
  SSECustomerAlgorithm: 'STRING_VALUE',
  SSECustomerKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SSECustomerKeyMD5: 'STRING_VALUE',
  SSEKMSKeyId: 'STRING_VALUE',
  ServerSideEncryption: AES256 | aws:kms,
  StorageClass: ACCELERATED | STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE,
  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).

    • Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

      In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. You can't override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.

      Note: When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the encryption request headers must match the default encryption configuration of the directory bucket.
    Possible values include:
    • "AES256"
    • "aws:kms"
  • StorageClass — (String)

    By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. 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:
    • "ACCELERATED"
    • "STANDARD"
    • "REDUCED_REDUNDANCY"
    • "STANDARD_IA"
    • "ONEZONE_IA"
    • "INTELLIGENT_TIERING"
    • "GLACIER"
    • "DEEP_ARCHIVE"
  • 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 KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.

    General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3) to protect the data.

    Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. If you want to specify the x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn't supported.

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

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

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

      If server-side encryption with a customer-provided encryption key was requested, the response will include this header 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 KMS key that was used for object encryption.

Returns:

• (AWS.Request) —

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

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);
  }
});

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:

• http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-HTTPPOSTConstructPolicy.html

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

var params = {
  Bucket: 'STRING_VALUE' /* required */
};
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

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.

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

var params = {
  Bucket: 'STRING_VALUE' /* required */
};
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.

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.

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

var params = {
  Bucket: 'STRING_VALUE' /* required */
};
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.

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.

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

var params = {
  Bucket: 'STRING_VALUE' /* required */
};
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.

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.

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

var params = {
  Bucket: 'STRING_VALUE' /* required */
};
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.

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.

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

var params = {
  Bucket: 'STRING_VALUE' /* required */
};
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.

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.

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

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.

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

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

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  BypassGovernanceRetention: true || false,
  MFA: 'STRING_VALUE',
  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.
  • 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.

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.

Returns:

• (AWS.Request) —

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

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

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

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,
  MFA: 'STRING_VALUE'
};
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.

    • Objects — required — (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.
      • Key — required — (String)

        Key name of the object.

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

      • VersionId — (String)

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

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

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

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

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

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.

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.

var params = {
  Bucket: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE', /* required */
  AdditionalRetentionPeriod: 'NUMBER_VALUE',
  ExtendRetentionFromCurrentTime: 'NUMBER_VALUE',
  NewRetentionExpirationDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  NewRetentionPeriod: 'NUMBER_VALUE'
};
s3.extendObjectRetention(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)
  • Key — (String)
  • AdditionalRetentionPeriod — (Integer)
  • ExtendRetentionFromCurrentTime — (Integer) Retention Period in seconds for the object. The Retention will be enforced from the current time until current time + the value in this header. This header will only be supported for objects that are currently stored with an indefinite retention period (-1). This value has to be within the ranges defined for the bucket.
  • NewRetentionExpirationDate — (Date)
  • NewRetentionPeriod — (Integer) Retention period, in seconds, to use for the object in place of the existing retention period stored for the object. If this value is less than the existing value stored for the object, a 400 error will be returned. If this field and Additional-Retention-Period and/or New-Retention-Expiration-Date are specified, a 400 error will be returned. If none of the Request Headers are specified, a 400 error will be 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.

Returns:

• (AWS.Request) —

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

var params = {
  Bucket: 'STRING_VALUE' /* required */
};
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.

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.

        • Type — required — (String)

          Type of grantee

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

          URI of the grantee group.

      • Permission — (String)

        Specifies the permission given to the grantee.

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

Returns:

• (AWS.Request) —

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

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

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

  • MirrorDestination — (String) Mirror source for object reads.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • CORSRules — (Array<map>)

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

      • ID — (String)

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

      • AllowedHeaders — (Array<String>)

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

      • AllowedMethods — required — (Array<String>)

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

      • AllowedOrigins — required — (Array<String>)

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

      • ExposeHeaders — (Array<String>)

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

      • MaxAgeSeconds — (Integer)

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

Returns:

• (AWS.Request) —

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

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

var params = {
  Bucket: 'STRING_VALUE' /* required */
};
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.

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.

      • Prefix — required — (String)

        Object key prefix that identifies one or more objects to which this rule applies.

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

      • Status — required — (String)

        If Enabled, the rule is currently being applied. If Disabled, the rule is not currently being applied.

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

        Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

        • Date — (Date)

          Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

        • Days — (Integer)

          Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

        • StorageClass — (String)

          The storage class to which you want the object to transition.

          Possible values include:
          • "ACCELERATED"
          • "GLACIER"
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "INTELLIGENT_TIERING"
          • "DEEP_ARCHIVE"
      • NoncurrentVersionExpiration — (map)

        Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

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

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

var params = {
  Bucket: 'STRING_VALUE' /* required */
};
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.

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 — required — (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.

          • Key — required — (String)

            Name of the object key.

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

            • Key — required — (String)

              Name of the object key.

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

      • Status — required — (String)

        If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

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

        Specifies when an Amazon S3 object transitions to a specified storage class.

        • Date — (Date)

          Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

        • Days — (Integer)

          Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

        • StorageClass — (String)

          The storage class to which you want the object to transition.

          Possible values include:
          • "ACCELERATED"
          • "GLACIER"
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "INTELLIGENT_TIERING"
          • "DEEP_ARCHIVE"
      • NoncurrentVersionExpiration — (map)

        Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

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

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

var params = {
  Bucket: 'STRING_VALUE' /* required */
};
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.

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:
      • "au-syd-onerate_active"
      • "ca-tor-onerate_active"
      • "br-sao-onerate_active"
      • "jp-osa-onerate_active"
      • "jp-tok-onerate_active"
      • "us-standard"
      • "us-vault"
      • "us-cold"
      • "us-flex"
      • "us-east-standard"
      • "us-east-vault"
      • "us-east-cold"
      • "us-east-flex"
      • "us-east-onerate_active"
      • "us-south-standard"
      • "us-south-vault"
      • "us-south-cold"
      • "us-south-flex"
      • "us-south-onerate_active"
      • "eu-standard"
      • "eu-vault"
      • "eu-cold"
      • "eu-flex"
      • "eu-gb-standard"
      • "eu-gb-vault"
      • "eu-gb-cold"
      • "eu-gb-flex"
      • "eu-gb-onerate_active"
      • "eu-de-standard"
      • "eu-de-vault"
      • "eu-de-cold"
      • "eu-de-flex"
      • "eu-de-onerate_active"
      • "ap-standard"
      • "ap-vault"
      • "ap-cold"
      • "ap-flex"
      • "ams03-standard"
      • "ams03-vault"
      • "ams03-cold"
      • "ams03-flex"
      • "ams03-onerate_active"
      • "che01-standard"
      • "che01-vault"
      • "che01-cold"
      • "che01-flex"
      • "che01-onerate_active"
      • "mel01-standard"
      • "mel01-vault"
      • "mel01-cold"
      • "mel01-flex"
      • "mil01-onerate_active"
      • "mon01-onerate_active"
      • "osl01-standard"
      • "osl01-vault"
      • "osl01-cold"
      • "osl01-flex"
      • "par01-onerate_active"
      • "sao01-standard"
      • "sao01-vault"
      • "sao01-cold"
      • "sao01-flex"
      • "sjc04-onerate_active"
      • "sng01-onerate_active"
      • "tor01-standard"
      • "tor01-vault"
      • "tor01-cold"
      • "tor01-flex"

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The bucket whose Object Lock configuration you want to retrieve.

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