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

Note:

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",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #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 API 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 operation with an access point through the AWS 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 Simple Storage Service Developer Guide.

When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2943

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :request_payer,
  :bypass_governance_retention,
  :expected_bucket_owner)
  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. You must have sufficient permissions to perform this operation.

Returns:

• (Boolean)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2943

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

#delete ⇒ Types::Delete

Container for the request.

Returns:

• (Types::Delete)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2943

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :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 will fail with an HTTP 403 (Access Denied) error.

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2943

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :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.

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2943

class DeleteObjectsRequest < Struct.new(
  :bucket,
  :delete,
  :mfa,
  :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. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2943

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