Instance Methodswift-cloud 0.24.0CloudCore
encode(to:)
SotoS3Types.swift:9926func encode(to encoder: Encoder) throws func encode(to encoder: Encoder) throws s9CloudCore2S3V29WriteGetObjectResponseRequestV6encode2toys7Encoder_p_tKF What are these?16HK2import CloudCorestruct WriteGetObjectResponseRequeststruct S3Service object for interacting with AWS S3 service.
protocol EncoderA type that can encode values into a native format for external representation.
init(acceptRanges: String? = nil, body: AWSHTTPBody? = nil, bucketKeyEnabled: Bool? = nil, cacheControl: String? = nil, checksumCRC32: String? = nil, checksumCRC32C: String? = nil, checksumSHA1: String? = nil, checksumSHA256: String? = nil, contentDisposition: String? = nil, contentEncoding: String? = nil, contentLanguage: String? = nil, contentLength: Int64? = nil, contentRange: String? = nil, contentType: String? = nil, deleteMarker: Bool? = nil, errorCode: String? = nil, errorMessage: String? = nil, eTag: String? = nil, expiration: String? = nil, expires: Date? = nil, lastModified: Date? = nil, metadata: [String : String]? = nil, missingMeta: Int? = nil, objectLockLegalHoldStatus: ObjectLockLegalHoldStatus? = nil, objectLockMode: ObjectLockMode? = nil, objectLockRetainUntilDate: Date? = nil, partsCount: Int? = nil, replicationStatus: ReplicationStatus? = nil, requestCharged: RequestCharged? = nil, requestRoute: String, requestToken: String, restore: String? = nil, serverSideEncryption: ServerSideEncryption? = nil, sseCustomerAlgorithm: String? = nil, sseCustomerKeyMD5: String? = nil, ssekmsKeyId: String? = nil, statusCode: Int? = nil, storageClass: StorageClass? = nil, tagCount: Int? = nil, versionId: String? = nil) static let _options: AWSShapeOptionsstatic let _xmlRootNodeName: String?let acceptRanges: String?Indicates that a range of bytes was specified.
let body: AWSHTTPBody?The object data.
let bucketKeyEnabled: Bool?Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
let cacheControl: String?Specifies caching behavior along the request/reply chain.
let checksumCRC32: String?This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide. Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
let checksumCRC32C: String?This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide. Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
let checksumSHA1: String?This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide. Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
let checksumSHA256: String?This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide. Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
let contentDisposition: String?Specifies presentational information for the object.
let contentEncoding: String?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.
let contentLanguage: String?The language the content is in.
let contentLength: Int64?The size of the content body in bytes.
let contentRange: String?The portion of the object returned in the response.
let contentType: String?A standard MIME type describing the format of the object data.
let deleteMarker: Bool?Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.
let eTag: String?An opaque identifier assigned by a web server to a specific version of a resource found at a URL.
let errorCode: String?A string that uniquely identifies an error condition. Returned in the tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular expression (regex) value is “^[A-Z]+$”.
let errorMessage: String?Contains a generic description of the error condition. Returned in the tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.
let expiration: String?If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide the object expiration information. The value of the rule-id is URL-encoded.
@OptionalCustomCoding<HTTPHeaderDateCoder> var expires: Date? { get set }The date and time at which the object is no longer cacheable.
@OptionalCustomCoding<HTTPHeaderDateCoder> var lastModified: Date? { get set }The date and time that the object was last modified.
let metadata: [String : String]?A map of metadata to store with the object in S3.
let missingMeta: Int?Set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
let objectLockLegalHoldStatus: ObjectLockLegalHoldStatus?Indicates whether an object stored in Amazon S3 has an active legal hold.
let objectLockMode: ObjectLockMode?Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
@OptionalCustomCoding<ISO8601DateCoder> var objectLockRetainUntilDate: Date? { get set }The date and time when Object Lock is configured to expire.
let partsCount: Int?The count of parts this object has.
let replicationStatus: ReplicationStatus?Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
let requestCharged: RequestCharged?let requestRoute: StringRoute prefix to the HTTP URL generated.
let requestToken: StringA single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.
let restore: String?Provides information about object restoration operation and expiration time of the restored object copy.
let serverSideEncryption: ServerSideEncryption?The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).
let sseCustomerAlgorithm: String?Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
let sseCustomerKeyMD5: String?128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).
let ssekmsKeyId: String?If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in Amazon S3 object.
let statusCode: Int?The integer status code for an HTTP response of a corresponding GetObject request. The following is a list of status codes. 200 - OK 206 - Partial Content 304 - Not Modified 400 - Bad Request 401 - Unauthorized 403 - Forbidden 404 - Not Found 405 - Method Not Allowed 409 - Conflict 411 - Length Required 412 - Precondition Failed 416 - Range Not Satisfiable 500 - Internal Server Error 503 - Service Unavailable
let storageClass: StorageClass?Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects. For more information, see Storage Classes.
let tagCount: Int?The number of tags, if any, on the object.
let versionId: String?An ID used to reference a specific version of the object.