Class: Aws::S3::Types::DeleteObjectsRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::DeleteObjectsRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass DeleteObjectsRequest data as a hash:

{
  bucket: "BucketName", # required
  delete: { # required
    objects: [ # required
      {
        key: "ObjectKey", # required
        version_id: "ObjectVersionId",
      },
    ],
    quiet: false,
  },
  mfa: "MFA",
  request_payer: "requester", # accepts requester
  bypass_governance_retention: false,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #bucket ⇒ String
• #bypass_governance_retention ⇒ Boolean

  Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place.

• #delete ⇒ Types::Delete
• #mfa ⇒ String

  The concatenation of the authentication device’s serial number, a space, and the value that is displayed on your authentication device.

• #request_payer ⇒ String

  Confirms that the requester knows that she or he will be charged for the request.

Instance Attribute Details

#bucket ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 2123

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :request_payer,
  :bypass_governance_retention)
  include Aws::Structure
end

#bypass_governance_retention ⇒ Boolean

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.

Returns:

• (Boolean)

# File 'lib/aws-sdk-s3/types.rb', line 2123

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :request_payer,
  :bypass_governance_retention)
  include Aws::Structure
end

#delete ⇒ Types::Delete

Returns:

• (Types::Delete)

# File 'lib/aws-sdk-s3/types.rb', line 2123

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :request_payer,
  :bypass_governance_retention)
  include Aws::Structure
end

#mfa ⇒ String

The concatenation of the authentication device’s serial number, a space, and the value that is displayed on your authentication device.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 2123

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :request_payer,
  :bypass_governance_retention)
  include Aws::Structure
end

#request_payer ⇒ String

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 2123

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :request_payer,
  :bypass_governance_retention)
  include Aws::Structure
end