cloudsearchdomain: Amazon CloudSearch Domain

Description Usage Arguments Service syntax Operations Examples

View source: R/cloudsearchdomain_service.R

Description

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.

The endpoints for submitting upload_documents, search, and suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.

For more information, see the Amazon CloudSearch Developer Guide.

Usage

1
cloudsearchdomain(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- cloudsearchdomain(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

search Retrieves a list of documents that match the specified search criteria
suggest Retrieves autocomplete suggestions for a partial query string
upload_documents Posts a batch of documents to a search domain for indexing

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- cloudsearchdomain()
svc$search(
  Foo = 123
)

## End(Not run)

paws.analytics documentation built on March 8, 2021, 1:10 a.m.