GetObjectRequest

public struct GetObjectRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The bucket name containing the object. 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

  • 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

    Key of the object to get.

    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’ GET request for the part specified. Useful for downloading just a part of an object.

    Declaration

    Swift

    public let partNumber: Int?

  • Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://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?

  • Sets the Cache-Control header of the response.

    Declaration

    Swift

    public let responseCacheControl: String?

  • Sets the Content-Disposition header of the response

    Declaration

    Swift

    public let responseContentDisposition: String?

  • Sets the Content-Encoding header of the response.

    Declaration

    Swift

    public let responseContentEncoding: String?

  • Sets the Content-Language header of the response.

    Declaration

    Swift

    public let responseContentLanguage: String?

  • Sets the Content-Type header of the response.

    Declaration

    Swift

    public let responseContentType: String?

  • Sets the Expires header of the response.

    Declaration

    Swift

    public let responseExpires: TimeStamp?

  • 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, responseCacheControl: String? = nil, responseContentDisposition: String? = nil, responseContentEncoding: String? = nil, responseContentLanguage: String? = nil, responseContentType: String? = nil, responseExpires: TimeStamp? = nil, sSECustomerAlgorithm: String? = nil, sSECustomerKey: String? = nil, sSECustomerKeyMD5: String? = nil, versionId: String? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws