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

The bucket name of the bucket containing the object.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using Access Points] in the *Amazon Simple Storage Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html

Returns:

  • (String) 


2350
2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'lib/aws-sdk-s3/types.rb', line 2350

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) 


2350
2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'lib/aws-sdk-s3/types.rb', line 2350

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

#key ⇒ String

Key name of the object to delete.

Returns:

  • (String) 


2350
2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'lib/aws-sdk-s3/types.rb', line 2350

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. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Returns:

  • (String) 


2350
2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'lib/aws-sdk-s3/types.rb', line 2350

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 they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see [Downloading Objects in Requestor Pays Buckets] in the *Amazon S3 Developer Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

  • (String) 


2350
2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'lib/aws-sdk-s3/types.rb', line 2350

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) 


2350
2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'lib/aws-sdk-s3/types.rb', line 2350

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