AWSS3CreateMultipartUploadRequest

Objective-C

@interface AWSS3CreateMultipartUploadRequest

Swift

class AWSS3CreateMultipartUploadRequest
  • ACL

    The canned ACL to apply to the object.

    This action is not supported by Amazon S3 on Outposts.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ObjectCannedACL ACL;

    Swift

    var acl: AWSS3ObjectCannedACL { get set }

  • The name of the bucket to which to initiate the upload

    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 }

  • Specifies caching behavior along the request/reply chain.

    Declaration

    Objective-C

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

    Swift

    var cacheControl: String? { get set }

  • Specifies presentational information for the object.

    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.

    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 }

  • A standard MIME type describing the format of the object data.

    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.

    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 multipart upload is to be 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 you want to apply a Legal Hold to the uploaded object.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ObjectLockLegalHoldStatus objectLockLegalHoldStatus;

    Swift

    var objectLockLegalHoldStatus: AWSS3ObjectLockLegalHoldStatus { get set }

  • Specifies the Object Lock mode that you want to apply to the uploaded object.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ObjectLockMode objectLockMode;

    Swift

    var objectLockMode: AWSS3ObjectLockMode { get set }

  • Specifies the date and time when you want the 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 }

  • Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 Developer Guide.

    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.

    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.

    Declaration

    Objective-C

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

    Swift

    var websiteRedirectLocation: String? { get set }

RequestHeaders

  • Undocumented

    Declaration

    Objective-C

    + (void)propagateHeaderInformation:(AWSS3CreateMultipartUploadRequest *)uploadRequest
                    requestHeaders:(NSDictionary<NSString *, NSString *> *)requestHeaders;