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
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 you use 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.
Directory buckets - When you use this operation with a directory
bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style
requests are not supported. Directory bucket names must be unique in
the chosen Availability Zone. Bucket names must follow the format
bucket_base_name--az-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 in the Amazon S3 User Guide.
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? in the Amazon S3 User Guide.
4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4445 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.
4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4445 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 you use the SDK. This header will not provide any additional
functionality if you don't use the SDK. When you send this header,
there must be a corresponding x-amz-checksum-algorithm
or
x-amz-trailer
header sent. Otherwise, Amazon S3 fails the request
with the HTTP status code 400 Bad Request
.
For the x-amz-checksum-algorithm
header, replace algorithm
with the supported algorithm from the following list:
CRC32
CRC32C
SHA1
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through
x-amz-checksum-algorithm
doesn't match the checksum algorithm
you set through x-amz-sdk-checksum-algorithm
, Amazon S3 ignores
any provided ChecksumAlgorithm
parameter and uses the checksum
algorithm that matches the provided value in
x-amz-checksum-algorithm
.
If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm
parameter.
4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4445 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.
4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4445 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 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).
4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4445 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.
When performing the DeleteObjects
operation on an MFA delete
enabled bucket, which attempts to delete the specified versioned
objects, you must include an MFA token. If you don't provide an MFA
token, the entire request will fail, even if there are non-versioned
objects that you are trying to delete. If you provide an invalid
token, whether there are versioned object keys in the request or
not, the entire Multi-Object Delete request will fail. For
information about MFA Delete, see MFA Delete in the Amazon S3
User Guide.
4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4445 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. 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.
4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4445 class DeleteObjectsRequest < Struct.new( :bucket, :delete, :mfa, :request_payer, :bypass_governance_retention, :expected_bucket_owner, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |