AWSS3GetObjectLegalHoldRequest

Objective-C

@interface AWSS3GetObjectLegalHoldRequest

Swift

class AWSS3GetObjectLegalHoldRequest

  • The bucket name containing the object whose Legal Hold status you want to retrieve.

    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.

    Declaration

    Objective-C

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

    Swift

    var bucket: String? { 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

    The key name for the object whose Legal Hold status you want to retrieve.

    Declaration

    Objective-C

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

    Swift

    var key: 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 }

  • The version ID of the object whose Legal Hold status you want to retrieve.

    Declaration

    Objective-C

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

    Swift

    var versionId: String? { get set }