R/cloudsearch_operations.R

Defines functions cloudsearch_update_service_access_policies cloudsearch_update_scaling_parameters cloudsearch_update_domain_endpoint_options cloudsearch_update_availability_options cloudsearch_list_domain_names cloudsearch_index_documents cloudsearch_describe_suggesters cloudsearch_describe_service_access_policies cloudsearch_describe_scaling_parameters cloudsearch_describe_index_fields cloudsearch_describe_expressions cloudsearch_describe_domains cloudsearch_describe_domain_endpoint_options cloudsearch_describe_availability_options cloudsearch_describe_analysis_schemes cloudsearch_delete_suggester cloudsearch_delete_index_field cloudsearch_delete_expression cloudsearch_delete_domain cloudsearch_delete_analysis_scheme cloudsearch_define_suggester cloudsearch_define_index_field cloudsearch_define_expression cloudsearch_define_analysis_scheme cloudsearch_create_domain cloudsearch_build_suggesters

Documented in cloudsearch_build_suggesters cloudsearch_create_domain cloudsearch_define_analysis_scheme cloudsearch_define_expression cloudsearch_define_index_field cloudsearch_define_suggester cloudsearch_delete_analysis_scheme cloudsearch_delete_domain cloudsearch_delete_expression cloudsearch_delete_index_field cloudsearch_delete_suggester cloudsearch_describe_analysis_schemes cloudsearch_describe_availability_options cloudsearch_describe_domain_endpoint_options cloudsearch_describe_domains cloudsearch_describe_expressions cloudsearch_describe_index_fields cloudsearch_describe_scaling_parameters cloudsearch_describe_service_access_policies cloudsearch_describe_suggesters cloudsearch_index_documents cloudsearch_list_domain_names cloudsearch_update_availability_options cloudsearch_update_domain_endpoint_options cloudsearch_update_scaling_parameters cloudsearch_update_service_access_policies

# This file is generated by make.paws. Please do not edit here.
#' @importFrom paws.common get_config new_operation new_request send_request
#' @include cloudsearch_service.R
NULL

#' Indexes the search suggestions
#'
#' @description
#' Indexes the search suggestions. For more information, see [Configuring Suggesters](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters) in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_build_suggesters/](https://www.paws-r-sdk.com/docs/cloudsearch_build_suggesters/) for full documentation.
#'
#' @param DomainName [required] 
#'
#' @keywords internal
#'
#' @rdname cloudsearch_build_suggesters
cloudsearch_build_suggesters <- function(DomainName) {
  op <- new_operation(
    name = "BuildSuggesters",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$build_suggesters_input(DomainName = DomainName)
  output <- .cloudsearch$build_suggesters_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$build_suggesters <- cloudsearch_build_suggesters

#' Creates a new search domain
#'
#' @description
#' Creates a new search domain. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html" target="_blank">Creating a Search Domain</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_create_domain/](https://www.paws-r-sdk.com/docs/cloudsearch_create_domain/) for full documentation.
#'
#' @param DomainName &#91;required&#93; A name for the domain you are creating. Allowed characters are a-z
#' (lower-case letters), 0-9, and hyphen (-). Domain names must start with
#' a letter or number and be at least 3 and no more than 28 characters
#' long.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_create_domain
cloudsearch_create_domain <- function(DomainName) {
  op <- new_operation(
    name = "CreateDomain",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$create_domain_input(DomainName = DomainName)
  output <- .cloudsearch$create_domain_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$create_domain <- cloudsearch_create_domain

#' Configures an analysis scheme that can be applied to a text or
#' text-array field to define language-specific text processing options
#'
#' @description
#' Configures an analysis scheme that can be applied to a `text` or `text-array` field to define language-specific text processing options. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_define_analysis_scheme/](https://www.paws-r-sdk.com/docs/cloudsearch_define_analysis_scheme/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#' @param AnalysisScheme &#91;required&#93; 
#'
#' @keywords internal
#'
#' @rdname cloudsearch_define_analysis_scheme
cloudsearch_define_analysis_scheme <- function(DomainName, AnalysisScheme) {
  op <- new_operation(
    name = "DefineAnalysisScheme",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$define_analysis_scheme_input(DomainName = DomainName, AnalysisScheme = AnalysisScheme)
  output <- .cloudsearch$define_analysis_scheme_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$define_analysis_scheme <- cloudsearch_define_analysis_scheme

#' Configures an Expression for the search domain
#'
#' @description
#' Configures an `Expression` for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_define_expression/](https://www.paws-r-sdk.com/docs/cloudsearch_define_expression/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#' @param Expression &#91;required&#93; 
#'
#' @keywords internal
#'
#' @rdname cloudsearch_define_expression
cloudsearch_define_expression <- function(DomainName, Expression) {
  op <- new_operation(
    name = "DefineExpression",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$define_expression_input(DomainName = DomainName, Expression = Expression)
  output <- .cloudsearch$define_expression_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$define_expression <- cloudsearch_define_expression

#' Configures an IndexField for the search domain
#'
#' @description
#' Configures an `IndexField` for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the `IndexFieldType`. If the field exists, the new configuration replaces the old one. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_define_index_field/](https://www.paws-r-sdk.com/docs/cloudsearch_define_index_field/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#' @param IndexField &#91;required&#93; The index field and field options you want to configure.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_define_index_field
cloudsearch_define_index_field <- function(DomainName, IndexField) {
  op <- new_operation(
    name = "DefineIndexField",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$define_index_field_input(DomainName = DomainName, IndexField = IndexField)
  output <- .cloudsearch$define_index_field_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$define_index_field <- cloudsearch_define_index_field

#' Configures a suggester for a domain
#'
#' @description
#' Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_define_suggester/](https://www.paws-r-sdk.com/docs/cloudsearch_define_suggester/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#' @param Suggester &#91;required&#93; 
#'
#' @keywords internal
#'
#' @rdname cloudsearch_define_suggester
cloudsearch_define_suggester <- function(DomainName, Suggester) {
  op <- new_operation(
    name = "DefineSuggester",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$define_suggester_input(DomainName = DomainName, Suggester = Suggester)
  output <- .cloudsearch$define_suggester_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$define_suggester <- cloudsearch_define_suggester

#' Deletes an analysis scheme
#'
#' @description
#' Deletes an analysis scheme. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_delete_analysis_scheme/](https://www.paws-r-sdk.com/docs/cloudsearch_delete_analysis_scheme/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#' @param AnalysisSchemeName &#91;required&#93; The name of the analysis scheme you want to delete.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_delete_analysis_scheme
cloudsearch_delete_analysis_scheme <- function(DomainName, AnalysisSchemeName) {
  op <- new_operation(
    name = "DeleteAnalysisScheme",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$delete_analysis_scheme_input(DomainName = DomainName, AnalysisSchemeName = AnalysisSchemeName)
  output <- .cloudsearch$delete_analysis_scheme_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$delete_analysis_scheme <- cloudsearch_delete_analysis_scheme

#' Permanently deletes a search domain and all of its data
#'
#' @description
#' Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html" target="_blank">Deleting a Search Domain</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_delete_domain/](https://www.paws-r-sdk.com/docs/cloudsearch_delete_domain/) for full documentation.
#'
#' @param DomainName &#91;required&#93; The name of the domain you want to permanently delete.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_delete_domain
cloudsearch_delete_domain <- function(DomainName) {
  op <- new_operation(
    name = "DeleteDomain",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$delete_domain_input(DomainName = DomainName)
  output <- .cloudsearch$delete_domain_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$delete_domain <- cloudsearch_delete_domain

#' Removes an Expression from the search domain
#'
#' @description
#' Removes an `Expression` from the search domain. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_delete_expression/](https://www.paws-r-sdk.com/docs/cloudsearch_delete_expression/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#' @param ExpressionName &#91;required&#93; The name of the `Expression` to delete.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_delete_expression
cloudsearch_delete_expression <- function(DomainName, ExpressionName) {
  op <- new_operation(
    name = "DeleteExpression",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$delete_expression_input(DomainName = DomainName, ExpressionName = ExpressionName)
  output <- .cloudsearch$delete_expression_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$delete_expression <- cloudsearch_delete_expression

#' Removes an IndexField from the search domain
#'
#' @description
#' Removes an `IndexField` from the search domain. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_delete_index_field/](https://www.paws-r-sdk.com/docs/cloudsearch_delete_index_field/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#' @param IndexFieldName &#91;required&#93; The name of the index field your want to remove from the domain's
#' indexing options.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_delete_index_field
cloudsearch_delete_index_field <- function(DomainName, IndexFieldName) {
  op <- new_operation(
    name = "DeleteIndexField",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$delete_index_field_input(DomainName = DomainName, IndexFieldName = IndexFieldName)
  output <- .cloudsearch$delete_index_field_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$delete_index_field <- cloudsearch_delete_index_field

#' Deletes a suggester
#'
#' @description
#' Deletes a suggester. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_delete_suggester/](https://www.paws-r-sdk.com/docs/cloudsearch_delete_suggester/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#' @param SuggesterName &#91;required&#93; Specifies the name of the suggester you want to delete.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_delete_suggester
cloudsearch_delete_suggester <- function(DomainName, SuggesterName) {
  op <- new_operation(
    name = "DeleteSuggester",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$delete_suggester_input(DomainName = DomainName, SuggesterName = SuggesterName)
  output <- .cloudsearch$delete_suggester_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$delete_suggester <- cloudsearch_delete_suggester

#' Gets the analysis schemes configured for a domain
#'
#' @description
#' Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a `text` field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the `Deployed` option to `true` to show the active configuration and exclude pending changes. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_describe_analysis_schemes/](https://www.paws-r-sdk.com/docs/cloudsearch_describe_analysis_schemes/) for full documentation.
#'
#' @param DomainName &#91;required&#93; The name of the domain you want to describe.
#' @param AnalysisSchemeNames The analysis schemes you want to describe.
#' @param Deployed Whether to display the deployed configuration (`true`) or include any
#' pending changes (`false`). Defaults to `false`.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_describe_analysis_schemes
cloudsearch_describe_analysis_schemes <- function(DomainName, AnalysisSchemeNames = NULL, Deployed = NULL) {
  op <- new_operation(
    name = "DescribeAnalysisSchemes",
    http_method = "POST",
    http_path = "/",
    paginator = list(result_key = "AnalysisSchemes")
  )
  input <- .cloudsearch$describe_analysis_schemes_input(DomainName = DomainName, AnalysisSchemeNames = AnalysisSchemeNames, Deployed = Deployed)
  output <- .cloudsearch$describe_analysis_schemes_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$describe_analysis_schemes <- cloudsearch_describe_analysis_schemes

#' Gets the availability options configured for a domain
#'
#' @description
#' Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the `Deployed` option to `true` to show the active configuration and exclude pending changes. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_describe_availability_options/](https://www.paws-r-sdk.com/docs/cloudsearch_describe_availability_options/) for full documentation.
#'
#' @param DomainName &#91;required&#93; The name of the domain you want to describe.
#' @param Deployed Whether to display the deployed configuration (`true`) or include any
#' pending changes (`false`). Defaults to `false`.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_describe_availability_options
cloudsearch_describe_availability_options <- function(DomainName, Deployed = NULL) {
  op <- new_operation(
    name = "DescribeAvailabilityOptions",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$describe_availability_options_input(DomainName = DomainName, Deployed = Deployed)
  output <- .cloudsearch$describe_availability_options_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$describe_availability_options <- cloudsearch_describe_availability_options

#' Returns the domain's endpoint options, specifically whether all requests
#' to the domain must arrive over HTTPS
#'
#' @description
#' Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html" target="_blank">Configuring Domain Endpoint Options</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_describe_domain_endpoint_options/](https://www.paws-r-sdk.com/docs/cloudsearch_describe_domain_endpoint_options/) for full documentation.
#'
#' @param DomainName &#91;required&#93; A string that represents the name of a domain.
#' @param Deployed Whether to retrieve the latest configuration (which might be in a
#' Processing state) or the current, active configuration. Defaults to
#' `false`.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_describe_domain_endpoint_options
cloudsearch_describe_domain_endpoint_options <- function(DomainName, Deployed = NULL) {
  op <- new_operation(
    name = "DescribeDomainEndpointOptions",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$describe_domain_endpoint_options_input(DomainName = DomainName, Deployed = Deployed)
  output <- .cloudsearch$describe_domain_endpoint_options_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$describe_domain_endpoint_options <- cloudsearch_describe_domain_endpoint_options

#' Gets information about the search domains owned by this account
#'
#' @description
#' Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a `matchall` request to your domain's search endpoint: `q=matchall&amp;q.parser=structured&amp;size=0`. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_describe_domains/](https://www.paws-r-sdk.com/docs/cloudsearch_describe_domains/) for full documentation.
#'
#' @param DomainNames The names of the domains you want to include in the response.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_describe_domains
cloudsearch_describe_domains <- function(DomainNames = NULL) {
  op <- new_operation(
    name = "DescribeDomains",
    http_method = "POST",
    http_path = "/",
    paginator = list(result_key = "DomainStatusList")
  )
  input <- .cloudsearch$describe_domains_input(DomainNames = DomainNames)
  output <- .cloudsearch$describe_domains_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$describe_domains <- cloudsearch_describe_domains

#' Gets the expressions configured for the search domain
#'
#' @description
#' Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the `Deployed` option to `true` to show the active configuration and exclude pending changes. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_describe_expressions/](https://www.paws-r-sdk.com/docs/cloudsearch_describe_expressions/) for full documentation.
#'
#' @param DomainName &#91;required&#93; The name of the domain you want to describe.
#' @param ExpressionNames Limits the [`describe_expressions`][cloudsearch_describe_expressions]
#' response to the specified expressions. If not specified, all expressions
#' are shown.
#' @param Deployed Whether to display the deployed configuration (`true`) or include any
#' pending changes (`false`). Defaults to `false`.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_describe_expressions
cloudsearch_describe_expressions <- function(DomainName, ExpressionNames = NULL, Deployed = NULL) {
  op <- new_operation(
    name = "DescribeExpressions",
    http_method = "POST",
    http_path = "/",
    paginator = list(result_key = "Expressions")
  )
  input <- .cloudsearch$describe_expressions_input(DomainName = DomainName, ExpressionNames = ExpressionNames, Deployed = Deployed)
  output <- .cloudsearch$describe_expressions_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$describe_expressions <- cloudsearch_describe_expressions

#' Gets information about the index fields configured for the search domain
#'
#' @description
#' Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the `Deployed` option to `true` to show the active configuration and exclude pending changes. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Domain Information</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_describe_index_fields/](https://www.paws-r-sdk.com/docs/cloudsearch_describe_index_fields/) for full documentation.
#'
#' @param DomainName &#91;required&#93; The name of the domain you want to describe.
#' @param FieldNames A list of the index fields you want to describe. If not specified,
#' information is returned for all configured index fields.
#' @param Deployed Whether to display the deployed configuration (`true`) or include any
#' pending changes (`false`). Defaults to `false`.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_describe_index_fields
cloudsearch_describe_index_fields <- function(DomainName, FieldNames = NULL, Deployed = NULL) {
  op <- new_operation(
    name = "DescribeIndexFields",
    http_method = "POST",
    http_path = "/",
    paginator = list(result_key = "IndexFields")
  )
  input <- .cloudsearch$describe_index_fields_input(DomainName = DomainName, FieldNames = FieldNames, Deployed = Deployed)
  output <- .cloudsearch$describe_index_fields_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$describe_index_fields <- cloudsearch_describe_index_fields

#' Gets the scaling parameters configured for a domain
#'
#' @description
#' Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_describe_scaling_parameters/](https://www.paws-r-sdk.com/docs/cloudsearch_describe_scaling_parameters/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#'
#' @keywords internal
#'
#' @rdname cloudsearch_describe_scaling_parameters
cloudsearch_describe_scaling_parameters <- function(DomainName) {
  op <- new_operation(
    name = "DescribeScalingParameters",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$describe_scaling_parameters_input(DomainName = DomainName)
  output <- .cloudsearch$describe_scaling_parameters_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$describe_scaling_parameters <- cloudsearch_describe_scaling_parameters

#' Gets information about the access policies that control access to the
#' domain's document and search endpoints
#'
#' @description
#' Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the `Deployed` option to `true` to show the active configuration and exclude pending changes. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for a Search Domain</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_describe_service_access_policies/](https://www.paws-r-sdk.com/docs/cloudsearch_describe_service_access_policies/) for full documentation.
#'
#' @param DomainName &#91;required&#93; The name of the domain you want to describe.
#' @param Deployed Whether to display the deployed configuration (`true`) or include any
#' pending changes (`false`). Defaults to `false`.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_describe_service_access_policies
cloudsearch_describe_service_access_policies <- function(DomainName, Deployed = NULL) {
  op <- new_operation(
    name = "DescribeServiceAccessPolicies",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$describe_service_access_policies_input(DomainName = DomainName, Deployed = Deployed)
  output <- .cloudsearch$describe_service_access_policies_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$describe_service_access_policies <- cloudsearch_describe_service_access_policies

#' Gets the suggesters configured for a domain
#'
#' @description
#' Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the `Deployed` option to `true` to show the active configuration and exclude pending changes. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_describe_suggesters/](https://www.paws-r-sdk.com/docs/cloudsearch_describe_suggesters/) for full documentation.
#'
#' @param DomainName &#91;required&#93; The name of the domain you want to describe.
#' @param SuggesterNames The suggesters you want to describe.
#' @param Deployed Whether to display the deployed configuration (`true`) or include any
#' pending changes (`false`). Defaults to `false`.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_describe_suggesters
cloudsearch_describe_suggesters <- function(DomainName, SuggesterNames = NULL, Deployed = NULL) {
  op <- new_operation(
    name = "DescribeSuggesters",
    http_method = "POST",
    http_path = "/",
    paginator = list(result_key = "Suggesters")
  )
  input <- .cloudsearch$describe_suggesters_input(DomainName = DomainName, SuggesterNames = SuggesterNames, Deployed = Deployed)
  output <- .cloudsearch$describe_suggesters_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$describe_suggesters <- cloudsearch_describe_suggesters

#' Tells the search domain to start indexing its documents using the latest
#' indexing options
#'
#' @description
#' Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is `RequiresIndexDocuments`.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_index_documents/](https://www.paws-r-sdk.com/docs/cloudsearch_index_documents/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#'
#' @keywords internal
#'
#' @rdname cloudsearch_index_documents
cloudsearch_index_documents <- function(DomainName) {
  op <- new_operation(
    name = "IndexDocuments",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$index_documents_input(DomainName = DomainName)
  output <- .cloudsearch$index_documents_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$index_documents <- cloudsearch_index_documents

#' Lists all search domains owned by an account
#'
#' @description
#' Lists all search domains owned by an account.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_list_domain_names/](https://www.paws-r-sdk.com/docs/cloudsearch_list_domain_names/) for full documentation.
#'

#'
#' @keywords internal
#'
#' @rdname cloudsearch_list_domain_names
cloudsearch_list_domain_names <- function() {
  op <- new_operation(
    name = "ListDomainNames",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$list_domain_names_input()
  output <- .cloudsearch$list_domain_names_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$list_domain_names <- cloudsearch_list_domain_names

#' Configures the availability options for a domain
#'
#' @description
#' Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_update_availability_options/](https://www.paws-r-sdk.com/docs/cloudsearch_update_availability_options/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#' @param MultiAZ &#91;required&#93; You expand an existing search domain to a second Availability Zone by
#' setting the Multi-AZ option to true. Similarly, you can turn off the
#' Multi-AZ option to downgrade the domain to a single Availability Zone by
#' setting the Multi-AZ option to `false`.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_update_availability_options
cloudsearch_update_availability_options <- function(DomainName, MultiAZ) {
  op <- new_operation(
    name = "UpdateAvailabilityOptions",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$update_availability_options_input(DomainName = DomainName, MultiAZ = MultiAZ)
  output <- .cloudsearch$update_availability_options_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$update_availability_options <- cloudsearch_update_availability_options

#' Updates the domain's endpoint options, specifically whether all requests
#' to the domain must arrive over HTTPS
#'
#' @description
#' Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html" target="_blank">Configuring Domain Endpoint Options</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_update_domain_endpoint_options/](https://www.paws-r-sdk.com/docs/cloudsearch_update_domain_endpoint_options/) for full documentation.
#'
#' @param DomainName &#91;required&#93; A string that represents the name of a domain.
#' @param DomainEndpointOptions &#91;required&#93; Whether to require that all requests to the domain arrive over HTTPS. We
#' recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For
#' compatibility with older clients, the default is
#' Policy-Min-TLS-1-0-2019-07.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_update_domain_endpoint_options
cloudsearch_update_domain_endpoint_options <- function(DomainName, DomainEndpointOptions) {
  op <- new_operation(
    name = "UpdateDomainEndpointOptions",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$update_domain_endpoint_options_input(DomainName = DomainName, DomainEndpointOptions = DomainEndpointOptions)
  output <- .cloudsearch$update_domain_endpoint_options_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$update_domain_endpoint_options <- cloudsearch_update_domain_endpoint_options

#' Configures scaling parameters for a domain
#'
#' @description
#' Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the *Amazon CloudSearch Developer Guide*.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_update_scaling_parameters/](https://www.paws-r-sdk.com/docs/cloudsearch_update_scaling_parameters/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#' @param ScalingParameters &#91;required&#93; 
#'
#' @keywords internal
#'
#' @rdname cloudsearch_update_scaling_parameters
cloudsearch_update_scaling_parameters <- function(DomainName, ScalingParameters) {
  op <- new_operation(
    name = "UpdateScalingParameters",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$update_scaling_parameters_input(DomainName = DomainName, ScalingParameters = ScalingParameters)
  output <- .cloudsearch$update_scaling_parameters_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$update_scaling_parameters <- cloudsearch_update_scaling_parameters

#' Configures the access rules that control access to the domain's document
#' and search endpoints
#'
#' @description
#' Configures the access rules that control access to the domain's document and search endpoints. For more information, see <a href="https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for an Amazon CloudSearch Domain</a>.
#'
#' See [https://www.paws-r-sdk.com/docs/cloudsearch_update_service_access_policies/](https://www.paws-r-sdk.com/docs/cloudsearch_update_service_access_policies/) for full documentation.
#'
#' @param DomainName &#91;required&#93; 
#' @param AccessPolicies &#91;required&#93; The access rules you want to configure. These rules replace any existing
#' rules.
#'
#' @keywords internal
#'
#' @rdname cloudsearch_update_service_access_policies
cloudsearch_update_service_access_policies <- function(DomainName, AccessPolicies) {
  op <- new_operation(
    name = "UpdateServiceAccessPolicies",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .cloudsearch$update_service_access_policies_input(DomainName = DomainName, AccessPolicies = AccessPolicies)
  output <- .cloudsearch$update_service_access_policies_output()
  config <- get_config()
  svc <- .cloudsearch$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.cloudsearch$operations$update_service_access_policies <- cloudsearch_update_service_access_policies

Try the paws.analytics package in your browser

Any scripts or data that you put into this service are public.

paws.analytics documentation built on Sept. 11, 2023, 5:06 p.m.