PutObjectRequest Structure Reference


                    
                    
                    payloadPath

The key for the payload

Declaration

Swift

public static let payloadPath: String?


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]

acl

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

Declaration

Swift

public let acl: ObjectCannedACL?


                    
                    
                    body

Object data.

Declaration

Swift

public let body: Data?


                    
                    
                    bucket

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 using 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

Swift

public let bucket: String


                    
                    
                    cacheControl

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

Swift

public let cacheControl: String?


                    
                    
                    contentDisposition

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

Declaration

Swift

public let contentDisposition: String?


                    
                    
                    contentEncoding

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

Swift

public let contentEncoding: String?


                    
                    
                    contentLanguage

The language the content is in.

Declaration

Swift

public let contentLanguage: String?


                    
                    
                    contentLength

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

Swift

public let contentLength: Int64?


                    
                    
                    contentMD5

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

Swift

public let contentMD5: String?


                    
                    
                    contentType

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

Swift

public let contentType: String?


                    
                    
                    expectedBucketOwner

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

Swift

public let expectedBucketOwner: String?


                    
                    
                    expires

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

Swift

public let expires: TimeStamp?


                    
                    
                    grantFullControl

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

Declaration

Swift

public let grantFullControl: String?


                    
                    
                    grantRead

Allows grantee to read the object data and its metadata.

Declaration

Swift

public let grantRead: String?


                    
                    
                    grantReadACP

Allows grantee to read the object ACL.

Declaration

Swift

public let grantReadACP: String?


                    
                    
                    grantWriteACP

Allows grantee to write the ACL for the applicable object.

Declaration

Swift

public let grantWriteACP: String?

key

Object key for which the PUT operation was initiated.

Declaration

Swift

public let key: String


                    
                    
                    metadata

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

Declaration

Swift

public let metadata: [String : String]?


                    
                    
                    objectLockLegalHoldStatus

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

Declaration

Swift

public let objectLockLegalHoldStatus: ObjectLockLegalHoldStatus?


                    
                    
                    objectLockMode

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

Declaration

Swift

public let objectLockMode: ObjectLockMode?


                    
                    
                    objectLockRetainUntilDate

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

Declaration

Swift

public let objectLockRetainUntilDate: TimeStamp?


                    
                    
                    requestPayer

Undocumented

Declaration

Swift

public let requestPayer: RequestPayer?


                    
                    
                    serverSideEncryption

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

Declaration

Swift

public let serverSideEncryption: ServerSideEncryption?


                    
                    
                    sSECustomerAlgorithm

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

Declaration

Swift

public let sSECustomerAlgorithm: String?


                    
                    
                    sSECustomerKey

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

Swift

public let sSECustomerKey: String?


                    
                    
                    sSECustomerKeyMD5

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

Swift

public let sSECustomerKeyMD5: String?


                    
                    
                    sSEKMSEncryptionContext

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

Swift

public let sSEKMSEncryptionContext: String?


                    
                    
                    sSEKMSKeyId

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

Swift

public let sSEKMSKeyId: String?


                    
                    
                    storageClass

If you don’t specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.

Declaration

Swift

public let storageClass: StorageClass?


                    
                    
                    tagging

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

Declaration

Swift

public let tagging: String?


                    
                    
                    websiteRedirectLocation

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

Swift

public let websiteRedirectLocation: String?


                    
                    
                    init(acl:body:bucket:cacheControl:contentDisposition:contentEncoding:contentLanguage:contentLength:contentMD5:contentType:expectedBucketOwner:expires:grantFullControl:grantRead:grantReadACP:grantWriteACP:key:metadata:objectLockLegalHoldStatus:objectLockMode:objectLockRetainUntilDate:requestPayer:serverSideEncryption:sSECustomerAlgorithm:sSECustomerKey:sSECustomerKeyMD5:sSEKMSEncryptionContext:sSEKMSKeyId:storageClass:tagging:websiteRedirectLocation:)

Undocumented

Declaration

Swift

public init(acl: ObjectCannedACL? = nil, body: Data? = nil, bucket: String, cacheControl: String? = nil, contentDisposition: String? = nil, contentEncoding: String? = nil, contentLanguage: String? = nil, contentLength: Int64? = nil, contentMD5: String? = nil, contentType: String? = nil, expectedBucketOwner: String? = nil, expires: TimeStamp? = nil, grantFullControl: String? = nil, grantRead: String? = nil, grantReadACP: String? = nil, grantWriteACP: String? = nil, key: String, metadata: [String : String]? = nil, objectLockLegalHoldStatus: ObjectLockLegalHoldStatus? = nil, objectLockMode: ObjectLockMode? = nil, objectLockRetainUntilDate: TimeStamp? = nil, requestPayer: RequestPayer? = nil, serverSideEncryption: ServerSideEncryption? = nil, sSECustomerAlgorithm: String? = nil, sSECustomerKey: String? = nil, sSECustomerKeyMD5: String? = nil, sSEKMSEncryptionContext: String? = nil, sSEKMSKeyId: String? = nil, storageClass: StorageClass? = nil, tagging: String? = nil, websiteRedirectLocation: String? = nil)


                    
                    
                    validate(name:)

Declaration

Swift

public func validate(name: String) throws