Class GlacierWrapper

python/example_code/glacier/glacier_basics.py:24–343

Encapsulates Amazon S3 Glacier API operations.

# snippet-start:[python.example_code.glacier.GlacierWrapper]
class GlacierWrapper:
    """Encapsulates Amazon S3 Glacier API operations."""

    def __init__(self, glacier_resource):
        """
        :param glacier_resource: A Boto3 Amazon S3 Glacier resource.
        """
        self.glacier_resource = glacier_resource

    # snippet-end:[python.example_code.glacier.GlacierWrapper]

    # snippet-start:[python.example_code.glacier.CreateVault]
    def create_vault(self, vault_name):
        """
        Creates a vault.

        :param vault_name: The name to give the vault.
        :return: The newly created vault.
        """
        try:
            vault = self.glacier_resource.create_vault(vaultName=vault_name)
            logger.info("Created vault %s.", vault_name)
        except ClientError:
            logger.exception("Couldn't create vault %s.", vault_name)
            raise
        else:
            return vault

    # snippet-end:[python.example_code.glacier.CreateVault]

    # snippet-start:[python.example_code.glacier.ListVaults]
    def list_vaults(self):
        """
        Lists vaults for the current account.
        """
        try:
            for vault in self.glacier_resource.vaults.all():
                logger.info("Got vault %s.", vault.name)
        except ClientError:
            logger.exception("Couldn't list vaults.")
            raise

    # snippet-end:[python.example_code.glacier.ListVaults]

    # snippet-start:[python.example_code.glacier.UploadArchive]
    @staticmethod
    def upload_archive(vault, archive_description, archive_file):
        """
        Uploads an archive to a vault.

        :param vault: The vault where the archive is put.
        :param archive_description: A description of the archive.
        :param archive_file: The archive file to put in the vault.
        :return: The uploaded archive.
        """
        try:
            archive = vault.upload_archive(
                archiveDescription=archive_description, body=archive_file