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

Inherits:

Resources::Collection

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

Extended by:

Deprecations

Defined in:

lib/aws-sdk-s3/customizations/object.rb,
lib/aws-sdk-s3/object.rb

Batch Actions

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

Instance Method Summary

• #delete ⇒ Object

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.

  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 markdown=“1”> This functionality is not supported for directory buckets.

  </note>
  

  [1]: docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete

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

  <note markdown=“1”> This functionality is not supported for directory buckets.

  </note>
  

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

  <note markdown=“1”> This functionality is not supported for directory buckets.

  </note>
  

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

• :checksum_algorithm (String) —

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

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

  • ‘CRC32`

  • ‘CRC32C`

  • ‘SHA1`

  • ‘SHA256`

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

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

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

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

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

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
    Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      batch[0].client.delete_objects(params)
    end
  end
  nil
end

#delete ⇒ Object

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

alias_method :delete, :batch_delete!