R/sagemakerfeaturestoreruntime_operations.R

In paws.machine.learning: 'Amazon Web Services' Machine Learning Services

# 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",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE,
    http_checksum = NULL
  )
  input <- .sagemakerfeaturestoreruntime$batch_get_record_input(Identifiers = Identifiers, ExpirationTimeResponse = ExpirationTimeResponse)
  output <- .sagemakerfeaturestoreruntime$batch_get_record_output()
  config <- get_config()
  svc <- .sagemakerfeaturestoreruntime$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.sagemakerfeaturestoreruntime$operations$batch_get_record <- sagemakerfeaturestoreruntime_batch_get_record

#' Writes a batch of Records to one or more FeatureGroups
#'
#' @description
#' Writes a batch of `Records` to one or more `FeatureGroup`s. Use this API for bulk ingestion of records into the `OnlineStore` and `OfflineStore`.
#'
#' See [https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_batch_write_record/](https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_batch_write_record/) for full documentation.
#'
#' @param Entries &#91;required&#93; A list of records to write. Each entry specifies the `FeatureGroup`, the record data, and optionally target stores and a TTL duration.
#' @param TtlDuration Time to live duration applied to all entries in the batch that do not specify their own `TtlDuration`; `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_batch_write_record
sagemakerfeaturestoreruntime_batch_write_record <- function(Entries, TtlDuration = NULL) {
  op <- new_operation(
    name = "BatchWriteRecord",
    http_method = "POST",
    http_path = "/BatchWriteRecord",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE,
    http_checksum = NULL
  )
  input <- .sagemakerfeaturestoreruntime$batch_write_record_input(Entries = Entries, TtlDuration = TtlDuration)
  output <- .sagemakerfeaturestoreruntime$batch_write_record_output()
  config <- get_config()
  svc <- .sagemakerfeaturestoreruntime$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.sagemakerfeaturestoreruntime$operations$batch_write_record <- sagemakerfeaturestoreruntime_batch_write_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 &#91;required&#93; The name or Amazon Resource Name (ARN) of the feature group to delete the record from.
#' @param RecordIdentifierValueAsString &#91;required&#93; The value for the `RecordIdentifier` that uniquely identifies the record, in string format.
#' @param EventTime &#91;required&#93; 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}",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE,
    http_checksum = NULL
  )
  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, op)
  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 &#91;required&#93; The name or Amazon Resource Name (ARN) of the feature group from which you want to retrieve a record.
#' @param RecordIdentifierValueAsString &#91;required&#93; 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}",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE,
    http_checksum = NULL
  )
  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, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.sagemakerfeaturestoreruntime$operations$get_record <- sagemakerfeaturestoreruntime_get_record

#' Lists the RecordIdentifier values of all records stored in a
#' FeatureGroup's OnlineStore
#'
#' @description
#' Lists the `RecordIdentifier` values of all records stored in a `FeatureGroup`'s `OnlineStore`. This enables you to discover which records exist without retrieving the full record data.
#'
#' See [https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_list_records/](https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_list_records/) for full documentation.
#'
#' @param FeatureGroupName &#91;required&#93; The name or Amazon Resource Name (ARN) of the feature group to list records from.
#' @param MaxResults The maximum number of record identifiers to return in a single page of results. For the `InMemory` tier, this value is a hint and not a strict requirement. The response may contain more or fewer results than the specified `MaxResults`.
#' @param NextToken A token to resume pagination of [`list_records`][sagemakerfeaturestoreruntime_list_records] results.
#' @param IncludeSoftDeletedRecords If set to `true`, the result includes records that have been soft deleted.
#'
#' @keywords internal
#'
#' @rdname sagemakerfeaturestoreruntime_list_records
sagemakerfeaturestoreruntime_list_records <- function(FeatureGroupName, MaxResults = NULL, NextToken = NULL, IncludeSoftDeletedRecords = NULL) {
  op <- new_operation(
    name = "ListRecords",
    http_method = "POST",
    http_path = "/FeatureGroup/{FeatureGroupName}/ListRecords",
    host_prefix = "",
    paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults", result_key = "RecordIdentifiers"),
    stream_api = FALSE,
    http_checksum = NULL
  )
  input <- .sagemakerfeaturestoreruntime$list_records_input(FeatureGroupName = FeatureGroupName, MaxResults = MaxResults, NextToken = NextToken, IncludeSoftDeletedRecords = IncludeSoftDeletedRecords)
  output <- .sagemakerfeaturestoreruntime$list_records_output()
  config <- get_config()
  svc <- .sagemakerfeaturestoreruntime$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.sagemakerfeaturestoreruntime$operations$list_records <- sagemakerfeaturestoreruntime_list_records

#' 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 &#91;required&#93; The name or Amazon Resource Name (ARN) of the feature group that you want to insert the record into.
#' @param Record &#91;required&#93; 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}",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE,
    http_checksum = NULL
  )
  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, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.sagemakerfeaturestoreruntime$operations$put_record <- sagemakerfeaturestoreruntime_put_record

#' Updates one or more feature values for an existing record in the
#' specified feature group
#'
#' @description
#' Updates one or more feature values for an existing record in the specified feature group. Features that you do not include in the request remain unchanged. You can update up to 100 features per call.
#'
#' See [https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_update_record/](https://www.paws-r-sdk.com/docs/sagemakerfeaturestoreruntime_update_record/) for full documentation.
#'
#' @param FeatureGroupName &#91;required&#93; The identifier for the feature group that contains the record to update. You can specify one of the following:
#' 
#' -   The feature group name.
#' 
#' -   The feature group Amazon Resource Name (ARN).
#' @param RecordIdentifierValueAsString &#91;required&#93; The value that uniquely identifies the record in the feature group. This must match the value defined by the feature group's record identifier feature.
#' @param Features &#91;required&#93; The feature values to write to the record.
#' @param TargetStores The target stores for the record update. By default, Amazon SageMaker Feature Store updates the record in all stores associated with the `FeatureGroup`.
#' @param TtlDuration The time-to-live (TTL) duration for the record. Amazon SageMaker Feature Store deletes the record when `EventTime` + `TtlDuration` elapses. If you omit this parameter, the record's existing TTL setting remains unchanged. For information about `HardDelete`, see the [`delete_record`][sagemakerfeaturestoreruntime_delete_record] operation in the Amazon SageMaker API Reference.
#'
#' @keywords internal
#'
#' @rdname sagemakerfeaturestoreruntime_update_record
sagemakerfeaturestoreruntime_update_record <- function(FeatureGroupName, RecordIdentifierValueAsString, Features, TargetStores = NULL, TtlDuration = NULL) {
  op <- new_operation(
    name = "UpdateRecord",
    http_method = "POST",
    http_path = "/FeatureGroup/{FeatureGroupName}/Record",
    host_prefix = "",
    paginator = list(),
    stream_api = FALSE,
    http_checksum = NULL
  )
  input <- .sagemakerfeaturestoreruntime$update_record_input(FeatureGroupName = FeatureGroupName, RecordIdentifierValueAsString = RecordIdentifierValueAsString, Features = Features, TargetStores = TargetStores, TtlDuration = TtlDuration)
  output <- .sagemakerfeaturestoreruntime$update_record_output()
  config <- get_config()
  svc <- .sagemakerfeaturestoreruntime$service(config, op)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.sagemakerfeaturestoreruntime$operations$update_record <- sagemakerfeaturestoreruntime_update_record