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

Inherits:
Struct
  • Object
show all
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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Returns:

  • (String)


2123
2124
2125
2126
2127
2128
2129
2130
# 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_retentionBoolean

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)


2123
2124
2125
2126
2127
2128
2129
2130
# 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

#deleteTypes::Delete

Returns:



2123
2124
2125
2126
2127
2128
2129
2130
# 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

#mfaString

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

Returns:

  • (String)


2123
2124
2125
2126
2127
2128
2129
2130
# 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_payerString

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)


2123
2124
2125
2126
2127
2128
2129
2130
# 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