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
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

Returns:

  • (String) 


1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/aws-sdk-s3/types.rb', line 1979

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

#delete ⇒ Types::Delete

Returns:



1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/aws-sdk-s3/types.rb', line 1979

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :request_payer)
  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) 


1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/aws-sdk-s3/types.rb', line 1979

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :request_payer)
  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) 


1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/aws-sdk-s3/types.rb', line 1979

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