ContextQMD
Back to Aws Doc Sdk Examples

Amazon S3 code examples for the SDK for Ruby

ruby/example_code/s3/README.md

latest4.8 KB
Original Source

Amazon S3 code examples for the SDK for Ruby

Overview

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

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

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.
<!--custom.important.start--> <!--custom.important.end-->

Code examples

Prerequisites

For prerequisites, see the README in the ruby folder.

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

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.

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

Run the examples

Instructions

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

The quickest way to interact with this example code is to invoke a Scenario from your command line. For example, ruby some_scenario.rb will invoke some_scenario.rb.

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

Hello Amazon S3

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

ruby hello/hello_s3.rb

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.
<!--custom.basic_prereqs.s3_Scenario_GettingStarted.start--> <!--custom.basic_prereqs.s3_Scenario_GettingStarted.end-->

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

ruby scenario_getting_started.rb
<!--custom.basics.s3_Scenario_GettingStarted.start--> <!--custom.basics.s3_Scenario_GettingStarted.end-->

Create a presigned URL

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

<!--custom.scenario_prereqs.s3_Scenario_PresignedUrl.start--> <!--custom.scenario_prereqs.s3_Scenario_PresignedUrl.end-->

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

ruby object_presigned_url_upload.rb
<!--custom.scenarios.s3_Scenario_PresignedUrl.start--> <!--custom.scenarios.s3_Scenario_PresignedUrl.end-->

Tests

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

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

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

Contribute

Code examples thrive on community contribution.

To learn more about the contributing process, see CONTRIBUTING.md.

<!--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