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
  bypass_governance_retention: false,
  expected_bucket_owner: "AccountId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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 with 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.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (String)


2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2747

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

#bypass_governance_retentionBoolean

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

Returns:

  • (Boolean)


2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2747

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

#expected_bucket_ownerString

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

  • (String)


2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2747

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

#keyString

Key name of the object to delete.

Returns:

  • (String)


2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2747

class DeleteObjectRequest < Struct.new(
  :bucket,
  :key,
  :mfa,
  :version_id,
  :request_payer,
  :bypass_governance_retention,
  :expected_bucket_owner)
  SENSITIVE = []
  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. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Returns:

  • (String)


2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2747

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

#request_payerString

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.

Returns:

  • (String)


2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2747

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

#version_idString

VersionId used to reference a specific version of the object.

Returns:

  • (String)


2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2747

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