Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

GetObjectRequest

import type { GetObjectRequest } from "https://aws-api.deno.dev/v0.4/services/s3.ts?docs=full";
interface GetObjectRequest {
Bucket: string;
ChecksumMode?: ChecksumMode | null;
ExpectedBucketOwner?: string | null;
IfMatch?: string | null;
IfModifiedSince?: Date | number | null;
IfNoneMatch?: string | null;
IfUnmodifiedSince?: Date | number | null;
Key: string;
PartNumber?: number | null;
Range?: string | null;
RequestPayer?: RequestPayer | null;
ResponseCacheControl?: string | null;
ResponseContentDisposition?: string | null;
ResponseContentEncoding?: string | null;
ResponseContentLanguage?: string | null;
ResponseContentType?: string | null;
ResponseExpires?: Date | number | null;
SSECustomerAlgorithm?: string | null;
SSECustomerKey?: Uint8Array | string | null;
SSECustomerKeyMD5?: string | null;
VersionId?: string | null;
}

§Properties

§
Bucket: string
[src]

The bucket name containing the object.

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 an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

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.

§
ChecksumMode?: ChecksumMode | null
[src]

To retrieve the checksum, this mode must be enabled.

§
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).

§
IfMatch?: string | null
[src]

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

§
IfModifiedSince?: Date | number | null
[src]

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

§
IfNoneMatch?: string | null
[src]

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

§
IfUnmodifiedSince?: Date | number | null
[src]

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

§
Key: string
[src]

Key of the object to get.

§
PartNumber?: number | null
[src]

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.

§
Range?: string | null
[src]

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.

Note: Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

§
RequestPayer?: RequestPayer | null
[src]
§
ResponseCacheControl?: string | null
[src]

Sets the Cache-Control header of the response.

§
ResponseContentDisposition?: string | null
[src]

Sets the Content-Disposition header of the response

§
ResponseContentEncoding?: string | null
[src]

Sets the Content-Encoding header of the response.

§
ResponseContentLanguage?: string | null
[src]

Sets the Content-Language header of the response.

§
ResponseContentType?: string | null
[src]

Sets the Content-Type header of the response.

§
ResponseExpires?: Date | number | null
[src]

Sets the Expires header of the response.

§
SSECustomerAlgorithm?: string | null
[src]

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

§
SSECustomerKey?: Uint8Array | string | null
[src]

Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. 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.

§
VersionId?: string | null
[src]

VersionId used to reference a specific version of the object.