Class: Aws::S3::Types::DeleteObjectsRequest

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 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][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

Returns:

  • (String) 


2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
 
# File 'lib/aws-sdk-s3/types.rb', line 2928

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.

Returns:

  • (Boolean) 


2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
 
# File 'lib/aws-sdk-s3/types.rb', line 2928

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.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

  • (String) 


2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
 
# File 'lib/aws-sdk-s3/types.rb', line 2928

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.

Returns:



2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
 
# File 'lib/aws-sdk-s3/types.rb', line 2928

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

Returns:

  • (String) 


2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
 
# File 'lib/aws-sdk-s3/types.rb', line 2928

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.

Returns:

  • (String) 


2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
 
# File 'lib/aws-sdk-s3/types.rb', line 2928

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

Returns:

  • (String) 


2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
 
# File 'lib/aws-sdk-s3/types.rb', line 2928

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :request_payer,
  :bypass_governance_retention,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = []
  include Aws::Structure
end