@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
257 lines (256 loc) • 11.6 kB
TypeScript
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 } from "@aws-sdk/types";
import { HeadObjectOutput, HeadObjectRequest } from "../models/models_0";
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
/**
* @public
*
* The input for {@link HeadObjectCommand}.
*/
export interface HeadObjectCommandInput extends HeadObjectRequest {
}
/**
* @public
*
* The output of {@link HeadObjectCommand}.
*/
export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBearer {
}
/**
* @public
* <p>The HEAD action retrieves metadata from an object without returning the object itself.
* This action is useful if you're only interested in an object's metadata. To use HEAD, you
* must have READ access to the object.</p>
* <p>A <code>HEAD</code> request has the same options as a <code>GET</code> action on an
* object. The response is identical to the <code>GET</code> response except that there is no
* response body. Because of this, if the <code>HEAD</code> request generates an error, it
* returns a generic <code>400 Bad Request</code>, <code>403 Forbidden</code> or <code>404 Not
* Found</code> code. It is not possible to retrieve the exact exception beyond these error
* codes.</p>
* <p>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 retrieve the
* metadata from the object, you must use the following headers:</p>
* <ul>
* <li>
* <p>x-amz-server-side-encryption-customer-algorithm</p>
* </li>
* <li>
* <p>x-amz-server-side-encryption-customer-key</p>
* </li>
* <li>
* <p>x-amz-server-side-encryption-customer-key-MD5</p>
* </li>
* </ul>
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
* (Using Customer-Provided Encryption Keys)</a>.</p>
* <note>
* <ul>
* <li>
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
* 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.</p>
* </li>
* <li>
* <p> The last modified property in this case is the creation date of the
* object.</p>
* </li>
* </ul>
* </note>
* <p>Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common
* Request Headers</a>.</p>
* <p>Consider the following when using request headers:</p>
* <ul>
* <li>
* <p> Consideration 1 – If both of the <code>If-Match</code> and
* <code>If-Unmodified-Since</code> headers are present in the request as
* follows:</p>
* <ul>
* <li>
* <p>
* <code>If-Match</code> condition evaluates to <code>true</code>, and;</p>
* </li>
* <li>
* <p>
* <code>If-Unmodified-Since</code> condition evaluates to
* <code>false</code>;</p>
* </li>
* </ul>
* <p>Then Amazon S3 returns <code>200 OK</code> and the data requested.</p>
* </li>
* <li>
* <p> Consideration 2 – If both of the <code>If-None-Match</code> and
* <code>If-Modified-Since</code> headers are present in the request as
* follows:</p>
* <ul>
* <li>
* <p>
* <code>If-None-Match</code> condition evaluates to <code>false</code>,
* and;</p>
* </li>
* <li>
* <p>
* <code>If-Modified-Since</code> condition evaluates to
* <code>true</code>;</p>
* </li>
* </ul>
* <p>Then Amazon S3 returns the <code>304 Not Modified</code> response code.</p>
* </li>
* </ul>
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
* <dl>
* <dt>Permissions</dt>
* <dd>
* <p>You need the relevant read object (or version) permission for this operation. For more
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, resources, and condition keys for Amazon S3</a>.
* If the object you request does not exist, the error Amazon S3 returns depends
* on whether you also have the s3:ListBucket permission.</p>
* <ul>
* <li>
* <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns
* an HTTP status code 404 ("no such key") error.</p>
* </li>
* <li>
* <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP
* status code 403 ("access denied") error.</p>
* </li>
* </ul>
* </dd>
* </dl>
* <p>The following actions are related to <code>HeadObject</code>:</p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a>
* </p>
* </li>
* </ul>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { S3Client, HeadObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import
* // const { S3Client, HeadObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import
* const client = new S3Client(config);
* const input = { // HeadObjectRequest
* Bucket: "STRING_VALUE", // required
* IfMatch: "STRING_VALUE",
* IfModifiedSince: new Date("TIMESTAMP"),
* IfNoneMatch: "STRING_VALUE",
* IfUnmodifiedSince: new Date("TIMESTAMP"),
* Key: "STRING_VALUE", // required
* Range: "STRING_VALUE",
* VersionId: "STRING_VALUE",
* SSECustomerAlgorithm: "STRING_VALUE",
* SSECustomerKey: "STRING_VALUE",
* SSECustomerKeyMD5: "STRING_VALUE",
* RequestPayer: "requester",
* PartNumber: Number("int"),
* ExpectedBucketOwner: "STRING_VALUE",
* ChecksumMode: "ENABLED",
* };
* const command = new HeadObjectCommand(input);
* const response = await client.send(command);
* // { // HeadObjectOutput
* // DeleteMarker: true || false,
* // AcceptRanges: "STRING_VALUE",
* // Expiration: "STRING_VALUE",
* // Restore: "STRING_VALUE",
* // ArchiveStatus: "ARCHIVE_ACCESS" || "DEEP_ARCHIVE_ACCESS",
* // LastModified: new Date("TIMESTAMP"),
* // ContentLength: Number("long"),
* // ChecksumCRC32: "STRING_VALUE",
* // ChecksumCRC32C: "STRING_VALUE",
* // ChecksumSHA1: "STRING_VALUE",
* // ChecksumSHA256: "STRING_VALUE",
* // ETag: "STRING_VALUE",
* // MissingMeta: Number("int"),
* // VersionId: "STRING_VALUE",
* // CacheControl: "STRING_VALUE",
* // ContentDisposition: "STRING_VALUE",
* // ContentEncoding: "STRING_VALUE",
* // ContentLanguage: "STRING_VALUE",
* // ContentType: "STRING_VALUE",
* // Expires: new Date("TIMESTAMP"),
* // WebsiteRedirectLocation: "STRING_VALUE",
* // ServerSideEncryption: "AES256" || "aws:kms",
* // Metadata: { // Metadata
* // "<keys>": "STRING_VALUE",
* // },
* // SSECustomerAlgorithm: "STRING_VALUE",
* // SSECustomerKeyMD5: "STRING_VALUE",
* // SSEKMSKeyId: "STRING_VALUE",
* // BucketKeyEnabled: true || false,
* // StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW",
* // RequestCharged: "requester",
* // ReplicationStatus: "COMPLETE" || "PENDING" || "FAILED" || "REPLICA",
* // PartsCount: Number("int"),
* // ObjectLockMode: "GOVERNANCE" || "COMPLIANCE",
* // ObjectLockRetainUntilDate: new Date("TIMESTAMP"),
* // ObjectLockLegalHoldStatus: "ON" || "OFF",
* // };
*
* ```
*
* @param HeadObjectCommandInput - {@link HeadObjectCommandInput}
* @returns {@link HeadObjectCommandOutput}
* @see {@link HeadObjectCommandInput} for command's `input` shape.
* @see {@link HeadObjectCommandOutput} for command's `response` shape.
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
*
* @throws {@link NotFound} (client fault)
* <p>The specified content does not exist.</p>
*
* @throws {@link S3ServiceException}
* <p>Base exception class for all service exceptions from S3 service.</p>
*
* @example To retrieve metadata of an object without returning the object itself
* ```javascript
* // The following example retrieves an object metadata.
* const input = {
* "Bucket": "examplebucket",
* "Key": "HappyFace.jpg"
* };
* const command = new HeadObjectCommand(input);
* const response = await client.send(command);
* /* response ==
* {
* "AcceptRanges": "bytes",
* "ContentLength": "3191",
* "ContentType": "image/jpeg",
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
* "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT",
* "Metadata": {},
* "VersionId": "null"
* }
* *\/
* // example id: to-retrieve-metadata-of-an-object-without-returning-the-object-itself-1481834820480
* ```
*
*/
export declare class HeadObjectCommand extends $Command<HeadObjectCommandInput, HeadObjectCommandOutput, S3ClientResolvedConfig> {
readonly input: HeadObjectCommandInput;
static getEndpointParameterInstructions(): EndpointParameterInstructions;
/**
* @public
*/
constructor(input: HeadObjectCommandInput);
/**
* @internal
*/
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<HeadObjectCommandInput, HeadObjectCommandOutput>;
/**
* @internal
*/
private serialize;
/**
* @internal
*/
private deserialize;
}