Class: Aws::S3::Object::Collection

Inherits:

Resources::Collection

• Object
• Resources::Collection
• Aws::S3::Object::Collection

Defined in:

lib/aws-sdk-s3/object.rb

Batch Actions

• #batch_delete!(options = {}) ⇒ void

Instance Method Details

#batch_delete!(options = {}) ⇒ void

This method returns an undefined value.

Examples:

Request syntax with placeholder values

object.batch_delete!({
  mfa: "MFA",
  request_payer: "requester", # accepts requester
  bypass_governance_retention: false,
  expected_bucket_owner: "AccountId",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
})

Parameters:

• options ({}) (defaults to: {})

Options Hash (options):

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

• :request_payer (String) —

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

  [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

• :bypass_governance_retention (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.

• :expected_bucket_owner (String) —

  The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

• :checksum_algorithm (String) —

  Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding ‘x-amz-checksum` or `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request with the HTTP status code `400 Bad Request`. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

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

  This checksum algorithm must be the same for all parts and it match the checksum value supplied in the ‘CreateMultipartUpload` request.

  [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

# File 'lib/aws-sdk-s3/object.rb', line 1851

def batch_delete!(options = {})
  batch_enum.each do |batch|
    params = Aws::Util.copy_hash(options)
    params[:bucket] = batch[0].bucket_name
    params[:delete] ||= {}
    params[:delete][:objects] ||= []
    batch.each do |item|
      params[:delete][:objects] << {
        key: item.key
      }
    end
    batch[0].client.delete_objects(params)
  end
  nil
end