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

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

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

Returns:

  • (String) 


2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/aws-sdk-s3/types.rb', line 2006

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

#bypass_governance_retention ⇒ Boolean

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.

Returns:

  • (Boolean) 


2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/aws-sdk-s3/types.rb', line 2006

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

#key ⇒ String

Returns:

  • (String) 


2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/aws-sdk-s3/types.rb', line 2006

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


2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/aws-sdk-s3/types.rb', line 2006

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


2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/aws-sdk-s3/types.rb', line 2006

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

#version_id ⇒ String

VersionId used to reference a specific version of the object.

Returns:

  • (String) 


2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/aws-sdk-s3/types.rb', line 2006

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