s3_write_get_object_response: Passes transformed objects to a GetObject operation when...

In paws.storage: 'Amazon Web Services' Storage Services

Passes transformed objects to a GetObject operation when using Object Lambda access points

Description

Passes transformed objects to a get_object operation when using Object Lambda access points. For information about Object Lambda access points, see Transforming objects with Object Lambda access points in the Amazon S3 User Guide.

See https://www.paws-r-sdk.com/docs/s3_write_get_object_response/ for full documentation.

Usage

s3_write_get_object_response(
  RequestRoute,
  RequestToken,
  Body = NULL,
  StatusCode = NULL,
  ErrorCode = NULL,
  ErrorMessage = NULL,
  AcceptRanges = NULL,
  CacheControl = NULL,
  ContentDisposition = NULL,
  ContentEncoding = NULL,
  ContentLanguage = NULL,
  ContentLength = NULL,
  ContentRange = NULL,
  ContentType = NULL,
  ChecksumCRC32 = NULL,
  ChecksumCRC32C = NULL,
  ChecksumSHA1 = NULL,
  ChecksumSHA256 = NULL,
  DeleteMarker = NULL,
  ETag = NULL,
  Expires = NULL,
  Expiration = NULL,
  LastModified = NULL,
  MissingMeta = NULL,
  Metadata = NULL,
  ObjectLockMode = NULL,
  ObjectLockLegalHoldStatus = NULL,
  ObjectLockRetainUntilDate = NULL,
  PartsCount = NULL,
  ReplicationStatus = NULL,
  RequestCharged = NULL,
  Restore = NULL,
  ServerSideEncryption = NULL,
  SSECustomerAlgorithm = NULL,
  SSEKMSKeyId = NULL,
  SSECustomerKeyMD5 = NULL,
  StorageClass = NULL,
  TagCount = NULL,
  VersionId = NULL,
  BucketKeyEnabled = NULL
)

Arguments

RequestRoute	[required] Route prefix to the HTTP URL generated.
RequestToken	[required] A single use encrypted token that maps write_get_object_response to the end user get_object request.
Body	The object data.
StatusCode	The integer status code for an HTTP response of a corresponding get_object 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⁠
ErrorCode	A string that uniquely identifies an error condition. Returned in the \<Code\> tag of the error XML response for a corresponding get_object 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][a-zA-Z]+$".
ErrorMessage	Contains a generic description of the error condition. Returned in the \<Message\> tag of the error XML response for a corresponding get_object call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.
AcceptRanges	Indicates that a range of bytes was specified.
CacheControl	Specifies caching behavior along the request/reply chain.
ContentDisposition	Specifies presentational information for the object.
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.
ContentLanguage	The language the content is in.
ContentLength	The size of the content body in bytes.
ContentRange	The portion of the object returned in the response.
ContentType	A standard MIME type describing the format of the object data.
ChecksumCRC32	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 get_object 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.
ChecksumCRC32C	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 get_object 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.
ChecksumSHA1	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 get_object 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.
ChecksumSHA256	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 get_object 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.
DeleteMarker	Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.
ETag	An opaque identifier assigned by a web server to a specific version of a resource found at a URL.
Expires	The date and time at which the object is no longer cacheable.
Expiration	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.
LastModified	The date and time that the object was last modified.
MissingMeta	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.
Metadata	A map of metadata to store with the object in S3.
ObjectLockMode	Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
ObjectLockLegalHoldStatus	Indicates whether an object stored in Amazon S3 has an active legal hold.
ObjectLockRetainUntilDate	The date and time when Object Lock is configured to expire.
PartsCount	The count of parts this object has.
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.
RequestCharged
Restore	Provides information about object restoration operation and expiration time of the restored object copy.
ServerSideEncryption	The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).
SSECustomerAlgorithm	Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
SSEKMSKeyId	If present, specifies the ID 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.
SSECustomerKeyMD5	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).
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.
TagCount	The number of tags, if any, on the object.
VersionId	An ID used to reference a specific version of the object.
BucketKeyEnabled	Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

paws.storage documentation built on Sept. 12, 2023, 1:23 a.m.