ContextQMD
Back to Aws Doc Sdk Examples

Amazon Glacier code examples for the SDK for Python

python/example_code/glacier/README.md

latest4.6 KB
Original Source

Amazon Glacier code examples for the SDK for Python

Overview

Shows how to use the AWS SDK for Python (Boto3) to work with Amazon Glacier.

<!--custom.overview.start--> <!--custom.overview.end-->

Amazon Glacier provides durable and extremely low-cost storage for infrequently used data with security features for data archiving and backup.

⚠ Important

  • Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
  • Running the tests might result in charges to your AWS account.
  • We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.
<!--custom.important.start--> <!--custom.important.end-->

Code examples

Prerequisites

For prerequisites, see the README in the python folder.

Install the packages required by these examples by running the following in a virtual environment:

python -m pip install -r requirements.txt
<!--custom.prerequisites.start--> <!--custom.prerequisites.end-->

Single actions

Code excerpts that show you how to call individual service functions.

Scenarios

Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

<!--custom.examples.start--> <!--custom.examples.end-->

Run the examples

Instructions

<!--custom.instructions.start--> <!--custom.instructions.end-->

Archive a file, get notifications, and initiate a job

This example shows you how to do the following:

  • Create an Amazon Glacier vault.
  • Configure the vault to publish notifications to an Amazon SNS topic.
  • Upload an archive file to the vault.
  • Initiate an archive retrieval job.
<!--custom.scenario_prereqs.glacier_Usage_UploadNotifyInitiate.start--> <!--custom.scenario_prereqs.glacier_Usage_UploadNotifyInitiate.end-->

Start the example by running the following at a command prompt:

python glacier_basics.py
<!--custom.scenarios.glacier_Usage_UploadNotifyInitiate.start--> <!--custom.scenarios.glacier_Usage_UploadNotifyInitiate.end-->

Get archive content and delete the archive

This example shows you how to do the following:

  • List jobs for an Amazon Glacier vault and get job status.
  • Get the output of a completed archive retrieval job.
  • Delete an archive.
  • Delete a vault.
<!--custom.scenario_prereqs.glacier_Usage_RetrieveDelete.start--> <!--custom.scenario_prereqs.glacier_Usage_RetrieveDelete.end-->

Start the example by running the following at a command prompt:

python glacier_basics.py
<!--custom.scenarios.glacier_Usage_RetrieveDelete.start-->

Because Amazon S3 Glacier is designed for infrequent retrieval, a typical retrieval job takes 3–5 hours to complete.

<!--custom.scenarios.glacier_Usage_RetrieveDelete.end-->

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the python folder.

<!--custom.tests.start--> <!--custom.tests.end-->

Additional resources

<!--custom.resources.start--> <!--custom.resources.end-->

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0