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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The bucket name of the bucket containing the object.

**Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ‘ Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format ` bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

**Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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][2

in the *Amazon S3 User Guide*.

<note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

</note>

**S3 on Outposts** - 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?][3

in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

Returns:

  • (String) 


4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
 
# File 'lib/aws-sdk-s3/types.rb', line 4315

class DeleteObjectRequest < Struct.new(
  :bucket,
  :key,
  :mfa,
  :version_id,
  :request_payer,
  :bypass_governance_retention,
  :expected_bucket_owner,
  :if_match,
  :if_match_last_modified_time,
  :if_match_size)
  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.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

  • (Boolean) 


4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
 
# File 'lib/aws-sdk-s3/types.rb', line 4315

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

#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (String) 


4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
 
# File 'lib/aws-sdk-s3/types.rb', line 4315

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

#if_match ⇒ String

The ‘If-Match` header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns a `412 Precondition Failed` error. If the ETag matches or if the object doesn’t exist, the operation will return a ‘204 Success (No Content) response`.

For more information about conditional requests, see [RFC 7232].

<note markdown=“1”> This functionality is only supported for directory buckets.

</note>

[1]: docs.aws.amazon.com/https:/tools.ietf.org/html/rfc7232

Returns:

  • (String) 


4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
 
# File 'lib/aws-sdk-s3/types.rb', line 4315

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

#if_match_last_modified_time ⇒ Time

If present, the object is deleted only if its modification times matches the provided ‘Timestamp`. If the `Timestamp` values do not match, the operation returns a `412 Precondition Failed` error. If the `Timestamp` matches or if the object doesn’t exist, the operation returns a `204 Success (No Content)` response.

<note markdown=“1”> This functionality is only supported for directory buckets.

</note>

Returns:

  • (Time) 


4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
 
# File 'lib/aws-sdk-s3/types.rb', line 4315

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

#if_match_size ⇒ Integer

If present, the object is deleted only if its size matches the provided size in bytes. If the ‘Size` value does not match, the operation returns a `412 Precondition Failed` error. If the `Size` matches or if the object doesn’t exist, the operation returns a `204 Success (No Content)` response.

<note markdown=“1”> This functionality is only supported for directory buckets.

</note>

You can use the ‘If-Match`, `x-amz-if-match-last-modified-time` and `x-amz-if-match-size` conditional headers in conjunction with each-other or individually.

Returns:

  • (Integer) 


4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
 
# File 'lib/aws-sdk-s3/types.rb', line 4315

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

#key ⇒ String

Key name of the object to delete.

Returns:

  • (String) 


4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
 
# File 'lib/aws-sdk-s3/types.rb', line 4315

class DeleteObjectRequest < Struct.new(
  :bucket,
  :key,
  :mfa,
  :version_id,
  :request_payer,
  :bypass_governance_retention,
  :expected_bucket_owner,
  :if_match,
  :if_match_last_modified_time,
  :if_match_size)
  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.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

  • (String) 


4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
 
# File 'lib/aws-sdk-s3/types.rb', line 4315

class DeleteObjectRequest < Struct.new(
  :bucket,
  :key,
  :mfa,
  :version_id,
  :request_payer,
  :bypass_governance_retention,
  :expected_bucket_owner,
  :if_match,
  :if_match_last_modified_time,
  :if_match_size)
  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 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*.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

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

Returns:

  • (String) 


4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
 
# File 'lib/aws-sdk-s3/types.rb', line 4315

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

#version_id ⇒ String

Version ID used to reference a specific version of the object.

<note markdown=“1”> For directory buckets in this API operation, only the ‘null` value of the version ID is supported.

</note>

Returns:

  • (String) 


4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
 
# File 'lib/aws-sdk-s3/types.rb', line 4315

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