UpdateFeatureGroup - Amazon SageMaker (original) (raw)

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 theUpdateFeatureGroup 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 theOnlineStoreConfig 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 levelTtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the defaultTtlDuration. To remove the default TtlDuration from an existing feature group, use the UpdateFeatureGroup API and set theTtlDuration Unit and Value to null.

Request Syntax

{
   "FeatureAdditions": [ 
      { 
         "CollectionConfig": { ... },
         "CollectionType": "string",
         "FeatureName": "string",
         "FeatureType": "string"
      }
   ],
   "FeatureGroupName": "string",
   "OnlineStoreConfig": { 
      "TtlDuration": { 
         "Unit": "string",
         "Value": number
      }
   },
   "ThroughputConfig": { 
      "ProvisionedReadCapacityUnits": number,
      "ProvisionedWriteCapacityUnits": number,
      "ThroughputMode": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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.

Type: Array of FeatureDefinition objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

FeatureGroupName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})

Required: Yes

OnlineStoreConfig

Updates the feature group online store configuration.

Type: OnlineStoreConfigUpdate object

Required: No

ThroughputConfig

The new throughput configuration for the feature group. You can switch between on-demand and provisioned modes or update the read / write capacity of provisioned feature groups. You can switch a feature group to on-demand only once in a 24 hour period.

Type: ThroughputConfigUpdate object

Required: No

Response Syntax

{
   "FeatureGroupArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FeatureGroupArn

The Amazon Resource Number (ARN) of the feature group that you're updating.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/.*

Errors

For information about the errors that are common to all actions, see Common Error Types.

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: