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

Class: Aws::S3::Types::DeleteObjectRequest

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 DeleteObjectRequest data as a hash:

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  mfa: "MFA",
  version_id: "ObjectVersionId",
  request_payer: "requester", # accepts requester
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Returns:

  • (String)


1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1730

class DeleteObjectRequest < Struct.new(
  :bucket,
  :key,
  :mfa,
  :version_id,
  :request_payer)
  include Aws::Structure
end

#keyString

Returns:

  • (String)


1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1730

class DeleteObjectRequest < Struct.new(
  :bucket,
  :key,
  :mfa,
  :version_id,
  :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)


1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1730

class DeleteObjectRequest < Struct.new(
  :bucket,
  :key,
  :mfa,
  :version_id,
  :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)


1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1730

class DeleteObjectRequest < Struct.new(
  :bucket,
  :key,
  :mfa,
  :version_id,
  :request_payer)
  include Aws::Structure
end

#version_idString

VersionId used to reference a specific version of the object.

Returns:

  • (String)


1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1730

class DeleteObjectRequest < Struct.new(
  :bucket,
  :key,
  :mfa,
  :version_id,
  :request_payer)
  include Aws::Structure
end