aws-sdk-ruby

# AWS SDK for Ruby - Version 3

[![Gem Version](https://badge.fury.io/rb/aws-sdk-core.svg)](https://badge.fury.io/rb/aws-sdk-core)
[![Build Status](https://github.com/aws/aws-sdk-ruby/workflows/CI/badge.svg)](https://github.com/aws/aws-sdk-ruby/actions)
[![Github forks](https://img.shields.io/github/forks/aws/aws-sdk-ruby.svg)](https://github.com/aws/aws-sdk-ruby/network)
[![Github stars](https://img.shields.io/github/stars/aws/aws-sdk-ruby.svg)](https://github.com/aws/aws-sdk-ruby/stargazers)

## Links of Interest

* [API Documentation](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/index.html)
* [Developer Guide](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/welcome.html)
* [V3 Upgrading Guide](https://github.com/aws/aws-sdk-ruby/blob/version-3/V3_UPGRADING_GUIDE.md)
* [AWS Developer Blog](https://aws.amazon.com/blogs/developer/category/programing-language/ruby/)
* [Github Discussions](https://github.com/aws/aws-sdk-ruby/discussions)

## Installation

The AWS SDK for Ruby is available from RubyGems. With V3 modularization, you
should pick the specific AWS service gems to install.

```ruby
gem 'aws-sdk-s3', '~> 1'
gem 'aws-sdk-ec2', '~> 1'
```

Alternatively, the `aws-sdk` gem contains every available AWS service gem. This
gem is very large; it is recommended to use it only as a quick way to migrate
from V2 or if you depend on many AWS services.

```ruby
gem 'aws-sdk', '~> 3'
```

**Please use a pessimistic version constraint on the major version when
depending on service gems.**

## Configuration

You will need to configure credentials and a region, either in 
[configuration files](https://docs.aws.amazon.com/sdkref/latest/guide/file-location.html)
or environment variables, to make API calls. It is recommended that you
provide these via your environment. This makes it easier to rotate credentials
and it keeps your secrets out of source control. 

The SDK searches the following locations for credentials:

* `ENV['AWS_ACCESS_KEY_ID']` and `ENV['AWS_SECRET_ACCESS_KEY']`
* The shared credentials ini file at `~/.aws/credentials`.  The location used can be changed with the `AWS_CREDENTIALS_FILE` ENV variable.
  * Credential options supported in this file are:
    * Static Credentials (`aws_access_key_id`, `aws_secret_access_key`, `aws_session_token`)
    * Assume Role Web Identity Credentials (`web_identity_token_file`, `role_arn`, `source_profile`)
    * Assume Role Credentials (`role_arn`, `source_profile`)
    * Process Credentials (`credential_process`)
    * SSO Credentials (`sso_session`, `sso_account_id`, `sso_role_name`, `sso_region`)
  * Unless `ENV['AWS_SDK_CONFIG_OPT_OUT']` is set, the shared configuration ini file at `~/.aws/config` will also be parsed for credentials.
* From an instance profile when running on EC2 or from the ECS credential provider when running in an ECS container with that feature enabled.

**Shared configuration is loaded only a single time, and credentials are provided statically at client creation tim