Class GetObjectCommand

Retrieves an object from Amazon S3.

In the GetObject request, specify the full key name for the object.

General purpose buckets - Both the virtual-hosted-style requests and the path-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the object key name 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 object key name as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification in the Amazon S3 User Guide.

Directory buckets - Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named amzn-s3-demo-bucket--usw2-az1--x-s3, specify the object key name as /photos/2006/February/sample.jpg. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.

Permissions

• General purpose bucket permissions - You must have the required permissions in a policy. To use GetObject, you must have the READ access to the object (or version). If you grant READ access to the anonymous user, the GetObject operation returns the object without using an authorization header. For more information, see Specifying permissions in a policy in the Amazon S3 User Guide.

  If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.

  If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.

  If the object that you request doesn’t exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

  • If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found error.

  • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Access Denied error.

• Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

  If the object is encrypted using SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

Storage classes

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.

Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones. Unsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for the GetObject requests, if your object uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your GetObject requests for the object that uses these types of keys, you’ll get an HTTP 400 Bad Request error.

Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

Overriding response header values through the request

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

You can override values for a set of response headers. These modified response header values are included only in a successful response, that is, when the HTTP status code 200 OK is returned. The headers you can override using the following query parameters in the request are a subset of the headers that Amazon S3 accepts when you create an object.

The response headers that you can override for the GetObject response are Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, and Expires.

To override values for a set of response headers in the GetObject response, you can use the following query parameters in the request.

• response-cache-control

• response-content-disposition

• response-content-encoding

• response-content-language

• response-content-type

• response-expires

When you use these parameters, you must sign the request by using either an Authorization header or a presigned URL. These parameters cannot be used with an unsigned (anonymous) request.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.

The following operations are related to GetObject:

• ListBuckets

• GetObjectAcl

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

import { S3Client, GetObjectCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, GetObjectCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
const client = new S3Client(config);
const input = { // GetObjectRequest
  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",
  ResponseCacheControl: "STRING_VALUE",
  ResponseContentDisposition: "STRING_VALUE",
  ResponseContentEncoding: "STRING_VALUE",
  ResponseContentLanguage: "STRING_VALUE",
  ResponseContentType: "STRING_VALUE",
  ResponseExpires: new Date("TIMESTAMP"),
  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 GetObjectCommand(input);
const response = await client.send(command);
// consume or destroy the stream to free the socket.
const bytes = await response.Body.transformToByteArray();
// const str = await response.Body.transformToString();
// response.Body.destroy(); // only applicable to Node.js Readable streams.

// { // GetObjectOutput
//   TemporaryCopyStorageClass: "STRING_VALUE",
//   Transition: "STRING_VALUE",
//   RetentionLegalHoldCount: Number("int"),
//   Body: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes
//   DeleteMarker: true || false,
//   AcceptRanges: "STRING_VALUE",
//   Expiration: "STRING_VALUE",
//   Restore: "STRING_VALUE",
//   LastModified: new Date("TIMESTAMP"),
//   ContentLength: Number("long"),
//   ETag: "STRING_VALUE",
//   ChecksumCRC32: "STRING_VALUE",
//   ChecksumCRC32C: "STRING_VALUE",
//   ChecksumCRC64NVME: "STRING_VALUE",
//   ChecksumSHA1: "STRING_VALUE",
//   ChecksumSHA256: "STRING_VALUE",
//   ChecksumType: "COMPOSITE" || "FULL_OBJECT",
//   MissingMeta: Number("int"),
//   VersionId: "STRING_VALUE",
//   CacheControl: "STRING_VALUE",
//   ContentDisposition: "STRING_VALUE",
//   ContentEncoding: "STRING_VALUE",
//   ContentLanguage: "STRING_VALUE",
//   ContentRange: "STRING_VALUE",
//   ContentType: "STRING_VALUE",
//   Expires: "STRING_VALUE",
//   WebsiteRedirectLocation: "STRING_VALUE",
//   ServerSideEncryption: "AES256" || "aws:fsx" || "aws:kms" || "aws:kms:dsse",
//   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" || "EXPRESS_ONEZONE" || "FSX_OPENZFS" || "FSX_ONTAP",
//   RequestCharged: "requester",
//   ReplicationStatus: "COMPLETE" || "PENDING" || "FAILED" || "REPLICA" || "COMPLETED",
//   PartsCount: Number("int"),
//   TagCount: Number("int"),
//   ObjectLockMode: "GOVERNANCE" || "COMPLIANCE",
//   ObjectLockRetainUntilDate: new Date("TIMESTAMP"),
//   ObjectLockLegalHoldStatus: "ON" || "OFF",
// };

Copy

// The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.
const input = {
  Bucket: "examplebucket",
  Key: "SampleFile.txt",
  Range: "bytes=0-9"
};
const command = new GetObjectCommand(input);
const response = await client.send(command);
// consume or destroy the stream to free the socket.
const bytes = await response.Body.transformToByteArray();
// const str = await response.Body.transformToString();
// response.Body.destroy(); // only applicable to Node.js Readable streams.

/* response is
{
  AcceptRanges: "bytes",
  ContentLength: 10,
  ContentRange: "bytes 0-9/43",
  ContentType: "text/plain",
  ETag: `"0d94420ffd0bc68cd3d152506b97a9cc"`,
  LastModified: "2014-10-09T22:57:28.000Z",
  Metadata:   { /* empty */ },
  VersionId: "null"
}
*/
Copy

// The following example retrieves an object for an S3 bucket.
const input = {
  Bucket: "examplebucket",
  Key: "HappyFace.jpg"
};
const command = new GetObjectCommand(input);
const response = await client.send(command);
// consume or destroy the stream to free the socket.
const bytes = await response.Body.transformToByteArray();
// const str = await response.Body.transformToString();
// response.Body.destroy(); // only applicable to Node.js Readable streams.

/* response is
{
  AcceptRanges: "bytes",
  ContentLength: 3191,
  ContentType: "image/jpeg",
  ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
  LastModified: "2016-12-15T01:19:41.000Z",
  Metadata:   { /* empty */ },
  TagCount: 2,
  VersionId: "null"
}
*/
Copy