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

Module: Aws

Defined in:
gems/aws-sdk-resources/lib/aws-sdk-resources.rb,
gems/aws-sdk-core/lib/aws-sdk-core/xml/parser/frame.rb,
gems/aws-sdk-core/lib/aws-sdk-core/xml/parser/stack.rb,
gems/aws-sdk-core/lib/aws-sdk-core/rest/request/body.rb,
gems/aws-sdk-core/lib/aws-sdk-core/rest/response/body.rb,
gems/aws-sdk-core/lib/aws-sdk-core/rest/request/builder.rb,
gems/aws-sdk-core/lib/aws-sdk-core/rest/request/headers.rb,
gems/aws-sdk-core/lib/aws-sdk-core/rest/response/parser.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/protocols/ec2.rb,
gems/aws-sdk-core/lib/aws-sdk-core/rest/request/endpoint.rb,
gems/aws-sdk-core/lib/aws-sdk-core/rest/response/headers.rb,
gems/aws-sdk-core/lib/aws-sdk-core/stubbing/protocols/ec2.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/protocols/query.rb,
gems/aws-sdk-core/lib/aws-sdk-core/stubbing/protocols/json.rb,
gems/aws-sdk-core/lib/aws-sdk-core/stubbing/protocols/rest.rb,
gems/aws-sdk-core/lib/aws-sdk-core/stubbing/protocols/query.rb,
gems/aws-sdk-core/lib/aws-sdk-core/xml/parser/parsing_error.rb,
gems/aws-sdk-core/lib/aws-sdk-core/rest/response/status_code.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/protocols/json_rpc.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/protocols/rest_xml.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/protocols/rest_json.rb,
gems/aws-sdk-core/lib/aws-sdk-core/stubbing/protocols/rest_xml.rb,
gems/aws-sdk-core/lib/aws-sdk-core/stubbing/protocols/rest_json.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/protocols/api_gateway.rb,
gems/aws-sdk-core/lib/aws-sdk-core/stubbing/protocols/api_gateway.rb,
gems/aws-sdk-core/lib/aws-sdk-core/rest/request/querystring_builder.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/md5s.rb,
gems/aws-sdk-core/lib/aws-sdk-core/xml/parser.rb,
gems/aws-sdk-sqs/lib/aws-sdk-sqs/plugins/md5s.rb,
gems/aws-sdk-core/lib/aws-sdk-core/json/parser.rb,
gems/aws-sdk-core/lib/aws-sdk-core/query/param.rb,
gems/aws-sdk-core/lib/aws-sdk-core/xml/builder.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/sse_cpk.rb,
gems/aws-sdk-core/lib/aws-sdk-core/json/builder.rb,
gems/aws-sdk-core/lib/aws-sdk-core/json/handler.rb,
gems/aws-sdk-core/lib/aws-sdk-core/rest/handler.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/utils.rb,
gems/aws-sdk-core/lib/aws-sdk-core/log/formatter.rb,
gems/aws-sdk-core/lib/aws-sdk-core/query/handler.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/client.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/errors.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/dualstack.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/redirects.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/s3_signer.rb,
gems/aws-sdk-core/lib/aws-sdk-core/json/oj_engine.rb,
gems/aws-sdk-core/lib/aws-sdk-core/waiters/errors.rb,
gems/aws-sdk-core/lib/aws-sdk-core/waiters/poller.rb,
gems/aws-sdk-core/lib/aws-sdk-core/waiters/waiter.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/accelerate.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/bucket_dns.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/s3_host_id.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/api_key.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/logging.rb,
gems/aws-sdk-core/lib/aws-sdk-core/xml/default_map.rb,
gems/aws-sdk-core/lib/aws-sdk-core/xml/doc_builder.rb,
gems/aws-sdk-core/lib/aws-sdk-core/json/json_engine.rb,
gems/aws-sdk-core/lib/aws-sdk-core/log/param_filter.rb,
gems/aws-sdk-core/lib/aws-sdk-core/query/param_list.rb,
gems/aws-sdk-core/lib/aws-sdk-core/xml/default_list.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/materials.rb,
gems/aws-sdk-sqs/lib/aws-sdk-sqs/plugins/queue_urls.rb,
gems/aws-sdk-core/lib/aws-sdk-core/xml/error_handler.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/bucket.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object.rb,
gems/aws-sdk-core/lib/aws-sdk-core/json/error_handler.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/user_agent.rb,
gems/aws-sdk-core/lib/aws-sdk-core/stubbing/stub_data.rb,
gems/aws-sdk-core/lib/aws-sdk-core/stubbing/xml_error.rb,
gems/aws-sdk-core/lib/aws-sdk-core/binary/event_parser.rb,
gems/aws-sdk-core/lib/aws-sdk-core/log/param_formatter.rb,
gems/aws-sdk-core/lib/aws-sdk-core/query/param_builder.rb,
gems/aws-sdk-core/lib/aws-sdk-core/stubbing/empty_stub.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/io_decrypter.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/io_encrypter.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/key_provider.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/http_200_errors.rb,
gems/aws-sdk-swf/lib/aws-sdk-swf/plugins/read_timeouts.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/retry_errors.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/signature_v2.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/signature_v4.rb,
gems/aws-sdk-core/lib/aws-sdk-core/resources/collection.rb,
gems/aws-sdk-route53/lib/aws-sdk-route53/plugins/id_fix.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/url_encoded_keys.rb,
gems/aws-sdk-core/lib/aws-sdk-core/binary/decode_handler.rb,
gems/aws-sdk-ec2/lib/aws-sdk-ec2/customizations/instance.rb,
gems/aws-sdk-ec2/lib/aws-sdk-ec2/customizations/resource.rb,
gems/aws-sdk-iam/lib/aws-sdk-iam/customizations/resource.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/stub_responses.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/decrypt_handler.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/encrypt_handler.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/apig_user_agent.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/param_converter.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/param_validator.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/response_paging.rb,
gems/aws-sdk-core/lib/aws-sdk-core/query/ec2_param_builder.rb,
gems/aws-sdk-ec2/lib/aws-sdk-ec2/plugins/region_validation.rb,
gems/aws-sdk-glacier/lib/aws-sdk-glacier/plugins/checksums.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/expect_100_continue.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/location_constraint.rb,
gems/aws-sdk-core/lib/aws-sdk-core/stubbing/data_applicator.rb,
gems/aws-sdk-glacier/lib/aws-sdk-glacier/plugins/account_id.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/io_auth_decrypter.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/idempotency_token.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/regional_endpoint.rb,
gems/aws-sdk-glacier/lib/aws-sdk-glacier/plugins/api_version.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb,
gems/aws-sdk-rds/lib/aws-sdk-rds/plugins/cross_region_copying.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/kms_cipher_provider.rb,
gems/aws-sdk-core/lib/aws-sdk-core/binary/event_stream_decoder.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/jsonvalue_converter.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/multipart_upload.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/default_key_provider.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/get_bucket_location_fix.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/global_configuration.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/bucket_name_restrictions.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/apig_authorizer_token.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/helpful_socket_errors.rb,
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/customizations/client.rb,
gems/aws-sdk-ec2/lib/aws-sdk-ec2/plugins/copy_encrypted_snapshot.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/default_cipher_provider.rb,
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/plugins/crc32_validation.rb,
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/plugins/extended_retries.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/credentials_configuration.rb,
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/plugins/simple_attributes.rb,
gems/aws-sdk-rds/lib/aws-sdk-rds/customizations/auth_token_generator.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/event_stream_configuration.rb,
gems/aws-sdk-core/lib/aws-sdk-core/plugins/apig_credentials_configuration.rb,
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/plugins/apply_content_type_header.rb,
gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/plugins/predict_endpoint.rb,
gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/plugins/switch_to_post.rb,
gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/plugins/conditional_signing.rb,
gems/aws-sigv2/lib/aws-sigv2/signer.rb,
gems/aws-sigv4/lib/aws-sigv4/errors.rb,
gems/aws-sigv4/lib/aws-sigv4/signer.rb,
gems/aws-sigv4/lib/aws-sigv4/request.rb,
gems/aws-sigv4/lib/aws-sigv4/signature.rb,
gems/aws-sdk-core/lib/aws-sdk-core/json.rb,
gems/aws-sdk-core/lib/aws-sdk-core/util.rb,
gems/aws-sdk-core/lib/aws-sdk-core/pager.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/file_part.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/presigner.rb,
gems/aws-sigv2/lib/aws-sigv2/credentials.rb,
gems/aws-sigv4/lib/aws-sigv4/credentials.rb,
gems/aws-sdk-core/lib/aws-sdk-core/errors.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption.rb,
gems/aws-sdk-core/lib/aws-sdk-core/structure.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/file_uploader.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/legacy_signer.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/object_copier.rb,
gems/aws-partitions/lib/aws-partitions/region.rb,
gems/aws-sdk-core/lib/aws-sdk-core/ini_parser.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/presigned_post.rb,
gems/aws-sdk-sqs/lib/aws-sdk-sqs/queue_poller.rb,
gems/aws-eventstream/lib/aws-eventstream/types.rb,
gems/aws-partitions/lib/aws-partitions/service.rb,
gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb,
gems/aws-sdk-polly/lib/aws-sdk-polly/presigner.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/file_downloader.rb,
gems/aws-eventstream/lib/aws-eventstream/errors.rb,
gems/aws-sdk-core/lib/aws-sdk-core/client_stubs.rb,
gems/aws-sdk-core/lib/aws-sdk-core/deprecations.rb,
gems/aws-sdk-core/lib/aws-sdk-core/eager_loader.rb,
gems/aws-sdk-core/lib/aws-sdk-core/type_builder.rb,
gems/aws-eventstream/lib/aws-eventstream/decoder.rb,
gems/aws-eventstream/lib/aws-eventstream/encoder.rb,
gems/aws-eventstream/lib/aws-eventstream/message.rb,
gems/aws-partitions/lib/aws-partitions/partition.rb,
gems/aws-sdk-core/lib/aws-sdk-core/event_emitter.rb,
gems/aws-sdk-core/lib/aws-sdk-core/shared_config.rb,
gems/aws-sdk-sns/lib/aws-sdk-sns/message_verifier.rb,
gems/aws-sdk-core/lib/aws-sdk-core/ecs_credentials.rb,
gems/aws-sdk-core/lib/aws-sdk-core/param_converter.rb,
gems/aws-sdk-core/lib/aws-sdk-core/param_validator.rb,
gems/aws-sdk-glacier/lib/aws-sdk-glacier/tree_hash.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_region_cache.rb,
gems/aws-sdk-core/lib/aws-sdk-core/pageable_response.rb,
gems/aws-eventstream/lib/aws-eventstream/bytes_buffer.rb,
gems/aws-eventstream/lib/aws-eventstream/header_value.rb,
gems/aws-partitions/lib/aws-partitions/partition_list.rb,
gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/signer.rb,
gems/aws-sdk-core/lib/aws-sdk-core/shared_credentials.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_error.rb,
gems/aws-sdk-core/lib/aws-sdk-core/credential_provider.rb,
gems/aws-sdk-core/lib/aws-sdk-core/process_credentials.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_file_uploader.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/object_multipart_copier.rb,
gems/aws-partitions/lib/aws-partitions/endpoint_provider.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_stream_uploader.rb,
gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/url_signer.rb,
gems/aws-sdk-core/lib/aws-sdk-core/refreshing_credentials.rb,
gems/aws-sdk-core/lib/aws-sdk-core/assume_role_credentials.rb,
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/attribute_value.rb,
gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/cookie_signer.rb,
gems/aws-sdk-core/lib/aws-sdk-core/credential_provider_chain.rb,
gems/aws-sdk-core/lib/aws-sdk-core/instance_profile_credentials.rb,
gems/aws-sigv2/lib/aws-sigv2.rb,
gems/aws-sdk-core/lib/aws-sdk-core.rb,
gems/aws-partitions/lib/aws-partitions.rb

Overview

Aws module documentation.

Defined Under Namespace

Modules: ACM, ACMPCA, APIGateway, AlexaForBusiness, AppStream, AppSync, ApplicationAutoScaling, ApplicationDiscoveryService, Athena, AutoScaling, AutoScalingPlans, Batch, Binary, Budgets, ClientStubs, Cloud9, CloudDirectory, CloudFormation, CloudFront, CloudHSM, CloudHSMV2, CloudSearch, CloudSearchDomain, CloudTrail, CloudWatch, CloudWatchEvents, CloudWatchLogs, CodeBuild, CodeCommit, CodeDeploy, CodePipeline, CodeStar, CognitoIdentity, CognitoIdentityProvider, CognitoSync, Comprehend, ConfigService, Connect, CostExplorer, CostandUsageReportService, CredentialProvider, DAX, DLM, DataPipeline, DatabaseMigrationService, DeviceFarm, DirectConnect, DirectoryService, DynamoDB, DynamoDBStreams, EC2, ECR, ECS, EFS, EKS, EMR, ElastiCache, ElasticBeanstalk, ElasticLoadBalancing, ElasticLoadBalancingV2, ElasticTranscoder, ElasticsearchService, Errors, EventStream, FMS, Firehose, GameLift, Glacier, Glue, Greengrass, GuardDuty, Health, IAM, ImportExport, Inspector, IoT, IoT1ClickDevicesService, IoT1ClickProjects, IoTAnalytics, IoTDataPlane, IoTJobsDataPlane, KMS, Kinesis, KinesisAnalytics, KinesisVideo, KinesisVideoArchivedMedia, KinesisVideoMedia, Lambda, LambdaPreview, Lex, LexModelBuildingService, LexRuntimeService, Lightsail, Log, MQ, MTurk, MachineLearning, Macie, MarketplaceCommerceAnalytics, MarketplaceEntitlementService, MarketplaceMetering, MediaConvert, MediaLive, MediaPackage, MediaStore, MediaStoreData, MediaTailor, MigrationHub, Mobile, Neptune, OpsWorks, OpsWorksCM, Organizations, PI, PageableResponse, Partitions, Pinpoint, Polly, Pricing, RDS, Redshift, Rekognition, ResourceGroups, ResourceGroupsTaggingAPI, Resources, Route53, Route53Domains, S3, SES, SFN, SMS, SNS, SQS, SSM, STS, SWF, SageMaker, SageMakerRuntime, SecretsManager, ServerlessApplicationRepository, ServiceCatalog, ServiceDiscovery, Shield, Sigv2, Sigv4, SimpleDB, Snowball, States, StorageGateway, Support, TranscribeService, Translate, WAF, WAFRegional, Waiters, WorkDocs, WorkMail, WorkSpaces, XRay Classes: AssumeRoleCredentials, Credentials, ECSCredentials, EventEmitter, InstanceProfileCredentials, ProcessCredentials, SharedCredentials

Constant Summary

CORE_GEM_VERSION =
File.read(File.expand_path('../../VERSION', __FILE__)).strip

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configHash

Returns a hash of default configuration options shared by all constructed clients.

Returns:

  • (Hash)

    Returns a hash of default configuration options shared by all constructed clients.



90
91
92
# File 'gems/aws-sdk-core/lib/aws-sdk-core.rb', line 90

def config
  @config
end

Class Method Details

.empty_connection_pools!nil

Close any long-lived connections maintained by the SDK's internal connection pool.

Applications that rely heavily on the fork() system call on POSIX systems should call this method in the child process directly after fork to ensure there are no race conditions between the parent process and its children for the pooled TCP connections.

Child processes that make multi-threaded calls to the SDK should block on this call before beginning work.

Returns:

  • (nil)


145
146
147
148
149
# File 'gems/aws-sdk-core/lib/aws-sdk-core.rb', line 145

def empty_connection_pools!
  Seahorse::Client::NetHttp::ConnectionPool.pools.each do |pool|
    pool.empty!
  end
end

.partition(partition_name) ⇒ Object

See Also:

  • (Aws(Aws::Partitions(Aws::Partitions.partition)


102
103
104
# File 'gems/aws-sdk-core/lib/aws-sdk-core.rb', line 102

def partition(partition_name)
  Aws::Partitions.partition(partition_name)
end

.partitionsObject

See Also:

  • (Aws(Aws::Partitions(Aws::Partitions.partitions)


107
108
109
# File 'gems/aws-sdk-core/lib/aws-sdk-core.rb', line 107

def partitions
  Aws::Partitions.partitions
end

.use_bundled_cert!String

The SDK ships with a ca certificate bundle to use when verifying SSL peer certificates. By default, this cert bundle is NOT used. The SDK will rely on the default cert available to OpenSSL. This ensures the cert provided by your OS is used.

For cases where the default cert is unavailable, e.g. Windows, you can call this method.

Aws.use_bundled_cert!

Returns:

  • (String)

    Returns the path to the bundled cert.



122
123
124
125
126
127
128
129
130
# File 'gems/aws-sdk-core/lib/aws-sdk-core.rb', line 122

def use_bundled_cert!
  config.delete(:ssl_ca_directory)
  config.delete(:ssl_ca_store)
  config[:ssl_ca_bundle] = File.expand_path(File.join(
    File.dirname(__FILE__),
    '..',
    'ca-bundle.crt'
  ))
end