sjauld/aws-ruby-developer-guide

Source for the AWS SDK for Ruby Developer Guide. Provides information about how to install, set up, and use the AWS SDK for Ruby to create Ruby applications that use AWS services.

Developer guide for the AWS SDK for Ruby

This is the open source version of the developer guide for the Amazon Web Services (AWS) SDK for Ruby.

NOTE: The default branch for this repo has changed to main. If you have cloned the previous default branch, please update your local repo to use the main branch.

To view this documentation, start with the index.

This repository contains the open source version of the official AWS SDK for Ruby Developer Guide. It provides information about how to install, set up, and use the AWS SDK for Ruby to create Ruby applications that use AWS.

The GitHub repository for the AWS SDK for Ruby is at https://github.com/aws/aws-sdk-ruby.

Recent updates

You can find out when this guide has had major updates and what those updates were by looking in the Document History topic.

Reporting issues

You can use the Issues section of this repository to report problems in the documentation. When submitting an issue, please indicate:

• What page the issue occurs on; a URL or filename is best.
• What the issue is, using as much detail as you can provide.
  • The issue might be simple. For example: "The page has a typo; the word 'complie' in the third paragraph should be 'compile'."
  • The issue might be more complex. If so, please describe it with enough detail so that it's clear to the AWS documentation team what the problem is.

Contributing fixes and updates

To contribute your own documentation fixes or updates, please use standard GitHub procedures for forking a repository and submitting a pull request.

Code examples in the documentation

The code examples featured in this documentation can be found in a separate repository: aws-doc-sdk-examples.

In addition to examples in Ruby, you'll also find examples for each of the other AWS SDKs. If you find issues with any of the examples, you can submit Issues or fork the repository and submit a pull request!

The code examples are provided under the Apache 2.0 open source license. For more details, see the example repository's README.

Copyright and license

All content in this repository, unless otherwise stated, is Copyright Amazon.com, Inc. or its affiliates. All rights reserved.

Except where otherwise noted, this work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (the "License"). Use the preceding link for a human-readable summary of the license terms. The full license text is available at: http://creativecommons.org/licenses/by-nc-sa/4.0/legalcode and in the LICENSE file accompanying this repository.

License summary

The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file.

The sample code within this documentation is made available under the MIT-0 license. See the LICENSE-SAMPLECODE file.