AWSS3DeleteObjectRequest

Objective-C

@interface AWSS3DeleteObjectRequest

Swift

class AWSS3DeleteObjectRequest

  • The bucket name of the bucket containing the object.

    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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable bucket;

    Swift

    var bucket: String? { get set }

  • Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable bypassGovernanceRetention;

    Swift

    var bypassGovernanceRetention: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable expectedBucketOwner;

    Swift

    var expectedBucketOwner: String? { get set }
  • key

    Key name of the object to delete.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable key;

    Swift

    var key: String? { get set }
  • MFA

    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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable MFA;

    Swift

    var mfa: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSS3RequestPayer requestPayer;

    Swift

    var requestPayer: AWSS3RequestPayer { get set }

  • VersionId used to reference a specific version of the object.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable versionId;

    Swift

    var versionId: String? { get set }