Nothing
# This file is generated by make.paws. Please do not edit here.
#' @importFrom paws.common get_config new_operation new_request send_request
#' @include simpledb_service.R
NULL
#' Performs multiple DeleteAttributes operations in a single call, which
#' reduces round trips and latencies
#'
#' @description
#' Performs multiple DeleteAttributes operations in a single call, which
#' reduces round trips and latencies. This enables Amazon SimpleDB to
#' optimize requests, which generally yields better throughput.
#'
#' If you specify BatchDeleteAttributes without attributes or values, all
#' the attributes for the item are deleted.
#'
#' BatchDeleteAttributes is an idempotent operation; running it multiple
#' times on the same item or attribute doesn't result in an error.
#'
#' The BatchDeleteAttributes operation succeeds or fails in its entirety.
#' There are no partial deletes. You can execute multiple
#' BatchDeleteAttributes operations and other operations in parallel.
#' However, large numbers of concurrent BatchDeleteAttributes calls can
#' result in Service Unavailable (503) responses.
#'
#' This operation is vulnerable to exceeding the maximum URL size when
#' making a REST request using the HTTP GET method.
#'
#' This operation does not support conditions using Expected.X.Name,
#' Expected.X.Value, or Expected.X.Exists.
#'
#' The following limitations are enforced for this operation:
#'
#' - 1 MB request size
#' - 25 item limit per BatchDeleteAttributes operation
#'
#' @usage
#' simpledb_batch_delete_attributes(DomainName, Items)
#'
#' @param DomainName [required] The name of the domain in which the attributes are being deleted.
#' @param Items [required] A list of items on which to perform the operation.
#'
#' @return
#' An empty list.
#'
#' @section Request syntax:
#' ```
#' svc$batch_delete_attributes(
#' DomainName = "string",
#' Items = list(
#' list(
#' Name = "string",
#' Attributes = list(
#' list(
#' Name = "string",
#' Value = "string"
#' )
#' )
#' )
#' )
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname simpledb_batch_delete_attributes
simpledb_batch_delete_attributes <- function(DomainName, Items) {
op <- new_operation(
name = "BatchDeleteAttributes",
http_method = "POST",
http_path = "/",
paginator = list()
)
input <- .simpledb$batch_delete_attributes_input(DomainName = DomainName, Items = Items)
output <- .simpledb$batch_delete_attributes_output()
config <- get_config()
svc <- .simpledb$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.simpledb$operations$batch_delete_attributes <- simpledb_batch_delete_attributes
#' The BatchPutAttributes operation creates or replaces attributes within
#' one or more items
#'
#' @description
#' The [`batch_put_attributes`][simpledb_batch_put_attributes] operation
#' creates or replaces attributes within one or more items. By using this
#' operation, the client can perform multiple PutAttribute operation with a
#' single call. This helps yield savings in round trips and latencies,
#' enabling Amazon SimpleDB to optimize requests and generally produce
#' better throughput.
#'
#' The client may specify the item name with the `Item.X.ItemName`
#' parameter. The client may specify new attributes using a combination of
#' the `Item.X.Attribute.Y.Name` and `Item.X.Attribute.Y.Value` parameters.
#' The client may specify the first attribute for the first item using the
#' parameters `Item.0.Attribute.0.Name` and `Item.0.Attribute.0.Value`, and
#' for the second attribute for the first item by the parameters
#' `Item.0.Attribute.1.Name` and `Item.0.Attribute.1.Value`, and so on.
#'
#' Attributes are uniquely identified within an item by their name/value
#' combination. For example, a single item can have the attributes
#' `{ "first_name", "first_value" }` and
#' `{ "first_name", "second_value" }`. However, it cannot have two
#' attribute instances where both the `Item.X.Attribute.Y.Name` and
#' `Item.X.Attribute.Y.Value` are the same.
#'
#' Optionally, the requester can supply the `Replace` parameter for each
#' individual value. Setting this value to `true` will cause the new
#' attribute values to replace the existing attribute values. For example,
#' if an item `I` has the attributes `{ 'a', '1' }, { 'b', '2'}` and
#' `{ 'b', '3' }` and the requester does a BatchPutAttributes of
#' `{'I', 'b', '4' }` with the Replace parameter set to true, the final
#' attributes of the item will be `{ 'a', '1' }` and `{ 'b', '4' }`,
#' replacing the previous values of the 'b' attribute with the new value.
#'
#' You cannot specify an empty string as an item or as an attribute name.
#' The [`batch_put_attributes`][simpledb_batch_put_attributes] operation
#' succeeds or fails in its entirety. There are no partial puts.
#'
#' This operation is vulnerable to exceeding the maximum URL size when
#' making a REST request using the HTTP GET method. This operation does not
#' support conditions using `Expected.X.Name`, `Expected.X.Value`, or
#' `Expected.X.Exists`.
#'
#' You can execute multiple
#' [`batch_put_attributes`][simpledb_batch_put_attributes] operations and
#' other operations in parallel. However, large numbers of concurrent
#' [`batch_put_attributes`][simpledb_batch_put_attributes] calls can result
#' in Service Unavailable (503) responses.
#'
#' The following limitations are enforced for this operation:
#'
#' - 256 attribute name-value pairs per item
#' - 1 MB request size
#' - 1 billion attributes per domain
#' - 10 GB of total user data storage per domain
#' - 25 item limit per
#' [`batch_put_attributes`][simpledb_batch_put_attributes] operation
#'
#' @usage
#' simpledb_batch_put_attributes(DomainName, Items)
#'
#' @param DomainName [required] The name of the domain in which the attributes are being stored.
#' @param Items [required] A list of items on which to perform the operation.
#'
#' @return
#' An empty list.
#'
#' @section Request syntax:
#' ```
#' svc$batch_put_attributes(
#' DomainName = "string",
#' Items = list(
#' list(
#' Name = "string",
#' Attributes = list(
#' list(
#' Name = "string",
#' Value = "string",
#' Replace = TRUE|FALSE
#' )
#' )
#' )
#' )
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname simpledb_batch_put_attributes
simpledb_batch_put_attributes <- function(DomainName, Items) {
op <- new_operation(
name = "BatchPutAttributes",
http_method = "POST",
http_path = "/",
paginator = list()
)
input <- .simpledb$batch_put_attributes_input(DomainName = DomainName, Items = Items)
output <- .simpledb$batch_put_attributes_output()
config <- get_config()
svc <- .simpledb$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.simpledb$operations$batch_put_attributes <- simpledb_batch_put_attributes
#' The CreateDomain operation creates a new domain
#'
#' @description
#' The [`create_domain`][simpledb_create_domain] operation creates a new
#' domain. The domain name should be unique among the domains associated
#' with the Access Key ID provided in the request. The
#' [`create_domain`][simpledb_create_domain] operation may take 10 or more
#' seconds to complete.
#'
#' CreateDomain is an idempotent operation; running it multiple times using
#' the same domain name will not result in an error response.
#'
#' The client can create up to 100 domains per account.
#'
#' If the client requires additional domains, go to
#' http://aws.amazon.com/contact-us/simpledb-limit-request/.
#'
#' @usage
#' simpledb_create_domain(DomainName)
#'
#' @param DomainName [required] The name of the domain to create. The name can range between 3 and 255
#' characters and can contain the following characters: a-z, A-Z, 0-9,
#' '_', '-', and '.'.
#'
#' @return
#' An empty list.
#'
#' @section Request syntax:
#' ```
#' svc$create_domain(
#' DomainName = "string"
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname simpledb_create_domain
simpledb_create_domain <- function(DomainName) {
op <- new_operation(
name = "CreateDomain",
http_method = "POST",
http_path = "/",
paginator = list()
)
input <- .simpledb$create_domain_input(DomainName = DomainName)
output <- .simpledb$create_domain_output()
config <- get_config()
svc <- .simpledb$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.simpledb$operations$create_domain <- simpledb_create_domain
#' Deletes one or more attributes associated with an item
#'
#' @description
#' Deletes one or more attributes associated with an item. If all
#' attributes of the item are deleted, the item is deleted.
#'
#' If [`delete_attributes`][simpledb_delete_attributes] is called without
#' being passed any attributes or values specified, all the attributes for
#' the item are deleted.
#'
#' [`delete_attributes`][simpledb_delete_attributes] is an idempotent
#' operation; running it multiple times on the same item or attribute does
#' not result in an error response.
#'
#' Because Amazon SimpleDB makes multiple copies of item data and uses an
#' eventual consistency update model, performing a
#' [`get_attributes`][simpledb_get_attributes] or
#' [`select`][simpledb_select] operation (read) immediately after a
#' [`delete_attributes`][simpledb_delete_attributes] or
#' [`put_attributes`][simpledb_put_attributes] operation (write) might not
#' return updated item data.
#'
#' @usage
#' simpledb_delete_attributes(DomainName, ItemName, Attributes, Expected)
#'
#' @param DomainName [required] The name of the domain in which to perform the operation.
#' @param ItemName [required] The name of the item. Similar to rows on a spreadsheet, items represent
#' individual objects that contain one or more value-attribute pairs.
#' @param Attributes A list of Attributes. Similar to columns on a spreadsheet, attributes
#' represent categories of data that can be assigned to items.
#' @param Expected The update condition which, if specified, determines whether the
#' specified attributes will be deleted or not. The update condition must
#' be satisfied in order for this request to be processed and the
#' attributes to be deleted.
#'
#' @return
#' An empty list.
#'
#' @section Request syntax:
#' ```
#' svc$delete_attributes(
#' DomainName = "string",
#' ItemName = "string",
#' Attributes = list(
#' list(
#' Name = "string",
#' Value = "string"
#' )
#' ),
#' Expected = list(
#' Name = "string",
#' Value = "string",
#' Exists = TRUE|FALSE
#' )
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname simpledb_delete_attributes
simpledb_delete_attributes <- function(DomainName, ItemName, Attributes = NULL, Expected = NULL) {
op <- new_operation(
name = "DeleteAttributes",
http_method = "POST",
http_path = "/",
paginator = list()
)
input <- .simpledb$delete_attributes_input(DomainName = DomainName, ItemName = ItemName, Attributes = Attributes, Expected = Expected)
output <- .simpledb$delete_attributes_output()
config <- get_config()
svc <- .simpledb$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.simpledb$operations$delete_attributes <- simpledb_delete_attributes
#' The DeleteDomain operation deletes a domain
#'
#' @description
#' The [`delete_domain`][simpledb_delete_domain] operation deletes a
#' domain. Any items (and their attributes) in the domain are deleted as
#' well. The [`delete_domain`][simpledb_delete_domain] operation might take
#' 10 or more seconds to complete.
#'
#' Running [`delete_domain`][simpledb_delete_domain] on a domain that does
#' not exist or running the function multiple times using the same domain
#' name will not result in an error response.
#'
#' @usage
#' simpledb_delete_domain(DomainName)
#'
#' @param DomainName [required] The name of the domain to delete.
#'
#' @return
#' An empty list.
#'
#' @section Request syntax:
#' ```
#' svc$delete_domain(
#' DomainName = "string"
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname simpledb_delete_domain
simpledb_delete_domain <- function(DomainName) {
op <- new_operation(
name = "DeleteDomain",
http_method = "POST",
http_path = "/",
paginator = list()
)
input <- .simpledb$delete_domain_input(DomainName = DomainName)
output <- .simpledb$delete_domain_output()
config <- get_config()
svc <- .simpledb$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.simpledb$operations$delete_domain <- simpledb_delete_domain
#' Returns information about the domain, including when the domain was
#' created, the number of items and attributes in the domain, and the size
#' of the attribute names and values
#'
#' @description
#' Returns information about the domain, including when the domain was
#' created, the number of items and attributes in the domain, and the size
#' of the attribute names and values.
#'
#' @usage
#' simpledb_domain_metadata(DomainName)
#'
#' @param DomainName [required] The name of the domain for which to display the metadata of.
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#' ItemCount = 123,
#' ItemNamesSizeBytes = 123,
#' AttributeNameCount = 123,
#' AttributeNamesSizeBytes = 123,
#' AttributeValueCount = 123,
#' AttributeValuesSizeBytes = 123,
#' Timestamp = 123
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$domain_metadata(
#' DomainName = "string"
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname simpledb_domain_metadata
simpledb_domain_metadata <- function(DomainName) {
op <- new_operation(
name = "DomainMetadata",
http_method = "POST",
http_path = "/",
paginator = list()
)
input <- .simpledb$domain_metadata_input(DomainName = DomainName)
output <- .simpledb$domain_metadata_output()
config <- get_config()
svc <- .simpledb$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.simpledb$operations$domain_metadata <- simpledb_domain_metadata
#' Returns all of the attributes associated with the specified item
#'
#' @description
#' Returns all of the attributes associated with the specified item.
#' Optionally, the attributes returned can be limited to one or more
#' attributes by specifying an attribute name parameter.
#'
#' If the item does not exist on the replica that was accessed for this
#' operation, an empty set is returned. The system does not return an error
#' as it cannot guarantee the item does not exist on other replicas.
#'
#' If GetAttributes is called without being passed any attribute names, all
#' the attributes for the item are returned.
#'
#' @usage
#' simpledb_get_attributes(DomainName, ItemName, AttributeNames,
#' ConsistentRead)
#'
#' @param DomainName [required] The name of the domain in which to perform the operation.
#' @param ItemName [required] The name of the item.
#' @param AttributeNames The names of the attributes.
#' @param ConsistentRead Determines whether or not strong consistency should be enforced when
#' data is read from SimpleDB. If `true`, any data previously written to
#' SimpleDB will be returned. Otherwise, results will be consistent
#' eventually, and the client may not see data that was written immediately
#' before your read.
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#' Attributes = list(
#' list(
#' Name = "string",
#' AlternateNameEncoding = "string",
#' Value = "string",
#' AlternateValueEncoding = "string"
#' )
#' )
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$get_attributes(
#' DomainName = "string",
#' ItemName = "string",
#' AttributeNames = list(
#' "string"
#' ),
#' ConsistentRead = TRUE|FALSE
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname simpledb_get_attributes
simpledb_get_attributes <- function(DomainName, ItemName, AttributeNames = NULL, ConsistentRead = NULL) {
op <- new_operation(
name = "GetAttributes",
http_method = "POST",
http_path = "/",
paginator = list()
)
input <- .simpledb$get_attributes_input(DomainName = DomainName, ItemName = ItemName, AttributeNames = AttributeNames, ConsistentRead = ConsistentRead)
output <- .simpledb$get_attributes_output()
config <- get_config()
svc <- .simpledb$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.simpledb$operations$get_attributes <- simpledb_get_attributes
#' The ListDomains operation lists all domains associated with the Access
#' Key ID
#'
#' @description
#' The [`list_domains`][simpledb_list_domains] operation lists all domains
#' associated with the Access Key ID. It returns domain names up to the
#' limit set by MaxNumberOfDomains. A NextToken is returned if there are
#' more than `MaxNumberOfDomains` domains. Calling
#' [`list_domains`][simpledb_list_domains] successive times with the
#' `NextToken` provided by the operation returns up to `MaxNumberOfDomains`
#' more domain names with each successive operation call.
#'
#' @usage
#' simpledb_list_domains(MaxNumberOfDomains, NextToken)
#'
#' @param MaxNumberOfDomains The maximum number of domain names you want returned. The range is 1 to
#' 100. The default setting is 100.
#' @param NextToken A string informing Amazon SimpleDB where to start the next list of
#' domain names.
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#' DomainNames = list(
#' "string"
#' ),
#' NextToken = "string"
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$list_domains(
#' MaxNumberOfDomains = 123,
#' NextToken = "string"
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname simpledb_list_domains
simpledb_list_domains <- function(MaxNumberOfDomains = NULL, NextToken = NULL) {
op <- new_operation(
name = "ListDomains",
http_method = "POST",
http_path = "/",
paginator = list()
)
input <- .simpledb$list_domains_input(MaxNumberOfDomains = MaxNumberOfDomains, NextToken = NextToken)
output <- .simpledb$list_domains_output()
config <- get_config()
svc <- .simpledb$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.simpledb$operations$list_domains <- simpledb_list_domains
#' The PutAttributes operation creates or replaces attributes in an item
#'
#' @description
#' The PutAttributes operation creates or replaces attributes in an item.
#' The client may specify new attributes using a combination of the
#' `Attribute.X.Name` and `Attribute.X.Value` parameters. The client
#' specifies the first attribute by the parameters `Attribute.0.Name` and
#' `Attribute.0.Value`, the second attribute by the parameters
#' `Attribute.1.Name` and `Attribute.1.Value`, and so on.
#'
#' Attributes are uniquely identified in an item by their name/value
#' combination. For example, a single item can have the attributes
#' `{ "first_name", "first_value" }` and
#' `{ \"first_name\", second_value\" }`. However, it cannot have two
#' attribute instances where both the `Attribute.X.Name` and
#' `Attribute.X.Value` are the same.
#'
#' Optionally, the requestor can supply the `Replace` parameter for each
#' individual attribute. Setting this value to `true` causes the new
#' attribute value to replace the existing attribute value(s). For example,
#' if an item has the attributes `{ 'a', '1' }`, `{ 'b', '2'}` and
#' `{ 'b', '3' }` and the requestor calls
#' [`put_attributes`][simpledb_put_attributes] using the attributes
#' `{ 'b', '4' }` with the `Replace` parameter set to true, the final
#' attributes of the item are changed to `{ 'a', '1' }` and `{ 'b', '4' }`,
#' which replaces the previous values of the 'b' attribute with the new
#' value.
#'
#' Using [`put_attributes`][simpledb_put_attributes] to replace attribute
#' values that do not exist will not result in an error response.
#'
#' You cannot specify an empty string as an attribute name.
#'
#' Because Amazon SimpleDB makes multiple copies of client data and uses an
#' eventual consistency update model, an immediate
#' [`get_attributes`][simpledb_get_attributes] or
#' [`select`][simpledb_select] operation (read) immediately after a
#' [`put_attributes`][simpledb_put_attributes] or
#' [`delete_attributes`][simpledb_delete_attributes] operation (write)
#' might not return the updated data.
#'
#' The following limitations are enforced for this operation:
#'
#' - 256 total attribute name-value pairs per item
#' - One billion attributes per domain
#' - 10 GB of total user data storage per domain
#'
#' @usage
#' simpledb_put_attributes(DomainName, ItemName, Attributes, Expected)
#'
#' @param DomainName [required] The name of the domain in which to perform the operation.
#' @param ItemName [required] The name of the item.
#' @param Attributes [required] The list of attributes.
#' @param Expected The update condition which, if specified, determines whether the
#' specified attributes will be updated or not. The update condition must
#' be satisfied in order for this request to be processed and the
#' attributes to be updated.
#'
#' @return
#' An empty list.
#'
#' @section Request syntax:
#' ```
#' svc$put_attributes(
#' DomainName = "string",
#' ItemName = "string",
#' Attributes = list(
#' list(
#' Name = "string",
#' Value = "string",
#' Replace = TRUE|FALSE
#' )
#' ),
#' Expected = list(
#' Name = "string",
#' Value = "string",
#' Exists = TRUE|FALSE
#' )
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname simpledb_put_attributes
simpledb_put_attributes <- function(DomainName, ItemName, Attributes, Expected = NULL) {
op <- new_operation(
name = "PutAttributes",
http_method = "POST",
http_path = "/",
paginator = list()
)
input <- .simpledb$put_attributes_input(DomainName = DomainName, ItemName = ItemName, Attributes = Attributes, Expected = Expected)
output <- .simpledb$put_attributes_output()
config <- get_config()
svc <- .simpledb$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.simpledb$operations$put_attributes <- simpledb_put_attributes
#' The Select operation returns a set of attributes for ItemNames that
#' match the select expression
#'
#' @description
#' The [`select`][simpledb_select] operation returns a set of attributes
#' for `ItemNames` that match the select expression.
#' [`select`][simpledb_select] is similar to the standard SQL SELECT
#' statement.
#'
#' The total size of the response cannot exceed 1 MB in total size. Amazon
#' SimpleDB automatically adjusts the number of items returned per page to
#' enforce this limit. For example, if the client asks to retrieve 2500
#' items, but each individual item is 10 kB in size, the system returns 100
#' items and an appropriate `NextToken` so the client can access the next
#' page of results.
#'
#' For information on how to construct select expressions, see Using Select
#' to Create Amazon SimpleDB Queries in the Developer Guide.
#'
#' @usage
#' simpledb_select(SelectExpression, NextToken, ConsistentRead)
#'
#' @param SelectExpression [required] The expression used to query the domain.
#' @param NextToken A string informing Amazon SimpleDB where to start the next list of
#' `ItemNames`.
#' @param ConsistentRead Determines whether or not strong consistency should be enforced when
#' data is read from SimpleDB. If `true`, any data previously written to
#' SimpleDB will be returned. Otherwise, results will be consistent
#' eventually, and the client may not see data that was written immediately
#' before your read.
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#' Items = list(
#' list(
#' Name = "string",
#' AlternateNameEncoding = "string",
#' Attributes = list(
#' list(
#' Name = "string",
#' AlternateNameEncoding = "string",
#' Value = "string",
#' AlternateValueEncoding = "string"
#' )
#' )
#' )
#' ),
#' NextToken = "string"
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$select(
#' SelectExpression = "string",
#' NextToken = "string",
#' ConsistentRead = TRUE|FALSE
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname simpledb_select
simpledb_select <- function(SelectExpression, NextToken = NULL, ConsistentRead = NULL) {
op <- new_operation(
name = "Select",
http_method = "POST",
http_path = "/",
paginator = list()
)
input <- .simpledb$select_input(SelectExpression = SelectExpression, NextToken = NextToken, ConsistentRead = ConsistentRead)
output <- .simpledb$select_output()
config <- get_config()
svc <- .simpledb$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.simpledb$operations$select <- simpledb_select
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.