You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

AWS SDK for Ruby - Version 2


Build Status Code Climate Coverage Status

This is version 2 of the aws-sdk gem. Version 1 can be found in the version-1 branch.

Links of Interest

NameError: uninitialized constant AWS

If you receive this error, you likely have upgraded to version 2 of the aws-sdk gem unintentionally. Version 2 uses the Aws namespace, not AWS. This allows version 1 and version 2 to be used in the same application.


The AWS SDK for Ruby is available as the aws-sdk gem from RubyGems.

To install, ruby gem install aws-sdk

Please use a major version when expressing a dependency on aws-sdk.

gem 'aws-sdk', '~> 2'

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

  • Ask a question on StackOverflow and tag it with aws-sdk-ruby
  • Open a support ticket with AWS Support, if it turns out that you may have found a bug, please open an issue
  • If in doubt as to whether your issue is a question about how to use AWS or a potential SDK issue, feel free to open a GitHub issue on this repo.

Opening Issues

If you encounter a bug with aws-sdk-ruby we would like to hear about it. Search the existing issues and try to make sure your problem doesn’t already exist before opening a new issue. It’s helpful if you include the version of aws-sdk-ruby, ruby version and OS you’re using. Please include a stack trace and reduced repro case when appropriate, too.

The GitHub issues are intended for bug reports and feature requests. For help and questions with using aws-sdk-ruby please make use of the resources listed in the Getting Help section. in particular is a good way to signal your interest in a feature or issue. There are limited resources available for handling issues and by keeping the list of open issues lean we can respond in a timely manner.


You need to configure :credentials and a :region 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:

  • Unless ENV['AWS_SDK_CONFIG_OPT_OUT'] is set, the shared configuration files (~/.aws/credentials and ~/.aws/config) will be checked for a role_arn and source_profile, which if present will be used to attempt to assume a role.
  • The shared credentials ini file at ~/.aws/credentials (more information)
    • 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 time. Shared credentials do not refresh.

The SDK searches the following locations for a region:

  • Unless ENV['AWS_SDK_CONFIG_OPT_OUT'] is set, the shared configuration files (~/.aws/credentials and ~/.aws/config) will also be checked for a region selection.

The region is used to construct an SSL endpoint. If you need to connect to a non-standard endpoint, you may specify the :endpoint option.

Configuration Options

You can configure default credentials and region via Aws.config. In version 2, Aws.config is a vanilla Ruby hash, not a method like it was in version 1. The Aws.config hash takes precedence over environment variables.

require 'aws-sdk'

  region: 'us-west-2',
  credentials:'akid', 'secret')

Valid region and credentials options are:

You may also pass configuration options directly to resource and client constructors. These options take precedence over the environment and Aws.config defaults.

# resource constructors
ec2 ='us-west-2', credentials: credentials)

# client constructors
ec2 ='us-west-2', credentials: credentials)

Please take care to never commit credentials to source control. We strongly recommended loading credentials from an external source.

require 'aws-sdk'
require 'json'
creds = JSON.load('secrets.json'))
Aws.config[:credentials] =['AccessKeyId'], creds['SecretAccessKey'])

API Clients (aws-sdk-core gem)

Construct a service client to make API calls. Each client provides a 1-to-1 mapping of methods to API operations. Refer to the API documentation for a complete list of available methods.

# list buckets in Amazon S3
s3 =
resp = s3.list_buckets
#=> ["bucket-1", "bucket-2", ...]

API methods accept a hash of additional request parameters and return structured response data.

# list the first two objects in a bucket
resp = s3.list_objects(bucket: 'aws-sdk-core', max_keys: 2)
resp.contents.each do |object|
  puts "#{object.key} => #{object.etag}"

Paging Responses

Many AWS operations limit the number of results returned with each response. To make it easy to get the next page of results, every AWS response object is enumerable:

# yields one response object per API call made, this will enumerate
# EVERY object in the named bucket
s3.list_objects(bucket:'aws-sdk').each do |response|

If you prefer to control paging yourself, response objects have helper methods that control paging:

# make a request that returns a truncated response
resp = s3.list_objects(bucket:'aws-sdk')

resp.last_page? #=> false
resp.next_page? #=> true
resp = resp.next_page # send a request for the next response page
resp = resp.next_page until resp.last_page?


Waiters are utility methods that poll for a particular state. To invoke a waiter, call #wait_until on a client:

  ec2.wait_until(:instance_running, instance_ids:['i-12345678'])
  puts "instance running"
rescue Aws::Waiters::Errors::WaiterFailed => error
  puts "failed waiting for instance running: #{error.message}"

Waiters have sensible default polling intervals and maximum attempts. You can configure these per call to #wait_until. You can also register callbacks that are triggered before each polling attempt and before waiting. See the API documentation for more examples and for a list of supported waiters per service.

Resource Interfaces (aws-sdk-resources gem)

Resource interfaces are object oriented classes that represent actual resources in AWS. Resource interfaces built on top of API clients and provide additional functionality.

s3 =

# reference an existing bucket by name
bucket = s3.bucket('aws-sdk')

# enumerate every object in a bucket
bucket.objects.each do |obj|
  puts "#{obj.key} => #{obj.etag}"

# batch operations, delete objects in batches of 1k
bucket.objects(prefix: '/tmp-files/').delete

# single object operations
obj = bucket.object('hello')
obj.put(body:'Hello World!')

REPL - AWS Interactive Console

The aws-sdk-core gem ships with a REPL that provides a simple way to test the Ruby SDK. You can access the REPL by running aws.rb from the command line.

$ aws.rb
Aws> ec2.describe_instances.reservations.first.instances.first
[Aws::EC2::Client 200 0.216615 0 retries] describe_instances()
 state=<struct  code=16, name="running">,

You can enable HTTP wire logging by setting the verbose flag:

$ aws.rb -v

In the REPL, every service class has a helper that returns a new client object. Simply downcase the service module name for the helper:

  • Aws::S3 => s3
  • Aws::EC2 => ec2
  • etc


This project uses semantic versioning. You can safely express a dependency on a major version and expect all minor and patch versions to be backwards compatible.

Supported Services

Service Name Service Class API Version
AWS Amplify Amplify 2017-07-25
AWS App Mesh AppMesh 2019-01-25
AWS AppSync AppSync 2017-07-25
AWS Application Discovery Service ApplicationDiscoveryService 2015-11-01
AWS Auto Scaling Plans AutoScalingPlans 2018-01-06
AWS Backup Backup 2018-11-15
AWS Batch Batch 2016-08-10
AWS Budgets Budgets 2016-10-20
AWS Certificate Manager ACM 2015-12-08
AWS Certificate Manager Private Certificate Authority ACMPCA 2017-08-22
AWS Cloud Map ServiceDiscovery 2017-03-14
AWS Cloud9 Cloud9 2017-09-23
AWS CloudFormation CloudFormation 2010-05-15
AWS CloudHSM V2 CloudHSMV2 2017-04-28
AWS CloudTrail CloudTrail 2013-11-01
AWS CodeBuild CodeBuild 2016-10-06
AWS CodeCommit CodeCommit 2015-04-13
AWS CodeDeploy CodeDeploy 2014-10-06
AWS CodePipeline CodePipeline 2015-07-09
AWS CodeStar CodeStar 2017-04-19
AWS CodeStar Notifications CodeStarNotifications 2019-10-15
AWS CodeStar connections CodeStarconnections 2019-12-01
AWS Comprehend Medical ComprehendMedical 2018-10-30
AWS Compute Optimizer ComputeOptimizer 2019-11-01
AWS Config ConfigService 2014-11-12
AWS Cost Explorer Service CostExplorer 2017-10-25
AWS Cost and Usage Report Service CostandUsageReportService 2017-01-06
AWS Data Exchange DataExchange 2017-07-25
AWS Data Pipeline DataPipeline 2012-10-29
AWS DataSync DataSync 2018-11-09
AWS Database Migration Service DatabaseMigrationService 2016-01-01
AWS Device Farm DeviceFarm 2015-06-23
AWS Direct Connect DirectConnect 2012-10-25
AWS Directory Service DirectoryService 2015-04-16
AWS EC2 Instance Connect EC2InstanceConnect 2018-04-02
AWS Elastic Beanstalk ElasticBeanstalk 2010-12-01
AWS Elemental MediaConvert MediaConvert 2017-08-29
AWS Elemental MediaLive MediaLive 2017-10-14
AWS Elemental MediaPackage MediaPackage 2017-10-12
AWS Elemental MediaPackage VOD MediaPackageVod 2018-11-07
AWS Elemental MediaStore MediaStore 2017-09-01
AWS Elemental MediaStore Data Plane MediaStoreData 2017-09-01
AWS Global Accelerator GlobalAccelerator 2018-08-08
AWS Glue Glue 2017-03-31
AWS Glue DataBrew GlueDataBrew 2017-07-25
AWS Greengrass Greengrass 2017-06-07
AWS Ground Station GroundStation 2019-05-23
AWS Health APIs and Notifications Health 2016-08-04
AWS Identity and Access Management IAM 2010-05-08
AWS Import/Export ImportExport 2010-06-01
AWS IoT IoT 2015-05-28
AWS IoT 1-Click Devices Service IoT1ClickDevicesService 2018-05-14
AWS IoT 1-Click Projects Service IoT1ClickProjects 2018-05-14
AWS IoT Analytics IoTAnalytics 2017-11-27
AWS IoT Data Plane IoTDataPlane 2015-05-28
AWS IoT Events IoTEvents 2018-07-27
AWS IoT Events Data IoTEventsData 2018-10-23
AWS IoT Jobs Data Plane IoTJobsDataPlane 2017-09-29
AWS IoT Secure Tunneling IoTSecureTunneling 2018-10-05
AWS IoT SiteWise IoTSiteWise 2019-12-02
AWS IoT Things Graph IoTThingsGraph 2018-09-06
AWS Key Management Service KMS 2014-11-01
AWS Lake Formation LakeFormation 2017-03-31
AWS Lambda Lambda 2015-03-31
AWS Lambda LambdaPreview 2014-11-11
AWS License Manager LicenseManager 2018-08-01
AWS Marketplace Catalog Service MarketplaceCatalog 2018-09-17
AWS Marketplace Commerce Analytics MarketplaceCommerceAnalytics 2015-07-01
AWS Marketplace Entitlement Service MarketplaceEntitlementService 2017-01-11
AWS MediaConnect MediaConnect 2018-11-14
AWS MediaTailor MediaTailor 2018-04-23
AWS Migration Hub MigrationHub 2017-05-31
AWS Migration Hub Config MigrationHubConfig 2019-06-30
AWS Mobile Mobile 2017-07-01
AWS Network Firewall NetworkFirewall 2020-11-12
AWS Network Manager NetworkManager 2019-07-05
AWS OpsWorks OpsWorks 2013-02-18
AWS OpsWorks CM OpsWorksCM 2016-11-01
AWS Organizations Organizations 2016-11-28
AWS Outposts Outposts 2019-12-03
AWS Performance Insights PI 2018-02-27
AWS Price List Service Pricing 2017-10-15
AWS RDS DataService RDSDataService 2018-08-01
AWS Resource Access Manager RAM 2018-01-04
AWS Resource Groups ResourceGroups 2017-11-27
AWS Resource Groups Tagging API ResourceGroupsTaggingAPI 2017-01-26
AWS RoboMaker RoboMaker 2018-06-29
AWS S3 Control S3Control 2018-08-20
AWS SSO Identity Store IdentityStore 2020-06-15
AWS Savings Plans SavingsPlans 2019-06-28
AWS Secrets Manager SecretsManager 2017-10-17
AWS Security Token Service STS 2011-06-15
AWS SecurityHub SecurityHub 2018-10-26
AWS Server Migration Service SMS 2016-10-24
AWS Service Catalog ServiceCatalog 2015-12-10
AWS Service Catalog App Registry AppRegistry 2020-06-24
AWS Shield Shield 2016-06-02
AWS Signer Signer 2017-08-25
AWS Single Sign-On SSO 2019-06-10
AWS Single Sign-On Admin SSOAdmin 2020-07-20
AWS Step Functions States 2016-11-23
AWS Storage Gateway StorageGateway 2013-06-30
AWS Support Support 2013-04-15
AWS Transfer Family Transfer 2018-11-05
AWS WAF WAF 2015-08-24
AWS WAF Regional WAFRegional 2016-11-28
AWS WAFV2 WAFV2 2019-07-29
AWS X-Ray XRay 2016-04-12
AWSKendraFrontendService Kendra 2019-02-03
AWSMarketplace Metering MarketplaceMetering 2016-01-14
AWSServerlessApplicationRepository ServerlessApplicationRepository 2017-09-08
Access Analyzer AccessAnalyzer 2019-11-01
Alexa For Business AlexaForBusiness 2017-11-09
Amazon API Gateway APIGateway 2015-07-09
Amazon AppConfig AppConfig 2019-10-09
Amazon AppStream AppStream 2016-12-01
Amazon Appflow Appflow 2020-08-23
Amazon Athena Athena 2017-05-18
Amazon Augmented AI Runtime AugmentedAIRuntime 2019-11-07
Amazon Chime Chime 2018-05-01
Amazon CloudDirectory CloudDirectory 2017-01-11
Amazon CloudFront CloudFront 2020-05-31
Amazon CloudHSM CloudHSM 2014-05-30
Amazon CloudSearch CloudSearch 2013-01-01
Amazon CloudSearch Domain CloudSearchDomain 2013-01-01
Amazon CloudWatch CloudWatch 2010-08-01
Amazon CloudWatch Application Insights ApplicationInsights 2018-11-25
Amazon CloudWatch Events CloudWatchEvents 2015-10-07
Amazon CloudWatch Logs CloudWatchLogs 2014-03-28
Amazon CodeGuru Profiler CodeGuruProfiler 2019-07-18
Amazon CodeGuru Reviewer CodeGuruReviewer 2019-09-19
Amazon Cognito Identity CognitoIdentity 2014-06-30
Amazon Cognito Identity Provider CognitoIdentityProvider 2016-04-18
Amazon Cognito Sync CognitoSync 2014-06-30
Amazon Comprehend Comprehend 2017-11-27
Amazon Connect Participant Service ConnectParticipant 2018-09-07
Amazon Connect Service Connect 2017-08-08
Amazon Data Lifecycle Manager DLM 2018-01-12
Amazon Detective Detective 2018-10-26
Amazon DocumentDB with MongoDB compatibility DocDB 2014-10-31
Amazon DynamoDB DynamoDB 2012-08-10
Amazon DynamoDB Accelerator (DAX) DAX 2017-04-19
Amazon DynamoDB Streams DynamoDBStreams 2012-08-10
Amazon EC2 Container Registry ECR 2015-09-21
Amazon EC2 Container Service ECS 2014-11-13
Amazon ElastiCache ElastiCache 2015-02-02
Amazon Elastic Inference ElasticInference 2017-07-25
Amazon Elastic Block Store EBS 2019-11-02
Amazon Elastic Compute Cloud EC2 2016-11-15
Amazon Elastic File System EFS 2015-02-01
Amazon Elastic Kubernetes Service EKS 2017-11-01
Amazon Elastic MapReduce EMR 2009-03-31
Amazon Elastic Transcoder ElasticTranscoder 2012-09-25
Amazon Elasticsearch Service ElasticsearchService 2015-01-01
Amazon EventBridge EventBridge 2015-10-07
Amazon FSx FSx 2018-03-01
Amazon Forecast Query Service ForecastQueryService 2018-06-26
Amazon Forecast Service ForecastService 2018-06-26
Amazon Fraud Detector FraudDetector 2019-11-15
Amazon GameLift GameLift 2015-10-01
Amazon Glacier Glacier 2012-06-01
Amazon GuardDuty GuardDuty 2017-11-28
Amazon Honeycode Honeycode 2020-03-01
Amazon Import/Export Snowball Snowball 2016-06-30
Amazon Inspector Inspector 2016-02-16
Amazon Interactive Video Service IVS 2020-07-14
Amazon Kinesis Kinesis 2013-12-02
Amazon Kinesis Analytics KinesisAnalytics 2015-08-14
Amazon Kinesis Analytics KinesisAnalyticsV2 2018-05-23
Amazon Kinesis Firehose Firehose 2015-08-04
Amazon Kinesis Video Signaling Channels KinesisVideoSignalingChannels 2019-12-04
Amazon Kinesis Video Streams KinesisVideo 2017-09-30
Amazon Kinesis Video Streams Archived Media KinesisVideoArchivedMedia 2017-09-30
Amazon Kinesis Video Streams Media KinesisVideoMedia 2017-09-30
Amazon Lex Model Building Service LexModelBuildingService 2017-04-19
Amazon Lex Runtime Service Lex 2016-11-28
Amazon Lightsail Lightsail 2016-11-28
Amazon Machine Learning MachineLearning 2014-12-12
Amazon Macie Macie 2017-12-19
Amazon Macie 2 Macie2 2020-01-01
Amazon Managed Blockchain ManagedBlockchain 2018-09-24
Amazon Mechanical Turk MTurk 2017-01-17
Amazon Neptune Neptune 2014-10-31
Amazon Personalize Personalize 2018-05-22
Amazon Personalize Events PersonalizeEvents 2018-03-22
Amazon Personalize Runtime PersonalizeRuntime 2018-05-22
Amazon Pinpoint Pinpoint 2016-12-01
Amazon Pinpoint Email Service PinpointEmail 2018-07-26
Amazon Pinpoint SMS and Voice Service PinpointSMSVoice 2018-09-05
Amazon Polly Polly 2016-06-10
Amazon QLDB QLDB 2019-01-02
Amazon QLDB Session QLDBSession 2019-07-11
Amazon QuickSight QuickSight 2018-04-01
Amazon Redshift Redshift 2012-12-01
Amazon Rekognition Rekognition 2016-06-27
Amazon Relational Database Service RDS 2014-10-31
Amazon Route 53 Route53 2013-04-01
Amazon Route 53 Domains Route53Domains 2014-05-15
Amazon Route 53 Resolver Route53Resolver 2018-04-01
Amazon S3 on Outposts S3Outposts 2017-07-25
Amazon SageMaker Runtime SageMakerRuntime 2017-05-13
Amazon SageMaker Service SageMaker 2017-07-24
Amazon Simple Email Service SES 2010-12-01
Amazon Simple Email Service SESV2 2019-09-27
Amazon Simple Notification Service SNS 2010-03-31
Amazon Simple Queue Service SQS 2012-11-05
Amazon Simple Storage Service S3 2006-03-01
Amazon Simple Systems Manager (SSM) SSM 2014-11-06
Amazon Simple Workflow Service SWF 2012-01-25
Amazon SimpleDB SimpleDB 2009-04-15
Amazon Textract Textract 2018-06-27
Amazon Timestream Query TimestreamQuery 2018-11-01
Amazon Timestream Write TimestreamWrite 2018-11-01
Amazon Transcribe Service TranscribeService 2017-10-26
Amazon Translate Translate 2017-07-01
Amazon WorkDocs WorkDocs 2016-05-01
Amazon WorkLink WorkLink 2018-09-25
Amazon WorkMail WorkMail 2017-10-01
Amazon WorkMail Message Flow WorkMailMessageFlow 2019-05-01
Amazon WorkSpaces WorkSpaces 2015-04-08
AmazonApiGatewayManagementApi ApiGatewayManagementApi 2018-11-29
AmazonApiGatewayV2 ApiGatewayV2 2018-11-29
AmazonMQ MQ 2017-11-27
Application Auto Scaling ApplicationAutoScaling 2016-02-06
Auto Scaling AutoScaling 2011-01-01
Braket Braket 2019-09-01
CodeArtifact CodeArtifact 2018-09-22
EC2 Image Builder Imagebuilder 2019-12-02
Elastic Load Balancing ElasticLoadBalancing 2012-06-01
Elastic Load Balancing ElasticLoadBalancingV2 2015-12-01
Firewall Management Service FMS 2018-01-01
Managed Streaming for Kafka Kafka 2018-11-14
Redshift Data API Service RedshiftDataAPIService 2019-12-20
Schemas Schemas 2019-12-02
Service Quotas ServiceQuotas 2019-06-24
Synthetics Synthetics 2017-10-11


This library is distributed under the Apache License, version 2.0

copyright 2013. amazon web services, inc. all rights reserved.

licensed under the apache license, version 2.0 (the "license");
you may not use this file except in compliance with the license.
you may obtain a copy of the license at

unless required by applicable law or agreed to in writing, software
distributed under the license is distributed on an "as is" basis,
without warranties or conditions of any kind, either express or implied.
see the license for the specific language governing permissions and
limitations under the license.