S3 / Client / restore_object

restore_object#

S3.Client.restore_object(**kwargs)#

Note

This operation is not supported for directory buckets.

Restores an archived copy of an object back into Amazon S3

This functionality is not supported for Amazon S3 on Outposts.

This action performs the following types of requests:

  • restore an archive - Restore an archived object

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

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 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 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 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 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 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.

    • 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:

See also: AWS API Documentation

Request Syntax

response = client.restore_object(
    Bucket='string',
    Key='string',
    VersionId='string',
    RestoreRequest={
        'Days': 123,
        'GlacierJobParameters': {
            'Tier': 'Standard'|'Bulk'|'Expedited'
        },
        'Type': 'SELECT',
        'Tier': 'Standard'|'Bulk'|'Expedited',
        'Description': 'string',
        'SelectParameters': {
            'InputSerialization': {
                'CSV': {
                    'FileHeaderInfo': 'USE'|'IGNORE'|'NONE',
                    'Comments': 'string',
                    'QuoteEscapeCharacter': 'string',
                    'RecordDelimiter': 'string',
                    'FieldDelimiter': 'string',
                    'QuoteCharacter': 'string',
                    'AllowQuotedRecordDelimiter': True|False
                },
                'CompressionType': 'NONE'|'GZIP'|'BZIP2',
                'JSON': {
                    'Type': 'DOCUMENT'|'LINES'
                },
                'Parquet': {}

            },
            'ExpressionType': 'SQL',
            'Expression': 'string',
            'OutputSerialization': {
                'CSV': {
                    'QuoteFields': 'ALWAYS'|'ASNEEDED',
                    'QuoteEscapeCharacter': 'string',
                    'RecordDelimiter': 'string',
                    'FieldDelimiter': 'string',
                    'QuoteCharacter': 'string'
                },
                'JSON': {
                    'RecordDelimiter': 'string'
                }
            }
        },
        'OutputLocation': {
            'S3': {
                'BucketName': 'string',
                'Prefix': 'string',
                'Encryption': {
                    'EncryptionType': 'AES256'|'aws:kms'|'aws:kms:dsse',
                    'KMSKeyId': 'string',
                    'KMSContext': 'string'
                },
                'CannedACL': 'private'|'public-read'|'public-read-write'|'authenticated-read'|'aws-exec-read'|'bucket-owner-read'|'bucket-owner-full-control',
                'AccessControlList': [
                    {
                        'Grantee': {
                            'DisplayName': 'string',
                            'EmailAddress': 'string',
                            'ID': 'string',
                            'Type': 'CanonicalUser'|'AmazonCustomerByEmail'|'Group',
                            'URI': 'string'
                        },
                        'Permission': 'FULL_CONTROL'|'WRITE'|'WRITE_ACP'|'READ'|'READ_ACP'
                    },
                ],
                'Tagging': {
                    'TagSet': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
                'UserMetadata': [
                    {
                        'Name': 'string',
                        'Value': 'string'
                    },
                ],
                'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR'|'SNOW'|'EXPRESS_ONEZONE'
            }
        }
    },
    RequestPayer='requester',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256',
    ExpectedBucketOwner='string'
)
Parameters:

  • Bucket (string) –

    [REQUIRED]

    The bucket name containing the object to restore.

    Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.*Region*.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • Key (string) –

    [REQUIRED]

    Object key for which the action was initiated.

  • VersionId (string) – VersionId used to reference a specific version of the object.

  • RestoreRequest (dict) –

    Container for restore job parameters.

    • Days (integer) –

      Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

      The Days element is required for regular restores, and must not be provided for select requests.

    • GlacierJobParameters (dict) –

      S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

      • Tier (string) – [REQUIRED]

        Retrieval tier at which the restore will be processed.

    • Type (string) –

      Warning

      Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

      Type of restore request.

    • Tier (string) –

      Retrieval tier at which the restore will be processed.

    • Description (string) –

      The optional description for the job.

    • SelectParameters (dict) –

      Warning

      Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

      Describes the parameters for Select job types.

      • InputSerialization (dict) – [REQUIRED]

        Describes the serialization format of the object.

        • CSV (dict) –

          Describes the serialization of a CSV-encoded object.

          • FileHeaderInfo (string) –

            Describes the first line of input. Valid values are:

            • NONE: First line is not a header.

            • IGNORE: First line is a header, but you can’t use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column ( SELECT s._1 FROM OBJECT s).

            • Use: First line is a header, and you can use the header value to identify a column in an expression ( SELECT "name" FROM OBJECT).

          • Comments (string) –

            A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.

            Default: #

          • QuoteEscapeCharacter (string) –

            A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

          • RecordDelimiter (string) –

            A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

          • FieldDelimiter (string) –

            A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

          • QuoteCharacter (string) –

            A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

            Type: String

            Default: "

            Ancestors: CSV

          • AllowQuotedRecordDelimiter (boolean) –

            Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

        • CompressionType (string) –

          Specifies object’s compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.

        • JSON (dict) –

          Specifies JSON as object’s input serialization format.

          • Type (string) –

            The type of JSON. Valid values: Document, Lines.

        • Parquet (dict) –

          Specifies Parquet as object’s input serialization format.

      • ExpressionType (string) – [REQUIRED]

        The type of the provided expression (for example, SQL).

      • Expression (string) – [REQUIRED]

        Warning

        Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

        The expression that is used to query the object.

      • OutputSerialization (dict) – [REQUIRED]

        Describes how the results of the Select job are serialized.

        • CSV (dict) –

          Describes the serialization of CSV-encoded Select results.

          • QuoteFields (string) –

            Indicates whether to use quotation marks around output fields.

            • ALWAYS: Always use quotation marks for output fields.

            • ASNEEDED: Use quotation marks for output fields when needed.

          • QuoteEscapeCharacter (string) –

            The single character used for escaping the quote character inside an already escaped value.

          • RecordDelimiter (string) –

            A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.

          • FieldDelimiter (string) –

            The value used to separate individual fields in a record. You can specify an arbitrary delimiter.

          • QuoteCharacter (string) –

            A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

        • JSON (dict) –

          Specifies JSON as request’s output serialization format.

          • RecordDelimiter (string) –

            The value used to separate individual records in the output. If no value is specified, Amazon S3 uses a newline character (’n’).

    • OutputLocation (dict) –

      Describes the location where the restore job’s output is stored.

      • S3 (dict) –

        Describes an S3 location that will receive the results of the restore request.

        • BucketName (string) – [REQUIRED]

          The name of the bucket where the restore results will be placed.

        • Prefix (string) – [REQUIRED]

          The prefix that is prepended to the restore results for this request.

        • Encryption (dict) –

          Contains the type of server-side encryption used.

          • EncryptionType (string) – [REQUIRED]

            The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

          • KMSKeyId (string) –

            If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service Developer Guide.

          • KMSContext (string) –

            If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

        • CannedACL (string) –

          The canned ACL to apply to the restore results.

        • AccessControlList (list) –

          A list of grants that control access to the staged results.

          • (dict) –

            Container for grant information.

            • Grantee (dict) –

              The person being granted permissions.

              • DisplayName (string) –

                Screen name of the grantee.

              • EmailAddress (string) –

                Email address of the grantee.

                Note

                Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

                • US East (N. Virginia)

                • US West (N. California)

                • US West (Oregon)

                • Asia Pacific (Singapore)

                • Asia Pacific (Sydney)

                • Asia Pacific (Tokyo)

                • Europe (Ireland)

                • South America (São Paulo)

                For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

              • ID (string) –

                The canonical user ID of the grantee.

              • Type (string) – [REQUIRED]

                Type of grantee

              • URI (string) –

                URI of the grantee group.

            • Permission (string) –

              Specifies the permission given to the grantee.

        • Tagging (dict) –

          The tag-set that is applied to the restore results.

          • TagSet (list) – [REQUIRED]

            A collection for a set of tags

            • (dict) –

              A container of a key value name pair.

              • Key (string) – [REQUIRED]

                Name of the object key.

              • Value (string) – [REQUIRED]

                Value of the tag.

        • UserMetadata (list) –

          A list of metadata to store with the restore results in S3.

          • (dict) –

            A metadata key-value pair to store with an object.

            • Name (string) –

              Name of the object.

            • Value (string) –

              Value of the object.

        • StorageClass (string) –

          The class of storage used to store the restore results.

  • RequestPayer (string) –

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

    Note

    This functionality is not supported for directory buckets.

  • ChecksumAlgorithm (string) –

    Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don’t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • ExpectedBucketOwner (string) – The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Return type:

dict

Returns:

Response Syntax

{
    'RequestCharged': 'requester',
    'RestoreOutputPath': 'string'
}

Response Structure

  • (dict) –

    • RequestCharged (string) –

      If present, indicates that the requester was successfully charged for the request.

      Note

      This functionality is not supported for directory buckets.

    • RestoreOutputPath (string) –

      Indicates the path in the provided S3 output location where Select results will be restored to.

Exceptions

Examples

The following example restores for one day an archived copy of an object back into Amazon S3 bucket.

response = client.restore_object(
    Bucket='examplebucket',
    Key='archivedobjectkey',
    RestoreRequest={
        'Days': 1,
        'GlacierJobParameters': {
            'Tier': 'Expedited',
        },
    },
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}