Class: Aws::S3::Types::DeleteObjectsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::DeleteObjectsRequest
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb
Overview
When making an API call, you may pass DeleteObjectsRequest data as a hash:
{
bucket: "BucketName", # required
delete: { # required
objects: [ # required
{
key: "ObjectKey", # required
version_id: "ObjectVersionId",
},
],
quiet: false,
},
mfa: "MFA",
request_payer: "requester", # accepts requester
bypass_governance_retention: false,
expected_bucket_owner: "AccountId",
checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#bucket ⇒ String
The bucket name containing the objects to delete.
-
#bypass_governance_retention ⇒ Boolean
Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place.
-
#checksum_algorithm ⇒ String
Indicates the algorithm used to create the checksum for the object when using the SDK.
-
#delete ⇒ Types::Delete
Container for the request.
-
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner.
-
#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.
Instance Attribute Details
#bucket ⇒ String
The bucket name containing the objects to delete.
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 in the Amazon S3 User Guide.
When using 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 using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts in the Amazon S3 User Guide.
3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3552 class DeleteObjectsRequest < Struct.new( :bucket, :delete, :mfa, :request_payer, :bypass_governance_retention, :expected_bucket_owner, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#bypass_governance_retention ⇒ Boolean
Specifies whether you want to delete this object even if it has a
Governance-type Object Lock in place. To use this header, you must
have the s3:BypassGovernanceRetention
permission.
3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3552 class DeleteObjectsRequest < Struct.new( :bucket, :delete, :mfa, :request_payer, :bypass_governance_retention, :expected_bucket_owner, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#checksum_algorithm ⇒ String
Indicates the algorithm used to create the checksum for the object
when using the SDK. This header will not provide any additional
functionality if not using the SDK. When sending this header, there
must be a corresponding x-amz-checksum
or x-amz-trailer
header
sent. Otherwise, Amazon S3 fails the request with the HTTP status
code 400 Bad Request
. For more information, see Checking object
integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm
parameter.
This checksum algorithm must be the same for all parts and it match
the checksum value supplied in the CreateMultipartUpload
request.
3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3552 class DeleteObjectsRequest < Struct.new( :bucket, :delete, :mfa, :request_payer, :bypass_governance_retention, :expected_bucket_owner, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#delete ⇒ Types::Delete
Container for the request.
3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3552 class DeleteObjectsRequest < Struct.new( :bucket, :delete, :mfa, :request_payer, :bypass_governance_retention, :expected_bucket_owner, :checksum_algorithm) 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).
3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3552 class DeleteObjectsRequest < Struct.new( :bucket, :delete, :mfa, :request_payer, :bypass_governance_retention, :expected_bucket_owner, :checksum_algorithm) 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.
3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3552 class DeleteObjectsRequest < Struct.new( :bucket, :delete, :mfa, :request_payer, :bypass_governance_retention, :expected_bucket_owner, :checksum_algorithm) 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. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3552 class DeleteObjectsRequest < Struct.new( :bucket, :delete, :mfa, :request_payer, :bypass_governance_retention, :expected_bucket_owner, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |