Class: Aws::S3::Types::DeleteObjectRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::DeleteObjectRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-s3/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#bucket ⇒ String
The bucket name of the bucket containing the object.
-
#bypass_governance_retention ⇒ Boolean
Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.
-
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner.
-
#key ⇒ String
Key name of the object to delete.
-
#mfa ⇒ String
The concatenation of the authentication device’s serial number, a space, and the value that is displayed on your authentication device.
-
#request_payer ⇒ String
Confirms that the requester knows that they will be charged for the request.
-
#version_id ⇒ String
VersionId used to reference a specific version of the object.
Instance Attribute Details
#bucket ⇒ String
The bucket name of the bucket containing the object.
When using this action 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 action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see
- Using access points][1
-
in the *Amazon S3 User Guide*.
When you use this action 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see
- What is S3 on Outposts?][2
-
in the *Amazon S3 User Guide*.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 |
# File 'lib/aws-sdk-s3/types.rb', line 2737 class DeleteObjectRequest < Struct.new( :bucket, :key, :mfa, :version_id, :request_payer, :bypass_governance_retention, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#bypass_governance_retention ⇒ Boolean
Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the ‘s3:BypassGovernanceRetention` permission.
2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 |
# File 'lib/aws-sdk-s3/types.rb', line 2737 class DeleteObjectRequest < Struct.new( :bucket, :key, :mfa, :version_id, :request_payer, :bypass_governance_retention, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code ‘403 Forbidden` (access denied).
2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 |
# File 'lib/aws-sdk-s3/types.rb', line 2737 class DeleteObjectRequest < Struct.new( :bucket, :key, :mfa, :version_id, :request_payer, :bypass_governance_retention, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#key ⇒ String
Key name of the object to delete.
2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 |
# File 'lib/aws-sdk-s3/types.rb', line 2737 class DeleteObjectRequest < Struct.new( :bucket, :key, :mfa, :version_id, :request_payer, :bypass_governance_retention, :expected_bucket_owner) SENSITIVE = [] 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.
2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 |
# File 'lib/aws-sdk-s3/types.rb', line 2737 class DeleteObjectRequest < Struct.new( :bucket, :key, :mfa, :version_id, :request_payer, :bypass_governance_retention, :expected_bucket_owner) SENSITIVE = [] 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. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 |
# File 'lib/aws-sdk-s3/types.rb', line 2737 class DeleteObjectRequest < Struct.new( :bucket, :key, :mfa, :version_id, :request_payer, :bypass_governance_retention, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#version_id ⇒ String
VersionId used to reference a specific version of the object.
2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 |
# File 'lib/aws-sdk-s3/types.rb', line 2737 class DeleteObjectRequest < Struct.new( :bucket, :key, :mfa, :version_id, :request_payer, :bypass_governance_retention, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |