HeadObjectRequest

public struct HeadObjectRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The name of the bucket containing the object.

    Declaration

    Swift

    public let bucket: String

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

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

    Declaration

    Swift

    public let ifMatch: String?

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

    Declaration

    Swift

    public let ifModifiedSince: TimeStamp?

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

    Declaration

    Swift

    public let ifNoneMatch: String?

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

    Declaration

    Swift

    public let ifUnmodifiedSince: TimeStamp?
  • key

    The object key.

    Declaration

    Swift

    public let key: String

  • Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a ‘ranged’ HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

    Declaration

    Swift

    public let partNumber: Int?

  • Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. Amazon S3 doesn’t support retrieving multiple ranges of data per GET request.

    Declaration

    Swift

    public let range: String?

  • Undocumented

    Declaration

    Swift

    public let requestPayer: RequestPayer?

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

    Declaration

    Swift

    public let sSECustomerAlgorithm: String?

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

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

  • VersionId used to reference a specific version of the object.

    Declaration

    Swift

    public let versionId: String?

  • Undocumented

    Declaration

    Swift

    public init(bucket: String, expectedBucketOwner: String? = nil, ifMatch: String? = nil, ifModifiedSince: TimeStamp? = nil, ifNoneMatch: String? = nil, ifUnmodifiedSince: TimeStamp? = nil, key: String, partNumber: Int? = nil, range: String? = nil, requestPayer: RequestPayer? = nil, sSECustomerAlgorithm: String? = nil, sSECustomerKey: String? = nil, sSECustomerKeyMD5: String? = nil, versionId: String? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws