Class RestoreObjectCommandProtected

Restores an archived copy of an object back into Amazon S3

This action is not supported by Amazon S3 on Outposts.

This action performs the following types of requests:

• select - Perform a select query on an archived object

• restore an archive - Restore an archived object

For more information about the S3 structure in the request body, see the following:

• PutObject

• Managing Access with ACLs in the Amazon S3 User Guide

• Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide

Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples.

• The following expression returns all records from the specified object.

  SELECT * FROM Object

• Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.

  SELECT s._1, s._2 FROM Object s WHERE s._3 > 100

• If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names.

  SELECT s.Id, s.FirstName, s.SSN FROM S3Object s

When making a select request, you can also do the following:

• To expedite your queries, specify the Expedited tier. For more information about tiers, see "Restoring Archives," later in this topic.

• Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.

The following are additional important facts about the select feature:

• The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle configuration.

• You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't duplicate requests, so avoid issuing duplicate requests.

• Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409.

Permissions

To use this operation, you must have permissions to perform the s3:RestoreObject action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

Restoring objects

Objects that you archive to the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes, you must first initiate a restore request, and then wait until a temporary copy of the object is available. If you want a permanent copy of the object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must restore the object for the duration (number of days) that you specify. For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier.

To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.

When restoring an archived object, you can specify one of the following data access tier options in the Tier element of the request body:

• Expedited - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.

• Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

• Bulk - Bulk retrievals free for objects stored in the S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.

For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User Guide.

To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon S3 User Guide.

After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.

If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon S3 User Guide.

Responses

A successful action returns either the 200 OK or 202 Accepted status code.

• If the object is not previously restored, then Amazon S3 returns 202 Accepted in the response.

• If the object is previously restored, Amazon S3 returns 200 OK in the response.

• Special errors:

  • Code: RestoreAlreadyInProgress

  • Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)

  • HTTP Status Code: 409 Conflict

  • SOAP Fault Code Prefix: Client

• • Code: GlacierExpeditedRetrievalNotAvailable

  • Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)

  • HTTP Status Code: 503

  • SOAP Fault Code Prefix: N/A

The following operations are related to RestoreObject:

• PutBucketLifecycleConfiguration

• GetBucketNotificationConfiguration

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, RestoreObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, RestoreObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // RestoreObjectRequest
  Bucket: "STRING_VALUE", // required
  Key: "STRING_VALUE", // required
  VersionId: "STRING_VALUE",
  RestoreRequest: { // RestoreRequest
    Days: Number("int"),
    GlacierJobParameters: { // GlacierJobParameters
      Tier: "Standard" || "Bulk" || "Expedited", // required
    },
    Type: "SELECT",
    Tier: "Standard" || "Bulk" || "Expedited",
    Description: "STRING_VALUE",
    SelectParameters: { // SelectParameters
      InputSerialization: { // InputSerialization
        CSV: { // CSVInput
          FileHeaderInfo: "USE" || "IGNORE" || "NONE",
          Comments: "STRING_VALUE",
          QuoteEscapeCharacter: "STRING_VALUE",
          RecordDelimiter: "STRING_VALUE",
          FieldDelimiter: "STRING_VALUE",
          QuoteCharacter: "STRING_VALUE",
          AllowQuotedRecordDelimiter: true || false,
        },
        CompressionType: "NONE" || "GZIP" || "BZIP2",
        JSON: { // JSONInput
          Type: "DOCUMENT" || "LINES",
        },
        Parquet: {},
      },
      ExpressionType: "SQL", // required
      Expression: "STRING_VALUE", // required
      OutputSerialization: { // OutputSerialization
        CSV: { // CSVOutput
          QuoteFields: "ALWAYS" || "ASNEEDED",
          QuoteEscapeCharacter: "STRING_VALUE",
          RecordDelimiter: "STRING_VALUE",
          FieldDelimiter: "STRING_VALUE",
          QuoteCharacter: "STRING_VALUE",
        },
        JSON: { // JSONOutput
          RecordDelimiter: "STRING_VALUE",
        },
      },
    },
    OutputLocation: { // OutputLocation
      S3: { // S3Location
        BucketName: "STRING_VALUE", // required
        Prefix: "STRING_VALUE", // required
        Encryption: { // Encryption
          EncryptionType: "AES256" || "aws:kms", // required
          KMSKeyId: "STRING_VALUE",
          KMSContext: "STRING_VALUE",
        },
        CannedACL: "private" || "public-read" || "public-read-write" || "authenticated-read" || "aws-exec-read" || "bucket-owner-read" || "bucket-owner-full-control",
        AccessControlList: [ // Grants
          { // Grant
            Grantee: { // Grantee
              DisplayName: "STRING_VALUE",
              EmailAddress: "STRING_VALUE",
              ID: "STRING_VALUE",
              URI: "STRING_VALUE",
              Type: "CanonicalUser" || "AmazonCustomerByEmail" || "Group", // required
            },
            Permission: "FULL_CONTROL" || "WRITE" || "WRITE_ACP" || "READ" || "READ_ACP",
          },
        ],
        Tagging: { // Tagging
          TagSet: [ // TagSet // required
            { // Tag
              Key: "STRING_VALUE", // required
              Value: "STRING_VALUE", // required
            },
          ],
        },
        UserMetadata: [ // UserMetadata
          { // MetadataEntry
            Name: "STRING_VALUE",
            Value: "STRING_VALUE",
          },
        ],
        StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW",
      },
    },
  },
  RequestPayer: "requester",
  ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256",
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new RestoreObjectCommand(input);
const response = await client.send(command);
// { // RestoreObjectOutput
//   RequestCharged: "requester",
//   RestoreOutputPath: "STRING_VALUE",
// };

Param

RestoreObjectCommandInput

Returns

RestoreObjectCommandOutput

See

• RestoreObjectCommandInput for command's input shape.
• RestoreObjectCommandOutput for command's response shape.
• config for S3Client's config shape.

Throws

ObjectAlreadyInActiveTierError (client fault)

This action is not allowed against this storage tier.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.

Example

To restore an archived object

// The following example restores for one day an archived copy of an object back into Amazon S3 bucket.
const input = {
  "Bucket": "examplebucket",
  "Key": "archivedobjectkey",
  "RestoreRequest": {
    "Days": 1,
    "GlacierJobParameters": {
      "Tier": "Expedited"
    }
  }
};
const command = new RestoreObjectCommand(input);
await client.send(command);
// example id: to-restore-an-archived-object-1483049329953