You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/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
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Returns:

  • (String)


1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1976

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

#deleteTypes::Delete

Returns:



1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1976

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


1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1976

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :request_payer)
  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 http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

  • (String)


1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1976

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