AWSS3PutObjectRequest

Objective-C

@interface AWSS3PutObjectRequest

Swift

class AWSS3PutObjectRequest
  • ACL

    The canned ACL to apply to the object. For more information, see Canned ACL.

    This action is not supported by Amazon S3 on Outposts.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ObjectCannedACL ACL;

    Swift

    var acl: AWSS3ObjectCannedACL { get set }

  • Object data.

    Declaration

    Objective-C

    @property (nonatomic, strong) id _Nullable body;

    Swift

    var body: Any? { get set }

  • The bucket name to which the PUT operation was initiated.

    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 }

  • Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

    Declaration

    Objective-C

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

    Swift

    var cacheControl: String? { get set }

  • Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

    Declaration

    Objective-C

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

    Swift

    var contentDisposition: String? { get set }

  • Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

    Declaration

    Objective-C

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

    Swift

    var contentEncoding: String? { get set }

  • The language the content is in.

    Declaration

    Objective-C

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

    Swift

    var contentLanguage: String? { get set }

  • Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

    Declaration

    Objective-C

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

    Swift

    var contentLength: NSNumber? { get set }

  • The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

    Declaration

    Objective-C

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

    Swift

    var contentMD5: String? { get set }

  • A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

    Declaration

    Objective-C

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

    Swift

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

  • The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

    Declaration

    Objective-C

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

    Swift

    var expires: Date? { get set }

  • Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    This action is not supported by Amazon S3 on Outposts.

    Declaration

    Objective-C

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

    Swift

    var grantFullControl: String? { get set }

  • Allows grantee to read the object data and its metadata.

    This action is not supported by Amazon S3 on Outposts.

    Declaration

    Objective-C

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

    Swift

    var grantRead: String? { get set }

  • Allows grantee to read the object ACL.

    This action is not supported by Amazon S3 on Outposts.

    Declaration

    Objective-C

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

    Swift

    var grantReadACP: String? { get set }

  • Allows grantee to write the ACL for the applicable object.

    This action is not supported by Amazon S3 on Outposts.

    Declaration

    Objective-C

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

    Swift

    var grantWriteACP: String? { get set }
  • key

    Object key for which the PUT operation was initiated.

    Declaration

    Objective-C

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

    Swift

    var key: String? { get set }

  • A map of metadata to store with the object in S3.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable metadata;

    Swift

    var metadata: [String : String]? { get set }

  • Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ObjectLockLegalHoldStatus objectLockLegalHoldStatus;

    Swift

    var objectLockLegalHoldStatus: AWSS3ObjectLockLegalHoldStatus { get set }

  • The Object Lock mode that you want to apply to this object.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ObjectLockMode objectLockMode;

    Swift

    var objectLockMode: AWSS3ObjectLockMode { get set }

  • The date and time when you want this object’s Object Lock to expire.

    Declaration

    Objective-C

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

    Swift

    var objectLockRetainUntilDate: Date? { 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 }

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

  • Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    Declaration

    Objective-C

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

    Swift

    var ssekmsEncryptionContext: String? { get set }

  • If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

    If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.

    Declaration

    Objective-C

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

    Swift

    var ssekmsKeyId: String? { get set }

  • The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ServerSideEncryption serverSideEncryption;

    Swift

    var serverSideEncryption: AWSS3ServerSideEncryption { get set }

  • By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3StorageClass storageClass;

    Swift

    var storageClass: AWSS3StorageClass { get set }

  • The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, “Key1=Value1”)

    Declaration

    Objective-C

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

    Swift

    var tagging: String? { get set }

  • If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

    In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

    x-amz-website-redirect-location: /anotherPage.html

    In the following example, the request header sets the object redirect to another website:

    x-amz-website-redirect-location: http://www.example.com/

    For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

    Declaration

    Objective-C

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

    Swift

    var websiteRedirectLocation: String? { get set }