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

Module: AWS

Defined in:
lib/aws/core.rb,
lib/aws/s3.rb,
lib/aws/sns.rb,
lib/aws/iam.rb,
lib/aws/rds.rb,
lib/aws/elb.rb,
lib/aws/ec2.rb,
lib/aws/sts.rb,
lib/aws/sqs.rb,
lib/aws/emr.rb,
lib/aws/rails.rb,
lib/aws/errors.rb,
lib/aws/record.rb,
lib/aws/ec2/vpc.rb,
lib/aws/support.rb,
lib/aws/version.rb,
lib/aws/glacier.rb,
lib/aws/ec2/tag.rb,
lib/aws/s3/tree.rb,
lib/aws/kinesis.rb,
lib/aws/redshift.rb,
lib/aws/iam/user.rb,
lib/aws/route_53.rb,
lib/aws/s3/client.rb,
lib/aws/s3/errors.rb,
lib/aws/ec2/image.rb,
lib/aws/simple_db.rb,
lib/aws/iam/group.rb,
lib/aws/sns/topic.rb,
lib/aws/dynamo_db.rb,
lib/aws/s3/bucket.rb,
lib/aws/s3/policy.rb,
lib/aws/core/data.rb,
lib/aws/sqs/queue.rb,
lib/aws/ops_works.rb,
lib/aws/ec2/region.rb,
lib/aws/iam/policy.rb,
lib/aws/s3/request.rb,
lib/aws/sns/client.rb,
lib/aws/core/model.rb,
lib/aws/emr/errors.rb,
lib/aws/iam/errors.rb,
lib/aws/sns/policy.rb,
lib/aws/emr/client.rb,
lib/aws/sqs/client.rb,
lib/aws/sqs/errors.rb,
lib/aws/sqs/policy.rb,
lib/aws/ec2/subnet.rb,
lib/aws/ec2/errors.rb,
lib/aws/sts/client.rb,
lib/aws/rds/client.rb,
lib/aws/ec2/volume.rb,
lib/aws/sts/errors.rb,
lib/aws/sts/policy.rb,
lib/aws/elb/errors.rb,
lib/aws/iam/client.rb,
lib/aws/elb/client.rb,
lib/aws/ec2/client.rb,
lib/aws/rds/errors.rb,
lib/aws/sns/errors.rb,
lib/aws/elasticache.rb,
lib/aws/cloud_front.rb,
lib/aws/core/naming.rb,
lib/aws/sts/session.rb,
lib/aws/core/policy.rb,
lib/aws/core/region.rb,
lib/aws/core/client.rb,
lib/aws/cloud_watch.rb,
lib/aws/cloud_trail.rb,
lib/aws/sns/message.rb,
lib/aws/s3/cipher_io.rb,
lib/aws/ec2/snapshot.rb,
lib/aws/auto_scaling.rb,
lib/aws/ec2/instance.rb,
lib/aws/elb/listener.rb,
lib/aws/s3/cors_rule.rb,
lib/aws/ec2/key_pair.rb,
lib/aws/record/scope.rb,
lib/aws/ec2/resource.rb,
lib/aws/record/model.rb,
lib/aws/cloud_search.rb,
lib/aws/emr/job_flow.rb,
lib/aws/s3/s3_object.rb,
lib/aws/iam/resource.rb,
lib/aws/s3/tree/node.rb,
lib/aws/record/errors.rb,
lib/aws/import_export.rb,
lib/aws/s3/client/xml.rb,
lib/aws/s3/acl_object.rb,
lib/aws/data_pipeline.rb,
lib/aws/core/xml/stub.rb,
lib/aws/glacier/vault.rb,
lib/aws/core/resource.rb,
lib/aws/record/naming.rb,
lib/aws/core/response.rb,
lib/aws/s3/presign_v4.rb,
lib/aws/iam/access_key.rb,
lib/aws/iam/collection.rb,
lib/aws/glacier/errors.rb,
lib/aws/glacier/client.rb,
lib/aws/support/errors.rb,
lib/aws/iam/mfa_device.rb,
lib/aws/ec2/attachment.rb,
lib/aws/dynamo_db/keys.rb,
lib/aws/kinesis/client.rb,
lib/aws/kinesis/errors.rb,
lib/aws/ec2/collection.rb,
lib/aws/dynamo_db/item.rb,
lib/aws/core/xml/frame.rb,
lib/aws/support/client.rb,
lib/aws/ec2/elastic_ip.rb,
lib/aws/simple_db/item.rb,
lib/aws/s3/tree/parent.rb,
lib/aws/direct_connect.rb,
lib/aws/core/endpoints.rb,
lib/aws/s3/acl_options.rb,
lib/aws/core/cacheable.rb,
lib/aws/redshift/client.rb,
lib/aws/ec2/vpn_gateway.rb,
lib/aws/redshift/errors.rb,
lib/aws/ec2/tagged_item.rb,
lib/aws/route_53/client.rb,
lib/aws/route_53/errors.rb,
lib/aws/core/collection.rb,
lib/aws/rds/db_snapshot.rb,
lib/aws/ec2/route_table.rb,
lib/aws/s3/data_options.rb,
lib/aws/cloud_formation.rb,
lib/aws/ec2/network_acl.rb,
lib/aws/core/http/patch.rb,
lib/aws/dynamo_db/types.rb,
lib/aws/simple_workflow.rb,
lib/aws/ec2/export_task.rb,
lib/aws/storage_gateway.rb,
lib/aws/rds/db_instance.rb,
lib/aws/core/inflection.rb,
lib/aws/core/uri_escape.rb,
lib/aws/core/ini_parser.rb,
lib/aws/core/meta_utils.rb,
lib/aws/core/signers/s3.rb,
lib/aws/iam/user_policy.rb,
lib/aws/glacier/archive.rb,
lib/aws/dynamo_db/table.rb,
lib/aws/core/xml/parser.rb,
lib/aws/simple_db/client.rb,
lib/aws/record/validator.rb,
lib/aws/glacier/resource.rb,
lib/aws/core/json_client.rb,
lib/aws/ops_works/client.rb,
lib/aws/dynamo_db/binary.rb,
lib/aws/auto_scaling/tag.rb,
lib/aws/ops_works/errors.rb,
lib/aws/sns/subscription.rb,
lib/aws/core/page_result.rb,
lib/aws/simple_db/errors.rb,
lib/aws/ec2/dhcp_options.rb,
lib/aws/s3/uploaded_part.rb,
lib/aws/dynamo_db/errors.rb,
lib/aws/simple_db/domain.rb,
lib/aws/core/json_parser.rb,
lib/aws/core/xml/grammar.rb,
lib/aws/dynamo_db/client.rb,
lib/aws/core/deprecations.rb,
lib/aws/elb/listener_opts.rb,
lib/aws/elb/load_balancer.rb,
lib/aws/record/hash_model.rb,
lib/aws/record/exceptions.rb,
lib/aws/core/query_client.rb,
lib/aws/iam/login_profile.rb,
lib/aws/s3/object_version.rb,
lib/aws/record/conversion.rb,
lib/aws/core/http/handler.rb,
lib/aws/cloud_watch/alarm.rb,
lib/aws/core/signers/base.rb,
lib/aws/record/attributes.rb,
lib/aws/core/http/request.rb,
lib/aws/s3/presigned_post.rb,
lib/aws/core/async_handle.rb,
lib/aws/core/managed_file.rb,
lib/aws/s3/tree/leaf_node.rb,
lib/aws/elastic_beanstalk.rb,
lib/aws/cloud_front/errors.rb,
lib/aws/cloud_front/client.rb,
lib/aws/elastic_transcoder.rb,
lib/aws/core/log_formatter.rb,
lib/aws/elasticache/client.rb,
lib/aws/cloud_watch/metric.rb,
lib/aws/elasticache/errors.rb,
lib/aws/record/validations.rb,
lib/aws/core/configuration.rb,
lib/aws/cloud_watch/errors.rb,
lib/aws/record/model/scope.rb,
lib/aws/ec2/security_group.rb,
lib/aws/cloud_trail/client.rb,
lib/aws/cloud_watch/client.rb,
lib/aws/s3/object_metadata.rb,
lib/aws/auto_scaling/group.rb,
lib/aws/emr/instance_group.rb,
lib/aws/ec2/tag_collection.rb,
lib/aws/cloud_trail/errors.rb,
lib/aws/core/http/response.rb,
lib/aws/dynamo_db/resource.rb,
lib/aws/ec2/vpn_connection.rb,
lib/aws/ec2/vpc_collection.rb,
lib/aws/core/xml/root_frame.rb,
lib/aws/auto_scaling/client.rb,
lib/aws/core/response_cache.rb,
lib/aws/simple_db/attribute.rb,
lib/aws/simple_db/item_data.rb,
lib/aws/core/resource_cache.rb,
lib/aws/dynamo_db/batch_get.rb,
lib/aws/dynamo_db/item_data.rb,
lib/aws/s3/tree/branch_node.rb,
lib/aws/s3/region_detection.rb,
lib/aws/s3/encryption_utils.rb,
lib/aws/cloud_search/errors.rb,
lib/aws/auto_scaling/errors.rb,
lib/aws/cloud_search/client.rb,
lib/aws/s3/multipart_upload.rb,
lib/aws/iam/user_collection.rb,
lib/aws/dynamo_db/client_v2.rb,
lib/aws/ec2/has_permissions.rb,
lib/aws/core/option_grammar.rb,
lib/aws/data_pipeline/client.rb,
lib/aws/ec2/image_collection.rb,
lib/aws/ec2/internet_gateway.rb,
lib/aws/core/xml/frame_stack.rb,
lib/aws/s3/bucket_collection.rb,
lib/aws/s3/object_collection.rb,
lib/aws/import_export/client.rb,
lib/aws/simple_workflow/type.rb,
lib/aws/route_53/hosted_zone.rb,
lib/aws/route_53/change_info.rb,
lib/aws/ec2/customer_gateway.rb,
lib/aws/import_export/errors.rb,
lib/aws/iam/group_collection.rb,
lib/aws/sqs/received_message.rb,
lib/aws/simple_email_service.rb,
lib/aws/sqs/queue_collection.rb,
lib/aws/sns/topic_collection.rb,
lib/aws/data_pipeline/errors.rb,
lib/aws/record/abstract_base.rb,
lib/aws/core/rest_xml_client.rb,
lib/aws/auto_scaling/activity.rb,
lib/aws/ec2/subnet_collection.rb,
lib/aws/ec2/availability_zone.rb,
lib/aws/record/dirty_tracking.rb,
lib/aws/core/rest_json_client.rb,
lib/aws/direct_connect/client.rb,
lib/aws/ec2/tagged_collection.rb,
lib/aws/ec2/volume_collection.rb,
lib/aws/direct_connect/errors.rb,
lib/aws/cloud_formation/stack.rb,
lib/aws/core/indifferent_hash.rb,
lib/aws/ec2/route_table/route.rb,
lib/aws/ec2/region_collection.rb,
lib/aws/dynamo_db/batch_write.rb,
lib/aws/auto_scaling/instance.rb,
lib/aws/ec2/network_interface.rb,
lib/aws/route_53/change_batch.rb,
lib/aws/ec2/network_acl/entry.rb,
lib/aws/simple_workflow/count.rb,
lib/aws/iam/policy_collection.rb,
lib/aws/sts/federated_session.rb,
lib/aws/core/signers/version_3.rb,
lib/aws/simple_workflow/client.rb,
lib/aws/iam/server_certificate.rb,
lib/aws/core/service_interface.rb,
lib/aws/dynamo_db/expectations.rb,
lib/aws/s3/prefixed_collection.rb,
lib/aws/core/options/validator.rb,
lib/aws/s3/bucket_region_cache.rb,
lib/aws/storage_gateway/errors.rb,
lib/aws/core/rest_error_parser.rb,
lib/aws/core/signers/version_4.rb,
lib/aws/iam/virtual_mfa_device.rb,
lib/aws/core/http/curb_handler.rb,
lib/aws/simple_workflow/errors.rb,
lib/aws/cloud_formation/errors.rb,
lib/aws/core/collection/simple.rb,
lib/aws/s3/access_control_list.rb,
lib/aws/core/region_collection.rb,
lib/aws/core/signers/version_2.rb,
lib/aws/ec2/reserved_instances.rb,
lib/aws/cloud_formation/client.rb,
lib/aws/storage_gateway/client.rb,
lib/aws/simple_workflow/domain.rb,
lib/aws/record/validators/block.rb,
lib/aws/sns/has_delivery_policy.rb,
lib/aws/emr/job_flow_collection.rb,
lib/aws/core/lazy_error_classes.rb,
lib/aws/ec2/instance_collection.rb,
lib/aws/ec2/filtered_collection.rb,
lib/aws/record/model/attributes.rb,
lib/aws/ec2/snapshot_collection.rb,
lib/aws/core/query_error_parser.rb,
lib/aws/elb/instance_collection.rb,
lib/aws/elb/listener_collection.rb,
lib/aws/s3/paginated_collection.rb,
lib/aws/iam/signing_certificate.rb,
lib/aws/ec2/key_pair_collection.rb,
lib/aws/record/hash_model/scope.rb,
lib/aws/record/validators/count.rb,
lib/aws/s3/cors_rule_collection.rb,
lib/aws/s3/website_configuration.rb,
lib/aws/glacier/vault_collection.rb,
lib/aws/s3/bucket_tag_collection.rb,
lib/aws/simple_db/put_attributes.rb,
lib/aws/core/signers/cloud_front.rb,
lib/aws/elb/load_balancer_policy.rb,
lib/aws/s3/tree/child_collection.rb,
lib/aws/record/validators/method.rb,
lib/aws/record/validators/length.rb,
lib/aws/core/xml/sax_handlers/ox.rb,
lib/aws/sqs/received_sns_message.rb,
lib/aws/elastic_beanstalk/client.rb,
lib/aws/elastic_beanstalk/errors.rb,
lib/aws/record/validators/format.rb,
lib/aws/simple_workflow/resource.rb,
lib/aws/core/json_response_parser.rb,
lib/aws/core/json_request_builder.rb,
lib/aws/core/rest_response_parser.rb,
lib/aws/core/credential_providers.rb,
lib/aws/elastic_transcoder/client.rb,
lib/aws/ec2/attachment_collection.rb,
lib/aws/core/rest_request_builder.rb,
lib/aws/ec2/permission_collection.rb,
lib/aws/elastic_transcoder/errors.rb,
lib/aws/ec2/block_device_mappings.rb,
lib/aws/dynamo_db/item_collection.rb,
lib/aws/iam/user_group_collection.rb,
lib/aws/core/http/connection_pool.rb,
lib/aws/ec2/elastic_ip_collection.rb,
lib/aws/simple_db/domain_metadata.rb,
lib/aws/iam/mfa_device_collection.rb,
lib/aws/iam/group_user_collection.rb,
lib/aws/iam/access_key_collection.rb,
lib/aws/simple_db/item_collection.rb,
lib/aws/core/query_request_builder.rb,
lib/aws/core/query_response_parser.rb,
lib/aws/auto_scaling/group_options.rb,
lib/aws/rds/db_instance_collection.rb,
lib/aws/ec2/export_task_collection.rb,
lib/aws/core/http/net_http_handler.rb,
lib/aws/rds/db_snapshot_collection.rb,
lib/aws/ec2/vpn_gateway/attachment.rb,
lib/aws/ec2/network_acl_collection.rb,
lib/aws/iam/user_policy_collection.rb,
lib/aws/ec2/route_table_collection.rb,
lib/aws/glacier/archive_collection.rb,
lib/aws/record/validators/presence.rb,
lib/aws/ec2/vpn_gateway_collection.rb,
lib/aws/dynamo_db/table_collection.rb,
lib/aws/simple_db/delete_attributes.rb,
lib/aws/simple_db/domain_collection.rb,
lib/aws/cloud_formation/stack_event.rb,
lib/aws/core/xml/sax_handlers/rexml.rb,
lib/aws/core/options/xml_serializer.rb,
lib/aws/ec2/dhcp_options_collection.rb,
lib/aws/s3/object_upload_collection.rb,
lib/aws/simple_email_service/quotas.rb,
lib/aws/sns/subscription_collection.rb,
lib/aws/s3/uploaded_part_collection.rb,
lib/aws/ec2/network_acl/association.rb,
lib/aws/auto_scaling/scaling_policy.rb,
lib/aws/ec2/resource_tag_collection.rb,
lib/aws/simple_email_service/errors.rb,
lib/aws/simple_email_service/client.rb,
lib/aws/ec2/route_table/association.rb,
lib/aws/record/model/finder_methods.rb,
lib/aws/record/validators/inclusion.rb,
lib/aws/record/validators/exclusion.rb,
lib/aws/iam/group_policy_collection.rb,
lib/aws/auto_scaling/tag_collection.rb,
lib/aws/cloud_formation/stack_output.rb,
lib/aws/iam/account_alias_collection.rb,
lib/aws/record/validators/acceptance.rb,
lib/aws/route_53/resource_record_set.rb,
lib/aws/s3/object_version_collection.rb,
lib/aws/core/xml/sax_handlers/libxml.rb,
lib/aws/elb/load_balancer_collection.rb,
lib/aws/s3/bucket_version_collection.rb,
lib/aws/ec2/vpn_connection/telemetry.rb,
lib/aws/core/options/json_serializer.rb,
lib/aws/core/signers/version_3_https.rb,
lib/aws/cloud_watch/alarm_collection.rb,
lib/aws/record/hash_model/attributes.rb,
lib/aws/ec2/vpn_connection_collection.rb,
lib/aws/simple_workflow/decision_task.rb,
lib/aws/ec2/security_group_collection.rb,
lib/aws/cloud_formation/stack_options.rb,
lib/aws/simple_workflow/activity_type.rb,
lib/aws/dynamo_db/primary_key_element.rb,
lib/aws/simple_workflow/activity_task.rb,
lib/aws/simple_workflow/workflow_type.rb,
lib/aws/emr/instance_group_collection.rb,
lib/aws/auto_scaling/scheduled_action.rb,
lib/aws/cloud_watch/metric_statistics.rb,
lib/aws/auto_scaling/group_collection.rb,
lib/aws/cloud_watch/metric_collection.rb,
lib/aws/simple_email_service/identity.rb,
lib/aws/simple_workflow/history_event.rb,
lib/aws/core/xml/sax_handlers/nokogiri.rb,
lib/aws/record/validators/numericality.rb,
lib/aws/record/validators/confirmation.rb,
lib/aws/dynamo_db/attribute_collection.rb,
lib/aws/cloud_formation/stack_resource.rb,
lib/aws/s3/multipart_upload_collection.rb,
lib/aws/cloud_watch/alarm_history_item.rb,
lib/aws/simple_db/attribute_collection.rb,
lib/aws/ec2/reserved_instances_offering.rb,
lib/aws/route_53/hosted_zone_collection.rb,
lib/aws/core/collection/with_next_token.rb,
lib/aws/simple_workflow/type_collection.rb,
lib/aws/ec2/internet_gateway_collection.rb,
lib/aws/ec2/customer_gateway_collection.rb,
lib/aws/ec2/internet_gateway/attachment.rb,
lib/aws/ec2/security_group/ip_permission.rb,
lib/aws/simple_db/consistent_read_option.rb,
lib/aws/elb/availability_zone_collection.rb,
lib/aws/auto_scaling/instance_collection.rb,
lib/aws/ec2/availability_zone_collection.rb,
lib/aws/cloud_formation/stack_collection.rb,
lib/aws/ec2/network_interface_collection.rb,
lib/aws/auto_scaling/activity_collection.rb,
lib/aws/ec2/network_interface/attachment.rb,
lib/aws/record/hash_model/finder_methods.rb,
lib/aws/ec2/reserved_instances_collection.rb,
lib/aws/iam/server_certificate_collection.rb,
lib/aws/sns/topic_subscription_collection.rb,
lib/aws/simple_workflow/option_formatters.rb,
lib/aws/simple_workflow/domain_collection.rb,
lib/aws/sns/originators/from_auto_scaling.rb,
lib/aws/iam/virtual_mfa_device_collection.rb,
lib/aws/s3/bucket_lifecycle_configuration.rb,
lib/aws/auto_scaling/launch_configuration.rb,
lib/aws/simple_db/expect_condition_option.rb,
lib/aws/iam/signing_certificate_collection.rb,
lib/aws/simple_workflow/workflow_execution.rb,
lib/aws/s3/prefix_and_delimiter_collection.rb,
lib/aws/elb/load_balancer_policy_collection.rb,
lib/aws/auto_scaling/scaling_policy_options.rb,
lib/aws/cloud_watch/metric_alarm_collection.rb,
lib/aws/elb/backend_server_policy_collection.rb,
lib/aws/auto_scaling/scaling_policy_collection.rb,
lib/aws/cloud_formation/stack_event_collection.rb,
lib/aws/auto_scaling/notification_configuration.rb,
lib/aws/route_53/resource_record_set_collection.rb,
lib/aws/simple_workflow/activity_task_collection.rb,
lib/aws/simple_workflow/activity_type_collection.rb,
lib/aws/glacier/vault_notification_configuration.rb,
lib/aws/cloud_formation/stack_summary_collection.rb,
lib/aws/simple_workflow/workflow_type_collection.rb,
lib/aws/simple_workflow/decision_task_collection.rb,
lib/aws/auto_scaling/scheduled_action_collection.rb,
lib/aws/simple_email_service/identity_collection.rb,
lib/aws/simple_workflow/history_event_collection.rb,
lib/aws/core/collection/with_limit_and_next_token.rb,
lib/aws/cloud_formation/stack_resource_collection.rb,
lib/aws/cloud_watch/alarm_history_item_collection.rb,
lib/aws/core/signers/version_4/chunk_signed_stream.rb,
lib/aws/ec2/reserved_instances_offering_collection.rb,
lib/aws/ec2/security_group/ip_permission_collection.rb,
lib/aws/auto_scaling/launch_configuration_collection.rb,
lib/aws/simple_email_service/email_address_collection.rb,
lib/aws/simple_workflow/workflow_execution_collection.rb,
lib/aws/cloud_formation/stack_resource_summary_collection.rb,
lib/aws/auto_scaling/notification_configuration_collection.rb

Overview

Copyright 2011-2013 Amazon.com, Inc. or its affiliates. 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. A copy of the License is located at

http://aws.amazon.com/apache2.0/

or in the "license" file accompanying this file. This file 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.

Defined Under Namespace

Modules: Core, Errors, Rails, Record Classes: AutoScaling, CloudFormation, CloudFront, CloudSearch, CloudTrail, CloudWatch, DataPipeline, DirectConnect, DynamoDB, EC2, ELB, EMR, ElastiCache, ElasticBeanstalk, ElasticTranscoder, Glacier, IAM, ImportExport, Kinesis, OpsWorks, RDS, Redshift, Route53, S3, SNS, SQS, STS, SimpleDB, SimpleEmailService, SimpleWorkflow, StorageGateway, Support

Constant Summary

SRC =
ROOT + '/lib/aws'
VERSION =

Current version of the AWS SDK for Ruby

'1.66.0'

Class Method Summary collapse

Class Method Details

.config(options = {}) ⇒ Core::Configuration

Note:

Changing the global configuration does not affect objects that have already been constructed.

The global configuration for AWS. Generally you set your preferred configuration operations once after loading the aws-sdk gem.

AWS.config({
  :access_key_id => 'ACCESS_KEY_ID',
  :secret_access_key => 'SECRET_ACCESS_KEY',
  :region => 'us-west-2',
})

When using AWS classes they will always default to use configuration values defined in config.

AWS.config(:max_retries => 2)

sqs = AWS::SQS.new
sqs.config.max_retries #=> 2

If you want to change a configuration value for a single instance you pass the new configuration value to that object's initializer:

AWS::SQS.new(:max_retries => 0)

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :access_key_id (String)

    AWS access key id credential.

  • :secret_access_key (String)

    AWS secret access key credential.

  • :session_token (String, nil)

    AWS secret token credential.

  • :region (String) — default: 'us-east-1'

    The default AWS region.

  • :dynamo_db_big_decimals (Boolean) — default: true

    When true, DynamoDB will convert number values returned by AWS::DynamoDB::Client from strings to BigDecimal objects. If you set this to false, they will be converted from strings into floats (with a potential loss of precision).

  • :dynamo_db_retry_throughput_errors (Boolean) — default: true

    When true, AWS::DynamoDB::Errors::ProvisionedThroughputExceededException errors will be retried.

  • :http_handler (Object) — default: AWS::Core::Http::NetHttpHandler

    The http handler that sends requests to AWS.

  • :http_idle_timeout (Integer) — default: 60

    The number of seconds a persistent connection is allowed to sit idle before it should no longer be used.

  • :http_open_timeout (Integer) — default: 15

    The number of seconds before the :http_handler should timeout while trying to open a new HTTP session.

  • :http_read_timeout (Integer) — default: 60

    The number of seconds before the :http_handler should timeout while waiting for a HTTP response.

  • :http_wire_trace (Boolean) — default: false

    When true, the http handler will log all wire traces to the :logger. If a :logger is not configured, then wire traces will be sent to standard out.

  • :logger (Logger, nil) — default: nil

    A logger to send log messages to. Here is an example that logs to standard out.

    require 'logger'
    AWS.config(:logger => Logger.new($stdout))
    
  • :log_level (Symbol) — default: :info

    The level log messages are sent to the logger with (e.g. :notice, :info, :warn, :debug, etc).

  • :log_formatter (Object)

    The log formatter is responsible for building log messages from responses. You can quickly change log formats by providing a pre-configured log formatter.

    AWS.config(:log_formatter => AWS::Core::LogFormatter.colored)
    

    Here is a list of pre-configured log formatters:

    • AWS::Core::LogFormatter.default
    • AWS::Core::LogFormatter.short
    • AWS::Core::LogFormatter.debug
    • AWS::Core::LogFormatter.colored

    You can also create an instance of AWS::Core::LogFormatter with a custom log message pattern. See AWS::Core::LogFormatter for a complete list of pattern substitutions.

    pattern = "[AWS :operation :duration] :error_message"
    AWS.config(:log_formatter => AWS::Core::LogFormatter.new(pattern))
    

    Lastly you can pass any object that responds to #format accepting and instance of AWS::Core::Response and returns a string.

  • :max_retries (Integer) — default: 3

    The maximum number of times service errors (500) and throttling errors should be retried. There is an exponential backoff in between retries, so the more retries the longer it can take to fail.

  • :proxy_uri (String, URI, nil) — default: nil

    The URI of the proxy to send service requests through. You can pass a URI object or a URI string:

    AWS.config(:proxy_uri => 'https://user:password@my.proxy:443/path?query')
    
  • :s3_force_path_style (Boolean) — default: false

    When true, requests will always use path style. This can be useful for testing environments.

  • :s3_multipart_max_parts (Integer) — default: 10000

    The maximum number of parts to split a file into when uploading in parts to S3.

  • :s3_multipart_threshold (Integer) — default: 16777216

    When uploading data to S3, if the number of bytes to send exceeds :s3_multipart_threshold then a multi part session is automatically started and the data is sent up in chunks. The size of each part is specified by :s3_multipart_min_part_size. Defaults to 16777216 (16MB).

  • :s3_multipart_min_part_size (Integer) — default: 5242880

    The absolute minimum size (in bytes) each S3 multipart segment should be. Defaults to 5242880 (5MB).

  • :s3_server_side_encryption (Symbol) — default: nil

    The algorithm to use when encrypting object data on the server side. The only valid value is :aes256, which specifies that the object should be stored using the AES encryption algorithm with 256 bit keys. Defaults to nil, meaning server side encryption is not used unless specified on each individual call to upload an object. This option controls the default behavior for the following methods:

  • :s3_encryption_key (OpenSSL::PKey::RSA, String) — default: nil

    If this is set, AWS::S3::S3Object #read and #write methods will always perform client-side encryption with this key. The key can be overridden at runtime by using the :encryption_key option. A value of nil means that client-side encryption will not be used.

  • :s3_encryption_materials_location (Symbol) — default: :metadata

    When set to :instruction_file, AWS::S3::S3Object will store encryption materials in a separate object, instead of the object metadata.

  • :simple_db_consistent_reads (Boolean) — default: false

    Determines if all SimpleDB read requests should be done consistently. Consistent reads are slower, but reflect all changes to SDB.

  • :credential_provider (CredentialProviders::Provider) — default: AWS::Core::CredentialProviders::DefaultProvider.new

    Returns the credential provider. The default credential provider attempts to check for statically assigned credentials, ENV credentials and credentials in the metadata service of EC2.

  • :ssl_ca_file (String)

    The path to a CA cert bundle in PEM format.

    If :ssl_verify_peer is true (the default) this bundle will be used to validate the server certificate in each HTTPS request. The AWS SDK for Ruby ships with a CA cert bundle, which is the default value for this option.

  • :ssl_ca_path (String) — default: nil

    The path the a CA cert directory.

  • :ssl_verify_peer (Boolean) — default: true

    When true the HTTP handler validate server certificates for HTTPS requests.

    This option should only be disabled for diagnostic purposes; leaving this option set to false exposes your application to man-in-the-middle attacks and can pose a serious security risk.

  • :stub_requests (Boolean) — default: false

    When true requests are not sent to AWS, instead empty responses are generated and returned to each service request.

  • :use_ssl (Boolean) — default: true

    When true, all requests to AWS are sent using HTTPS instead vanilla HTTP.

  • :user_agent_prefix (String) — default: nil

    A string prefix to append to all requests against AWS services. This should be set for clients and applications built ontop of the aws-sdk gem.

  • :verify_response_body_content_length (Boolean) — default: true

    When true all HTTP handlers will perform a check to ensure that response bodies match the content-length specified in the response header, if present. Note that some HTTP handlers will always do this whether or not this value is true.

  • :sqs_verify_checksums (Boolean) — default: true

    When true all SQS operations will check body content against MD5 checksums, raising an exception if there is a mismatch.

Returns:



470
471
472
473
474
# File 'lib/aws/core.rb', line 470

def config options = {}
  @@config ||= Core::Configuration.new
  @@config = @@config.with(options) unless options.empty?
  @@config
end

.eager_autoload!(klass_or_module = AWS, visited = Set.new) ⇒ void

This method returns an undefined value.

Eagerly loads all AWS classes/modules registered with autoload.



631
632
633
634
635
636
637
638
639
640
641
642
643
644
# File 'lib/aws/core.rb', line 631

def eager_autoload! klass_or_module = AWS, visited = Set.new
  klass_or_module.constants.each do |const_name|
    path = klass_or_module.autoload?(const_name)
    require(path) if path
    const = klass_or_module.const_get(const_name)
    if const.is_a?(Module)
      unless visited.include?(const)
        visited << const
        eager_autoload!(const, visited)
      end
    end
  end
  visited
end

.memoizeObject

Note:

Memoization is currently only supported for APIs which inherit from the "Resource" class; other APIs are unaffected by the status of memoization.

Enables memoization for the current thread, within a block. Memoization lets you avoid making multiple requests for the same data by reusing the responses which have already been received. For example, consider the following code to get the most recently launched EC2 instance:

latest = ec2.instances.sort_by(&:launch_time).last

The above code would make N+1 requests (where N is the number of instances in the account); iterating the collection of instances is one request, and Enumerable#sort_by calls AWS::EC2::Instance#launch_time for each instance, causing another request per instance. We can rewrite the code as follows to make only one request:

latest = AWS.memoize do
  ec2.instances.sort_by(&:launch_time).last
end

Iterating the collection still causes a request, but each subsequent call to AWS::EC2::Instance#launch_time uses the results from that first request rather than making a new request for the same data.

While memoization is enabled, every response that is received from the service is retained in memory. Therefore you should use memoization only for short-lived blocks of code that make relatively small numbers of requests. The cached responses are used in two ways while memoization is enabled:

  • Before making a request, the SDK checks the cache for a response to a request with the same signature (credentials, service endpoint, operation name, and parameters). If such a response is found, it is used instead of making a new request.

  • Before retrieving data for an attribute of a resource (e.g. AWS::EC2::Instance#launch_time), the SDK attempts to find a cached response that contains the requested data. If such a response is found, the cached data is returned instead of making a new request.

When memoization is disabled, all previously cached responses are discarded.



594
595
596
597
598
599
600
601
602
# File 'lib/aws/core.rb', line 594

def memoize
  return yield if memoizing?
  begin
    start_memoizing
    yield if block_given?
  ensure
    stop_memoizing
  end
end

.memoizing?Boolean

Note:

Memoization is currently only supported for APIs which inherit from the "Resource" class; other APIs are unaffected by the status of memoization.

Returns True if memoization is enabled for the current thread. See memoize for a full discussion of the memoization feature.

Returns:

  • (Boolean)

    True if memoization is enabled for the current thread. See memoize for a full discussion of the memoization feature.



542
543
544
# File 'lib/aws/core.rb', line 542

def memoizing?
  !Thread.current[:aws_memoization].nil?
end

.regionsCore::RegionCollection

Returns a collection that represents public (non-gov-cloud) AWS regions. You can use this collection to get a specific region by name or to enumerate all regions.

When enumerating regions, a single HTTP request is made to get a current list of regions (this is cached). When getting a region by name no requests are made.

Examples:

Getting a region by name


region = AWS.regions['us-west-1']
region.dynamo_db.tables.map(&:name)

Enumerating all regions


AWS.regions.each do |region|
  puts "EC2 Instances in #{region.name}:"
  puts region.ec2.instances.map(&:id)
end

Returns:



497
498
499
# File 'lib/aws/core.rb', line 497

def regions
  Core::RegionCollection.new
end

.reset_memoizationObject

Note:

Memoization is currently only supported for APIs which inherit from the "Resource" class; other APIs are unaffected by the status of memoization.

Resets memoizing service requests made in the current thread. See memoize for a full discussion of the memoization feature. This has no effect if memoization is already enabled.



508
509
510
# File 'lib/aws/core.rb', line 508

def reset_memoization
  Thread.current[:aws_memoization] = {}
end

.start_memoizingObject

Note:

Memoization is currently only supported for APIs which inherit from the "Resource" class; other APIs are unaffected by the status of memoization.

Starts memoizing service requests made in the current thread. See memoize for a full discussion of the memoization feature. This has no effect if memoization is already enabled.



519
520
521
522
# File 'lib/aws/core.rb', line 519

def start_memoizing
  Thread.current[:aws_memoization] ||= {}
  nil
end

.stop_memoizingObject

Note:

Memoization is currently only supported for APIs which inherit from the "Resource" class; other APIs are unaffected by the status of memoization.

Stops memoizing service requests made in the current thread. See memoize for a full discussion of the memoization feature. This has no effect if memoization is already disabled.



531
532
533
# File 'lib/aws/core.rb', line 531

def stop_memoizing
  Thread.current[:aws_memoization] = nil
end

.stub!nil

Causes all requests to return empty responses without making any requests against the live services. This does not attempt to mock the services.

Returns:

  • (nil)


624
625
626
627
# File 'lib/aws/core.rb', line 624

def stub!
  config(:stub_requests => true)
  nil
end