@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
260 lines (259 loc) • 12.1 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 { GetObjectAttributesOutput, GetObjectAttributesRequest } from "../models/models_0";
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
/**
* @public
*
* The input for {@link GetObjectAttributesCommand}.
*/
export interface GetObjectAttributesCommandInput extends GetObjectAttributesRequest {
}
/**
* @public
*
* The output of {@link GetObjectAttributesCommand}.
*/
export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOutput, __MetadataBearer {
}
/**
* @public
* <p>Retrieves all the metadata from an object without returning the object itself. This
* action is useful if you're interested only in an object's metadata. To use
* <code>GetObjectAttributes</code>, you must have READ access to the object.</p>
* <p>
* <code>GetObjectAttributes</code> combines the functionality of <code>HeadObject</code>
* and <code>ListParts</code>. All of the data returned with each of those individual calls
* can be returned with a single call to <code>GetObjectAttributes</code>.</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>
* <code>x-amz-server-side-encryption-customer-algorithm</code>
* </p>
* </li>
* <li>
* <p>
* <code>x-amz-server-side-encryption-customer-key</code>
* </p>
* </li>
* <li>
* <p>
* <code>x-amz-server-side-encryption-customer-key-MD5</code>
* </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> in the
* <i>Amazon S3 User Guide</i>.</p>
* <note>
* <ul>
* <li>
* <p>Encryption request headers, such as <code>x-amz-server-side-encryption</code>,
* should not be sent for GET requests if your object uses server-side encryption
* with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or
* server-side encryption with Amazon S3 managed keys (SSE-S3). If your object does use
* these types of keys, you'll get an HTTP <code>400 Bad Request</code> error.</p>
* </li>
* <li>
* <p> The last modified property in this case is the creation date of the
* object.</p>
* </li>
* </ul>
* </note>
* <p>Consider the following when using request headers:</p>
* <ul>
* <li>
* <p> If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers
* are present in the request as follows, then Amazon S3 returns the HTTP status code
* <code>200 OK</code> and the data requested:</p>
* <ul>
* <li>
* <p>
* <code>If-Match</code> condition evaluates to <code>true</code>.</p>
* </li>
* <li>
* <p>
* <code>If-Unmodified-Since</code> condition evaluates to
* <code>false</code>.</p>
* </li>
* </ul>
* </li>
* <li>
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code>
* headers are present in the request as follows, then Amazon S3 returns the HTTP status code
* <code>304 Not Modified</code>:</p>
* <ul>
* <li>
* <p>
* <code>If-None-Match</code> condition evaluates to <code>false</code>.</p>
* </li>
* <li>
* <p>
* <code>If-Modified-Since</code> condition evaluates to
* <code>true</code>.</p>
* </li>
* </ul>
* </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>The permissions that you need to use this operation depend on whether the bucket is
* versioned. If the bucket is versioned, you need both the <code>s3:GetObjectVersion</code>
* and <code>s3:GetObjectVersionAttributes</code> permissions for this operation. If the
* bucket is not versioned, you need the <code>s3:GetObject</code> and
* <code>s3:GetObjectAttributes</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
* Permissions in a Policy</a> in the <i>Amazon S3 User Guide</i>. If the
* object that you request does not exist, the error Amazon S3 returns depends on whether you also
* have the <code>s3:ListBucket</code> permission.</p>
* <ul>
* <li>
* <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns
* an HTTP status code <code>404 Not Found</code> ("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 <code>403 Forbidden</code> ("access denied") error.</p>
* </li>
* </ul>
* </dd>
* </dl>
* <p>The following actions are related to <code>GetObjectAttributes</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_GetObjectAcl.html">GetObjectAcl</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html">GetObjectLegalHold</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html">GetObjectLockConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html">GetObjectRetention</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html">HeadObject</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a>
* </p>
* </li>
* </ul>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { S3Client, GetObjectAttributesCommand } from "@aws-sdk/client-s3"; // ES Modules import
* // const { S3Client, GetObjectAttributesCommand } = require("@aws-sdk/client-s3"); // CommonJS import
* const client = new S3Client(config);
* const input = { // GetObjectAttributesRequest
* Bucket: "STRING_VALUE", // required
* Key: "STRING_VALUE", // required
* VersionId: "STRING_VALUE",
* MaxParts: Number("int"),
* PartNumberMarker: "STRING_VALUE",
* SSECustomerAlgorithm: "STRING_VALUE",
* SSECustomerKey: "STRING_VALUE",
* SSECustomerKeyMD5: "STRING_VALUE",
* RequestPayer: "requester",
* ExpectedBucketOwner: "STRING_VALUE",
* ObjectAttributes: [ // ObjectAttributesList // required
* "ETag" || "Checksum" || "ObjectParts" || "StorageClass" || "ObjectSize",
* ],
* };
* const command = new GetObjectAttributesCommand(input);
* const response = await client.send(command);
* // { // GetObjectAttributesOutput
* // DeleteMarker: true || false,
* // LastModified: new Date("TIMESTAMP"),
* // VersionId: "STRING_VALUE",
* // RequestCharged: "requester",
* // ETag: "STRING_VALUE",
* // Checksum: { // Checksum
* // ChecksumCRC32: "STRING_VALUE",
* // ChecksumCRC32C: "STRING_VALUE",
* // ChecksumSHA1: "STRING_VALUE",
* // ChecksumSHA256: "STRING_VALUE",
* // },
* // ObjectParts: { // GetObjectAttributesParts
* // TotalPartsCount: Number("int"),
* // PartNumberMarker: "STRING_VALUE",
* // NextPartNumberMarker: "STRING_VALUE",
* // MaxParts: Number("int"),
* // IsTruncated: true || false,
* // Parts: [ // PartsList
* // { // ObjectPart
* // PartNumber: Number("int"),
* // Size: Number("long"),
* // ChecksumCRC32: "STRING_VALUE",
* // ChecksumCRC32C: "STRING_VALUE",
* // ChecksumSHA1: "STRING_VALUE",
* // ChecksumSHA256: "STRING_VALUE",
* // },
* // ],
* // },
* // StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW",
* // ObjectSize: Number("long"),
* // };
*
* ```
*
* @param GetObjectAttributesCommandInput - {@link GetObjectAttributesCommandInput}
* @returns {@link GetObjectAttributesCommandOutput}
* @see {@link GetObjectAttributesCommandInput} for command's `input` shape.
* @see {@link GetObjectAttributesCommandOutput} for command's `response` shape.
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
*
* @throws {@link NoSuchKey} (client fault)
* <p>The specified key does not exist.</p>
*
* @throws {@link S3ServiceException}
* <p>Base exception class for all service exceptions from S3 service.</p>
*
*/
export declare class GetObjectAttributesCommand extends $Command<GetObjectAttributesCommandInput, GetObjectAttributesCommandOutput, S3ClientResolvedConfig> {
readonly input: GetObjectAttributesCommandInput;
static getEndpointParameterInstructions(): EndpointParameterInstructions;
/**
* @public
*/
constructor(input: GetObjectAttributesCommandInput);
/**
* @internal
*/
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetObjectAttributesCommandInput, GetObjectAttributesCommandOutput>;
/**
* @internal
*/
private serialize;
/**
* @internal
*/
private deserialize;
}