import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack, WithSdkStreamMixin as __WithSdkStreamMixin } from "@aws-sdk/types"; import { GetObjectOutput, GetObjectRequest } from "../models/models_0"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; export interface GetObjectCommandInput extends GetObjectRequest { } export interface GetObjectCommandOutput extends __WithSdkStreamMixin, __MetadataBearer { } /** *

Retrieves objects from Amazon S3. To use GET, you must have READ * access to the object. If you grant READ access to the anonymous user, you can * return the object without using an authorization header.

* *

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer * file system. You can, however, create a logical hierarchy by using object key names that * imply a folder structure. For example, instead of naming an object sample.jpg, * you can name it photos/2006/February/sample.jpg.

* *

To get an object from such a logical hierarchy, specify the full key name for the object * in the GET operation. For a virtual hosted-style request example, if you have * the object photos/2006/February/sample.jpg, specify the resource as * /photos/2006/February/sample.jpg. For a path-style request example, if you * have the object photos/2006/February/sample.jpg in the bucket named * examplebucket, specify the resource as * /examplebucket/photos/2006/February/sample.jpg. For more information about * request types, see HTTP Host Header Bucket Specification.

* *

For more information about returning the ACL of an object, see GetObjectAcl.

* *

If the object you are retrieving is stored in the S3 Glacier or * S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or * S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a * copy using RestoreObject. Otherwise, this action returns an * InvalidObjectStateError error. For information about restoring archived * objects, see Restoring Archived * Objects.

* *

Encryption request headers, like x-amz-server-side-encryption, should not * be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) * or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your * object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

*

If you encrypt an object by using server-side encryption with customer-provided * encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, * you must use the following headers:

* *

For more information about SSE-C, see Server-Side Encryption (Using * Customer-Provided Encryption Keys).

* *

Assuming you have the relevant permission to read object tags, the response also returns the * x-amz-tagging-count header that provides the count of number of tags * associated with the object. You can use GetObjectTagging to retrieve * the tag set associated with an object.

* *

* Permissions *

*

You need the relevant read object (or version) permission for this operation. For more * information, see Specifying Permissions * in a Policy. If the object you request does not exist, the error Amazon S3 returns * depends on whether you also have the s3:ListBucket permission.

* * * *

* Versioning *

*

By default, the GET action returns the current version of an object. To return a * different version, use the versionId subresource.

* * * * * * *

For more information about versioning, see PutBucketVersioning.

* *

* Overriding Response Header Values *

*

There are times when you want to override certain response header values in a GET * response. For example, you might override the Content-Disposition response * header value in your GET request.

* *

You can override values for a set of response headers using the following query * parameters. These response header values are sent only on a successful request, that is, * when status code 200 OK is returned. The set of headers you can override using these * parameters is a subset of the headers that Amazon S3 accepts when you create an object. The * response headers that you can override for the GET response are Content-Type, * Content-Language, Expires, Cache-Control, * Content-Disposition, and Content-Encoding. To override these * header values in the GET response, you use the following request parameters.

* * *

You must sign the request, either using an Authorization header or a presigned URL, * when using these parameters. They cannot be used with an unsigned (anonymous) * request.

* * * *

* Additional Considerations about Request Headers *

* *

If both of the If-Match and If-Unmodified-Since headers are * present in the request as follows: If-Match condition evaluates to * true, and; If-Unmodified-Since condition evaluates to * false; then, S3 returns 200 OK and the data requested.

* *

If both of the If-None-Match and If-Modified-Since headers are * present in the request as follows: If-None-Match condition evaluates to * false, and; If-Modified-Since condition evaluates to * true; then, S3 returns 304 Not Modified response code.

* *

For more information about conditional requests, see RFC 7232.

* *

The following operations are related to GetObject:

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, GetObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, GetObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const command = new GetObjectCommand(input); * const response = await client.send(command); * ``` * * @see {@link GetObjectCommandInput} for command's `input` shape. * @see {@link GetObjectCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * */ export declare class GetObjectCommand extends $Command { readonly input: GetObjectCommandInput; static getEndpointParameterInstructions(): EndpointParameterInstructions; constructor(input: GetObjectCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler; private serialize; private deserialize; }