Example restore object from Glacier doesn't work

[lendoly]

I was trying to retrieve some elements from glacier, for that I was using the example on the documentation

I tried few configurations but no one of them works so I will keep it as simpler as possible, the code:

import boto3
BUCKET = 'bucket-glacier'

s3 = boto3.resource('s3')
bucket = s3.Bucket(BUCKET)
for obj_sum in bucket.objects.all():
    if 'ls' in obj_sum.key:
        obj = s3.Object(obj_sum.bucket_name, obj_sum.key)
        if obj.storage_class == 'GLACIER':
            # Try to restore the object if the storage class is glacier and
            # the object does not have a completed or ongoing restoration
            # request.
            if obj.restore is None:
                print('Submitting restoration request: %s' % obj.key)
                obj.restore_object()
            # Print out objects whose restoration is on-going
            elif 'ongoing-request="true"' in obj.restore:
                print('Restoration in-progress: %s' % obj.key)
            # Print out objects whose restoration is complete
            elif 'ongoing-request="false"' in obj.restore:
                print('Restoration complete: %s' % obj.key)

I'm having problems in the obj.restore_object() (which is the most important part)

is showing to me the next error:
*** botocore.exceptions.ClientError: An error occurred (MissingRequestBodyError) when calling the RestoreObject operation: Request Body is empty

I tried also to configure the RestoreRequest like in the doc of the method but it also didn't work
*** botocore.exceptions.ClientError: An error occurred (MalformedXML) when calling the RestoreObject operation: The XML you provided was not well-formed or did not validate against our published schema

Versions:
Python: 3.5
Boto 3: 1.5.18
botocore: 1.8.32

[jamestwebber]

I am having this problem as well, the following code:

client = boto3.client('s3')

restore_request = {
    'OutputLocation': {
        'S3': {
            'BucketName': 'destination-bucket',
            'Prefix': 'destination-prefix',
        }
    }
}
client.restore_object(Bucket='bucket-name', Key=file_key,
                      RestoreRequest=restore_request)

gets me the same MalformedXML error. Not sure what it's complaining about, and I can't find the relevant schema to verify what boto3 is sending.

[jamestwebber]

It appears that my problem is that restore_request is ill-formed somehow, but I can't figure out how or why. I believe I'm following the docs correctly, and the bucket name is valid.

When my RestoreRequest is {'Days': 1} the code works.

[lendoly]

with the client.restore_object and {'Days': 1} also works for me

[joguSD]

Looking into this, it might take me some time to reproduce this.

[joguSD]

I've reproduced this and can definitely confirm that the operation will fail with a MissingRequestBodyError if you don't pass any arguments. According to the API's documentation it would seem that you need to provide at least RestoreRequest={'Days': days} (or some other configuration depending on your goal).

It would seem that this has always been the case as well so I'm not entirely certain that example ever worked. I'll send a PR to update the documentation to include the RestoreRequest.

PR: #1439

[jamestwebber]

Hm it's strange that the Days parameter is necessary when RestoreLocation is specified–I thought the latter meant that the files would be restored to a new location on S3 and would not expire.

[arnonki]

EDIT:

Had to upgrade botocore, some service jsons were outdated

[joguSD]

The RestoreLocation is used to store the output of your S3 select query.

From the API Docs:
OutputLocation: Describes the location that receives the results of the select restore request.

If you need more help with the usage of a service I would suggest reaching out on the service forum.

Closing the issue out here as we merged the changes to update the example client code.

[cfurst]

@joguSD Where does it say that?.. according to the boto3 docs it says "OutputLocation (dict) --
Describes the location where the restore job's output is stored."
Which is very misleading, IMO, as it doesn't specify that its only for select requests.
Even in AWS's api docs for RestoreObject, it says that exact same thing.

[gjvc]

@jamestwebber I know it's been a while, but I bumped into the same problem as you, but managed to crack it. Here's some example code that works.

def restore_item( s3, source_bucket_name, source_key, restore_days, glacier_job_tier ):
    restore_request = {
        'Days': restore_days,
        'GlacierJobParameters': {
            'Tier': glacier_job_tier
        }
    }

    try:
        print( f'{source_bucket_name} {source_key}' )
        response = s3.restore_object(
            Bucket=source_bucket_name,
            Key=source_key,
            RestoreRequest=restore_request
        )
        print( response )
    except botocore.exceptions.ClientError as e:
        print( f'{source_bucket_name} {source_key} {e}' )
    except Exception as e:
        print( e )

[sotosoul]

It's been a while but I'm still facing an issue similar to what @jamestwebber was facing. Not sure exactly what the problem is but it won't work unless I pass days. Interestingly, the current Boto3 documentation seems incoherent in some places; possibly wrong.