PutObjectRequest

import type { PutObjectRequest } from "https://aws-api.deno.dev/v0.4/services/s3.ts?docs=full";

interface PutObjectRequest {

ACL?: ObjectCannedACL | null;

Body?: Uint8Array | string | null;

Bucket: string;

BucketKeyEnabled?: boolean | null;

CacheControl?: string | null;

ChecksumAlgorithm?: ChecksumAlgorithm | null;

ChecksumCRC32?: string | null;

ChecksumCRC32C?: string | null;

ChecksumSHA1?: string | null;

ChecksumSHA256?: string | null;

ContentDisposition?: string | null;

ContentEncoding?: string | null;

ContentLanguage?: string | null;

ContentLength?: number | null;

ContentMD5?: string | null;

ContentType?: string | null;

ExpectedBucketOwner?: string | null;

Expires?: Date | number | null;

GrantFullControl?: string | null;

GrantRead?: string | null;

GrantReadACP?: string | null;

GrantWriteACP?: string | null;

Key: string;

Metadata?: {

[key: string]: string | null | undefined;

} | null;

ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | null;

ObjectLockMode?: ObjectLockMode | null;

ObjectLockRetainUntilDate?: Date | number | null;

RequestPayer?: RequestPayer | null;

ServerSideEncryption?: ServerSideEncryption | null;

SSECustomerAlgorithm?: string | null;

SSECustomerKey?: Uint8Array | string | null;

SSECustomerKeyMD5?: string | null;

SSEKMSEncryptionContext?: string | null;

SSEKMSKeyId?: string | null;

StorageClass?: StorageClass | null;

Tagging?: string | null;

WebsiteRedirectLocation?: string | null;

}

§Properties

ACL?: ObjectCannedACL | null

[src]

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

This action is not supported by Amazon S3 on Outposts.

Body?: Uint8Array | string | null

[src]

Object data.

Bucket: string

[src]

The bucket name to which the PUT action was initiated.

When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form _AccessPointName_-_AccountId_._outpostID_.s3-outposts._Region_.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

BucketKeyEnabled?: boolean | null

[src]

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

CacheControl?: string | null

[src]

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.

ChecksumAlgorithm?: ChecksumAlgorithm | null

[src]

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ChecksumCRC32?: string | null

[src]

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 header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

ChecksumCRC32C?: string | null

[src]

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 header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

ChecksumSHA1?: string | null

[src]

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 header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

ChecksumSHA256?: string | null

[src]

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 header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

ContentDisposition?: string | null

[src]

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

ContentEncoding?: string | null

[src]

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.

ContentLanguage?: string | null

[src]

The language the content is in.

ContentLength?: number | null

[src]

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.

ContentMD5?: string | null

[src]

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.

ContentType?: string | null

[src]

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.

ExpectedBucketOwner?: string | null

[src]

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Expires?: Date | number | null

[src]

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.

GrantFullControl?: string | null

[src]

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

This action is not supported by Amazon S3 on Outposts.

GrantRead?: string | null

[src]

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

GrantReadACP?: string | null

[src]

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

GrantWriteACP?: string | null

[src]

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Key: string

[src]

Object key for which the PUT action was initiated.

Metadata?: {

[key: string]: string | null | undefined;

} | null

[src]

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

ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | null

[src]

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

ObjectLockMode?: ObjectLockMode | null

[src]

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

ObjectLockRetainUntilDate?: Date | number | null

[src]

The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.

RequestPayer?: RequestPayer | null

[src]

ServerSideEncryption?: ServerSideEncryption | null

[src]

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

SSECustomerAlgorithm?: string | null

[src]

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

SSECustomerKey?: Uint8Array | string | null

[src]

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.

SSECustomerKeyMD5?: string | null

[src]

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.

SSEKMSEncryptionContext?: string | null

[src]

Specifies the Amazon Web Services 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.

SSEKMSKeyId?: string | null

[src]

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not providex-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.

StorageClass?: StorageClass | null

[src]

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Tagging?: string | null

[src]

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

WebsiteRedirectLocation?: string | null

[src]

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.