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

Module: Aws::DocDB

Defined in:
(unknown)

Overview

This module provides a client for making API requests to Amazon DocumentDB with MongoDB compatibility.

Aws::DocDB::Client

The Client class provides one-to-one mapping for each API operation.

docdb = Aws::DocDB::Client.new(region: 'us-east-1')
docdb.operation_names
#=> [:add_tags_to_resource, :apply_pending_maintenance_action, :copy_db_cluster_parameter_group, :copy_db_cluster_snapshot, ...]

Each API operation method accepts a hash of request parameters and returns a response object.

resp = docdb.add_tags_to_resource(params)

See Client for more information.

Aws::DocDB::Errors

Errors returned from Amazon DocumentDB with MongoDB compatibility are defined in the Errors module and extend Errors::ServiceError.

begin
  # do stuff
rescue Aws::DocDB::Errors::ServiceError
  # rescues all errors returned by Amazon DocumentDB with MongoDB compatibility
end

See Errors for more information.

Defined Under Namespace

Modules: Errors, Types Classes: Client