Amazon CloudSearch¶

Description¶

Amazon CloudSearch Configuration Service

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see htmllist("")Regions and Endpointshtmllist("").

Usage¶

cloudsearch(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- cloudsearch(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`build_suggesters`	Indexes the search suggestions
`create_domain`	Creates a new search domain
`define_analysis_scheme`	Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options
`define_expression`	Configures an Expression for the search domain
`define_index_field`	Configures an IndexField for the search domain
`define_suggester`	Configures a suggester for a domain
`delete_analysis_scheme`	Deletes an analysis scheme
`delete_domain`	Permanently deletes a search domain and all of its data
`delete_expression`	Removes an Expression from the search domain
`delete_index_field`	Removes an IndexField from the search domain
`delete_suggester`	Deletes a suggester
`describe_analysis_schemes`	Gets the analysis schemes configured for a domain
`describe_availability_options`	Gets the availability options configured for a domain
`describe_domain_endpoint_options`	Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS
`describe_domains`	Gets information about the search domains owned by this account
`describe_expressions`	Gets the expressions configured for the search domain
`describe_index_fields`	Gets information about the index fields configured for the search domain
`describe_scaling_parameters`	Gets the scaling parameters configured for a domain
`describe_service_access_policies`	Gets information about the access policies that control access to the domain's document and search endpoints
`describe_suggesters`	Gets the suggesters configured for a domain
`index_documents`	Tells the search domain to start indexing its documents using the latest indexing options
`list_domain_names`	Lists all search domains owned by an account
`update_availability_options`	Configures the availability options for a domain
`update_domain_endpoint_options`	Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS
`update_scaling_parameters`	Configures scaling parameters for a domain
`update_service_access_policies`	Configures the access rules that control access to the domain's document and search endpoints

Examples¶

svc <- cloudsearch()
svc$build_suggesters(
  Foo = 123
)