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

Class: AWS::CloudSearch

Inherits:
Object
  • Object
show all
Includes:
AWS::Core::ServiceInterface
Defined in:
lib/aws/cloud_search.rb,
lib/aws/cloud_search/client.rb,
lib/aws/cloud_search/errors.rb

Overview

This class is the starting point for working with Amazon CloudSearch.

To use Amazon CloudSearch you must first sign up here.

For more information about Amazon CloudSearch:

Credentials

You can setup default credentials for all AWS services via AWS.config:

AWS.config(
  :access_key_id => 'YOUR_ACCESS_KEY_ID',
  :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')

Or you can set them directly on the AWS::CloudSearch interface:

cs = AWS::CloudSearch.new(
  :access_key_id => 'YOUR_ACCESS_KEY_ID',
  :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')

Using the Client

AWS::CloudSearch does not provide higher level abstractions for CloudSearch at this time. You can still access all of the API methods using Client. Here is how you access the client and make a simple request:

cs = AWS::CloudSearch.new

resp = cs.client.describe_domains
resp[:domain_status_list].each do |domain|
  puts domain[:domain_id]
end

See Client for documentation on all of the supported operations.

Defined Under Namespace

Modules: Errors Classes: Client

Instance Attribute Summary collapse

Method Summary

Methods included from AWS::Core::ServiceInterface

included, #initialize, #inspect

Instance Attribute Details

#client ⇒ Client (readonly)

Returns the low-level CloudSearch client object

Returns:

  • (Client) —

    the low-level CloudSearch client object



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/aws/cloud_search.rb', line 62

class CloudSearch

  autoload :Client, 'aws/cloud_search/client'
  autoload :Errors, 'aws/cloud_search/errors'

  include Core::ServiceInterface

  endpoint_prefix 'cloudsearch'

end