The code examples in this topic show you how to use the AWS SDK for Ruby Version 3 with AWS.
The AWS SDK for Ruby Version 3 provides a Ruby API for AWS infrastructure services. Using the SDK, you can build applications on top of Amazon S3, Amazon EC2, Amazon DynamoDB, and more.
-
Single-service actions - Code examples that show you how to call individual service functions.
-
Single-service scenarios - Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.
-
Cross-service examples - Sample applications that work across multiple AWS services.
Single-service actions and scenarios are organized by AWS service in the example_code folder. A README in each folder lists and describes how to run the examples.
There are currently no cross-service examples for the AWS SDK for Ruby. To request a cross-service example, create an issue in the AWS SDK Code Examples repo.
- Running this code might result in charges to your AWS account.
- 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.
- You must have an AWS account, and have your default credentials and AWS Region configured as described in the AWS Tools and SDKs Shared Configuration and Credentials Reference Guide.
- Ruby 3.0.0 or later
- RSpec 3.10 or later (to run tests)
- aws-sdk gem 3.1.0 or later
- bundler 2.3.8 or later (to use bundler to install gems)
Note: Running the tests might result in charges to your AWS account.
All tests use RSpec, and you can find them in the spec folder for each example. Please check the README for each service or cross-service example for any additional requirements to run tests.
Note: Running the tests might result in charges to your AWS account.
The unit tests in this module use stubbed responses from AWS SDK for Ruby. This means that when the unit tests are run, requests are not sent to AWS, mocked responses are returned, and no charges are incurred on your account.
Run unit tests in the folder for each service or cross-service example at a command
prompt by including the ~integ tag.
rspec --tag ~integ
Note: Running the tests might result in charges to your AWS account.
The integration tests in this module make actual requests to AWS. This means that when the integration tests are run, they can create and destroy resources in your account. These tests might also incur charges. Proceed with caution.
Run integration tests in the folder for each service or cross-service example at a
command prompt by including the integ tag.
rspec --tag integ
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0