AmazonGlacier Class

Properties   Methods   Events   Configuration Settings   Errors  

The Glacier component provides a quick way to interface with Amazon's Glacier service.

Class Name

InCloudStorage_AmazonGlacier

Procedural Interface

 incloudstorage_amazonglacier_open();
 incloudstorage_amazonglacier_close($res);
 incloudstorage_amazonglacier_register_callback($res, $id, $function);
 incloudstorage_amazonglacier_get_last_error($res);
 incloudstorage_amazonglacier_get_last_error_code($res);
 incloudstorage_amazonglacier_set($res, $id, $index, $value);
 incloudstorage_amazonglacier_get($res, $id, $index);
 incloudstorage_amazonglacier_do_abortmultipartupload($res, $vaultname, $uploadid);
 incloudstorage_amazonglacier_do_completemultipartupload($res, $vaultname, $uploadid);
 incloudstorage_amazonglacier_do_config($res, $configurationstring);
 incloudstorage_amazonglacier_do_createjob($res, $vaultname, $jobtype, $archiveid, $snstopic);
 incloudstorage_amazonglacier_do_createvault($res, $vaultname);
 incloudstorage_amazonglacier_do_deletearchive($res, $vaultname, $archiveid);
 incloudstorage_amazonglacier_do_deletenotificationinfo($res, $vaultname);
 incloudstorage_amazonglacier_do_deletevault($res, $vaultname);
 incloudstorage_amazonglacier_do_doevents($res);
 incloudstorage_amazonglacier_do_getjobinfo($res, $vaultname, $jobid);
 incloudstorage_amazonglacier_do_getjoboutput($res, $vaultname, $jobid);
 incloudstorage_amazonglacier_do_getnotificationinfo($res, $vaultname);
 incloudstorage_amazonglacier_do_getvaultinfo($res, $vaultname);
 incloudstorage_amazonglacier_do_interrupt($res);
 incloudstorage_amazonglacier_do_listjobs($res, $vaultname);
 incloudstorage_amazonglacier_do_listmultipartuploads($res, $vaultname);
 incloudstorage_amazonglacier_do_listparts($res, $vaultname, $uploadid);
 incloudstorage_amazonglacier_do_listvaults($res);
 incloudstorage_amazonglacier_do_reset($res);
 incloudstorage_amazonglacier_do_sendcustomrequest($res, $url, $requestdata, $otherheaders);
 incloudstorage_amazonglacier_do_setnotificationinfo($res, $vaultname);
 incloudstorage_amazonglacier_do_startmultipartupload($res, $vaultname, $archivedesc);
 incloudstorage_amazonglacier_do_uploadarchive($res, $vaultname, $archivedesc);
 incloudstorage_amazonglacier_do_uploadpart($res, $vaultname, $uploadid, $partnumber);

Remarks

The Glacier class allows you to simply access Amazon's Glacier service. Glacier allows you to create vaults and store archives.

Before using the class you must first have an AWS account and sign up for the Glacier service. To use the class first set AccessKey and SecretKey.

To create a vault call CreateVault. Once the vault is created you are ready to upload archives to store in the vault. Set LocalFile to the file you want to upload and call UploadArchive.

To retrieve an archive you must create a job. Jobs are long running operations and Amazon will notify you when the job is complete. To create a job call CreateJob. Use the SetNotificationInfo method to set notification options at the vault level. You may also supply an Amazon SNS topic to CreateJob to which Amazon will publish notification about the job status.

You can also call CreateJob to create an Inventory Retrieval job to list the contents of a vault.

After the job is complete use GetJobOutput to retrieve the data.

Additionally, multipart uploads are supported through the StartMultipartUpload and CompleteMultipartUpload methods. Various other operations such as DeleteArchive, GetJobInfo, ListJobs, ListMultipartUploads, ListVaults, and more provide additional functionality.