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 sagemakerfeaturestoreruntime_service.R
NULL
#' Retrieves a batch of Records from a FeatureGroup
#'
#' @description
#' Retrieves a batch of `Records` from a `FeatureGroup`.
#'
#' See [https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_batch_get_record/](https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_batch_get_record/) for full documentation.
#'
#' @param Identifiers [required] A list containing the name or Amazon Resource Name (ARN) of the
#' `FeatureGroup`, the list of names of `Feature`s to be retrieved, and the
#' corresponding `RecordIdentifier` values as strings.
#' @param ExpirationTimeResponse Parameter to request `ExpiresAt` in response. If `Enabled`,
#' [`batch_get_record`][sagemakerfeaturestoreruntime_batch_get_record] will
#' return the value of `ExpiresAt`, if it is not null. If `Disabled` and
#' null,
#' [`batch_get_record`][sagemakerfeaturestoreruntime_batch_get_record] will
#' return null.
#'
#' @keywords internal
#'
#' @rdname sagemakerfeaturestoreruntime_batch_get_record
sagemakerfeaturestoreruntime_batch_get_record <- function(Identifiers, ExpirationTimeResponse = NULL) {
op <- new_operation(
name = "BatchGetRecord",
http_method = "POST",
http_path = "/BatchGetRecord",
paginator = list()
)
input <- .sagemakerfeaturestoreruntime$batch_get_record_input(Identifiers = Identifiers, ExpirationTimeResponse = ExpirationTimeResponse)
output <- .sagemakerfeaturestoreruntime$batch_get_record_output()
config <- get_config()
svc <- .sagemakerfeaturestoreruntime$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.sagemakerfeaturestoreruntime$operations$batch_get_record <- sagemakerfeaturestoreruntime_batch_get_record
#' Deletes a Record from a FeatureGroup in the OnlineStore
#'
#' @description
#' Deletes a `Record` from a `FeatureGroup` in the `OnlineStore`. Feature Store supports both `SoftDelete` and `HardDelete`. For `SoftDelete` (default), feature columns are set to `null` and the record is no longer retrievable by [`get_record`][sagemakerfeaturestoreruntime_get_record] or [`batch_get_record`][sagemakerfeaturestoreruntime_batch_get_record]. For `HardDelete`, the complete `Record` is removed from the `OnlineStore`. In both cases, Feature Store appends the deleted record marker to the `OfflineStore`. The deleted record marker is a record with the same `RecordIdentifer` as the original, but with `is_deleted` value set to `True`, `EventTime` set to the delete input `EventTime`, and other feature values set to `null`.
#'
#' See [https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_delete_record/](https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_delete_record/) for full documentation.
#'
#' @param FeatureGroupName [required] The name or Amazon Resource Name (ARN) of the feature group to delete
#' the record from.
#' @param RecordIdentifierValueAsString [required] The value for the `RecordIdentifier` that uniquely identifies the
#' record, in string format.
#' @param EventTime [required] Timestamp indicating when the deletion event occurred. `EventTime` can
#' be used to query data at a certain point in time.
#' @param TargetStores A list of stores from which you're deleting the record. By default,
#' Feature Store deletes the record from all of the stores that you're
#' using for the `FeatureGroup`.
#' @param DeletionMode The name of the deletion mode for deleting the record. By default, the
#' deletion mode is set to `SoftDelete`.
#'
#' @keywords internal
#'
#' @rdname sagemakerfeaturestoreruntime_delete_record
sagemakerfeaturestoreruntime_delete_record <- function(FeatureGroupName, RecordIdentifierValueAsString, EventTime, TargetStores = NULL, DeletionMode = NULL) {
op <- new_operation(
name = "DeleteRecord",
http_method = "DELETE",
http_path = "/FeatureGroup/{FeatureGroupName}",
paginator = list()
)
input <- .sagemakerfeaturestoreruntime$delete_record_input(FeatureGroupName = FeatureGroupName, RecordIdentifierValueAsString = RecordIdentifierValueAsString, EventTime = EventTime, TargetStores = TargetStores, DeletionMode = DeletionMode)
output <- .sagemakerfeaturestoreruntime$delete_record_output()
config <- get_config()
svc <- .sagemakerfeaturestoreruntime$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.sagemakerfeaturestoreruntime$operations$delete_record <- sagemakerfeaturestoreruntime_delete_record
#' Use for OnlineStore serving from a FeatureStore
#'
#' @description
#' Use for `OnlineStore` serving from a `FeatureStore`. Only the latest records stored in the `OnlineStore` can be retrieved. If no Record with `RecordIdentifierValue` is found, then an empty result is returned.
#'
#' See [https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_get_record/](https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_get_record/) for full documentation.
#'
#' @param FeatureGroupName [required] The name or Amazon Resource Name (ARN) of the feature group from which
#' you want to retrieve a record.
#' @param RecordIdentifierValueAsString [required] The value that corresponds to `RecordIdentifier` type and uniquely
#' identifies the record in the `FeatureGroup`.
#' @param FeatureNames List of names of Features to be retrieved. If not specified, the latest
#' value for all the Features are returned.
#' @param ExpirationTimeResponse Parameter to request `ExpiresAt` in response. If `Enabled`,
#' [`get_record`][sagemakerfeaturestoreruntime_get_record] will return the
#' value of `ExpiresAt`, if it is not null. If `Disabled` and null,
#' [`get_record`][sagemakerfeaturestoreruntime_get_record] will return
#' null.
#'
#' @keywords internal
#'
#' @rdname sagemakerfeaturestoreruntime_get_record
sagemakerfeaturestoreruntime_get_record <- function(FeatureGroupName, RecordIdentifierValueAsString, FeatureNames = NULL, ExpirationTimeResponse = NULL) {
op <- new_operation(
name = "GetRecord",
http_method = "GET",
http_path = "/FeatureGroup/{FeatureGroupName}",
paginator = list()
)
input <- .sagemakerfeaturestoreruntime$get_record_input(FeatureGroupName = FeatureGroupName, RecordIdentifierValueAsString = RecordIdentifierValueAsString, FeatureNames = FeatureNames, ExpirationTimeResponse = ExpirationTimeResponse)
output <- .sagemakerfeaturestoreruntime$get_record_output()
config <- get_config()
svc <- .sagemakerfeaturestoreruntime$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.sagemakerfeaturestoreruntime$operations$get_record <- sagemakerfeaturestoreruntime_get_record
#' The PutRecord API is used to ingest a list of Records into your feature
#' group
#'
#' @description
#' The [`put_record`][sagemakerfeaturestoreruntime_put_record] API is used to ingest a list of `Records` into your feature group.
#'
#' See [https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_put_record/](https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_put_record/) for full documentation.
#'
#' @param FeatureGroupName [required] The name or Amazon Resource Name (ARN) of the feature group that you
#' want to insert the record into.
#' @param Record [required] List of FeatureValues to be inserted. This will be a full over-write. If
#' you only want to update few of the feature values, do the following:
#'
#' - Use [`get_record`][sagemakerfeaturestoreruntime_get_record] to
#' retrieve the latest record.
#'
#' - Update the record returned from
#' [`get_record`][sagemakerfeaturestoreruntime_get_record].
#'
#' - Use [`put_record`][sagemakerfeaturestoreruntime_put_record] to
#' update feature values.
#' @param TargetStores A list of stores to which you're adding the record. By default, Feature
#' Store adds the record to all of the stores that you're using for the
#' `FeatureGroup`.
#' @param TtlDuration Time to live duration, where the record is hard deleted after the
#' expiration time is reached; `ExpiresAt` = `EventTime` + `TtlDuration`.
#' For information on HardDelete, see the
#' [`delete_record`][sagemakerfeaturestoreruntime_delete_record] API in the
#' Amazon SageMaker API Reference guide.
#'
#' @keywords internal
#'
#' @rdname sagemakerfeaturestoreruntime_put_record
sagemakerfeaturestoreruntime_put_record <- function(FeatureGroupName, Record, TargetStores = NULL, TtlDuration = NULL) {
op <- new_operation(
name = "PutRecord",
http_method = "PUT",
http_path = "/FeatureGroup/{FeatureGroupName}",
paginator = list()
)
input <- .sagemakerfeaturestoreruntime$put_record_input(FeatureGroupName = FeatureGroupName, Record = Record, TargetStores = TargetStores, TtlDuration = TtlDuration)
output <- .sagemakerfeaturestoreruntime$put_record_output()
config <- get_config()
svc <- .sagemakerfeaturestoreruntime$service(config)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.sagemakerfeaturestoreruntime$operations$put_record <- sagemakerfeaturestoreruntime_put_record
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.