Update Feature Group

sagemaker_update_feature_group

R Documentation

Updates the feature group by either adding features or updating the online store configuration¶

Description¶

Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the update_feature_group API.

You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group.

You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all records added to the feature group after the feature group is updated. If a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the default TtlDuration. To remove the default TtlDuration from an existing feature group, use the update_feature_group API and set the TtlDuration Unit and Value to null.

Usage¶

sagemaker_update_feature_group(FeatureGroupName, FeatureAdditions,
  OnlineStoreConfig, ThroughputConfig)

Arguments¶

FeatureGroupName

[required] The name or Amazon Resource Name (ARN) of the feature group that you're updating.

FeatureAdditions

Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you've made a valid request. It takes some time after you've made a valid request for Feature Store to update the feature group.

OnlineStoreConfig

Updates the feature group online store configuration.

ThroughputConfig

Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

Value¶

A list with the following syntax:

list(
  FeatureGroupArn = "string"
)

Request syntax¶

svc$update_feature_group(
  FeatureGroupName = "string",
  FeatureAdditions = list(
    list(
      FeatureName = "string",
      FeatureType = "Integral"|"Fractional"|"String",
      CollectionType = "List"|"Set"|"Vector",
      CollectionConfig = list(
        VectorConfig = list(
          Dimension = 123
        )
      )
    )
  ),
  OnlineStoreConfig = list(
    TtlDuration = list(
      Unit = "Seconds"|"Minutes"|"Hours"|"Days"|"Weeks",
      Value = 123
    )
  ),
  ThroughputConfig = list(
    ThroughputMode = "OnDemand"|"Provisioned",
    ProvisionedReadCapacityUnits = 123,
    ProvisionedWriteCapacityUnits = 123
  )
)