AWSS3GetObjectRequest

Objective-C

@interface AWSS3GetObjectRequest

Swift

class AWSS3GetObjectRequest

  • The bucket name 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 }

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

  • Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

    Declaration

    Objective-C

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

    Swift

    var ifMatch: String? { get set }

  • Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable ifModifiedSince;

    Swift

    var ifModifiedSince: Date? { get set }

  • Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

    Declaration

    Objective-C

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

    Swift

    var ifNoneMatch: String? { get set }

  • Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable ifUnmodifiedSince;

    Swift

    var ifUnmodifiedSince: Date? { get set }
  • key

    Key of the object to get.

    Declaration

    Objective-C

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

    Swift

    var key: String? { get set }

  • Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a ‘ranged’ GET request for the part specified. Useful for downloading just a part of an object.

    Declaration

    Objective-C

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

    Swift

    var partNumber: NSNumber? { get set }

  • Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    Amazon S3 doesn’t support retrieving multiple ranges of data per GET request.

    Declaration

    Objective-C

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

    Swift

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

  • Sets the Cache-Control header of the response.

    Declaration

    Objective-C

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

    Swift

    var responseCacheControl: String? { get set }

  • Sets the Content-Disposition header of the response

    Declaration

    Objective-C

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

    Swift

    var responseContentDisposition: String? { get set }

  • Sets the Content-Encoding header of the response.

    Declaration

    Objective-C

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

    Swift

    var responseContentEncoding: String? { get set }

  • Sets the Content-Language header of the response.

    Declaration

    Objective-C

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

    Swift

    var responseContentLanguage: String? { get set }

  • Sets the Content-Type header of the response.

    Declaration

    Objective-C

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

    Swift

    var responseContentType: String? { get set }

  • Sets the Expires header of the response.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable responseExpires;

    Swift

    var responseExpires: Date? { get set }

  • Specifies the algorithm to use to when encrypting the object (for example, AES256).

    Declaration

    Objective-C

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

    Swift

    var sseCustomerAlgorithm: String? { get set }

  • Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

    Declaration

    Objective-C

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

    Swift

    var sseCustomerKey: String? { get set }

  • Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    Declaration

    Objective-C

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

    Swift

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