Skip to content

Latest commit

 

History

History
208 lines (128 loc) · 6.54 KB

README.md

File metadata and controls

208 lines (128 loc) · 6.54 KB
Raw

Amazon S3 code examples for the SDK for Go V2

Overview

Shows how to use the AWS SDK for Go V2 to work with Amazon Simple Storage Service (Amazon S3).

Amazon S3 is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web.

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

Code examples

Prerequisites

For prerequisites, see the README in the gov2 folder.

Get started

Basics

Code examples that show you how to perform the essential operations within a service.

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.

Workflows

Examples that show you how to complete a specific task.

Object lock workflow

This workflow demonstrates the following steps and tasks:

  1. Add object lock settings to both new and existing S3 buckets.
    • Add objects to buckets with optional object lock or retention period settings.
  2. Attempt to delete or overwrite locked objects.
  3. Retrieve and view the object lock and retention period settings of buckets and objects.
  4. Delete the objects and buckets.
    • Remove any object locks and use the BypassGovernanceRetention setting.

The code for this example is in the gov2/workflows/s3_object_lock folder. Instructions for how to run are in the README in the same folder.

Run the examples

Instructions

Hello Amazon S3

This example shows you how to get started using Amazon S3.

go run ./hello

Run a scenario

All scenarios can be run with the cmd runner. To get a list of scenarios and to get help for running a scenario, use the following command:

go run ./cmd -h

Learn the basics

This example shows you how to do the following:

  • Create a bucket and upload a file to it.
  • Download an object from a bucket.
  • Copy an object to a subfolder in a bucket.
  • List the objects in a bucket.
  • Delete the bucket objects and the bucket.

Create a presigned URL

This example shows you how to create a presigned URL for Amazon S3 and upload an object.

go run ./cmd -scenario presigning

Lock Amazon S3 objects

This example shows you how to work with S3 object lock features.

Upload or download large files

This example shows you how to upload or download large files to and from Amazon S3.

Large files are included as part of the getstarted scenario.

go run ./cmd -scenario getstarted

Tests

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

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

Additional resources

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

SPDX-License-Identifier: Apache-2.0