Skip to content

Create Feature Group

sagemaker_create_feature_group R Documentation

Create a new FeatureGroup

Description

Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

Usage

sagemaker_create_feature_group(FeatureGroupName,
  RecordIdentifierFeatureName, EventTimeFeatureName, FeatureDefinitions,
  OnlineStoreConfig, OfflineStoreConfig, ThroughputConfig, RoleArn,
  Description, Tags)

Arguments

FeatureGroupName

[required] The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

The name:

  • Must start with an alphanumeric character.

  • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

RecordIdentifierFeatureName

[required] The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.

You use the RecordIdentifierFeatureName to access data in a FeatureStore.

This name:

  • Must start with an alphanumeric character.

  • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

EventTimeFeatureName

[required] The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

An EventTime can be a String or Fractional.

  • Fractional: EventTime feature values must be a Unix timestamp in seconds.

  • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported ⁠yyyy-MM-dd'T'HH:mm:ssZ⁠ and ⁠yyyy-MM-dd'T'HH:mm:ss.SSSZ⁠ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.

FeatureDefinitions

[required] A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

OnlineStoreConfig

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

The default value is False.

OfflineStoreConfig

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

  • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

  • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

  • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

  • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

To learn more about this parameter, see OfflineStoreConfig.

ThroughputConfig
RoleArn

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

Description

A free-form description of a FeatureGroup.

Tags

Tags used to identify Features in each FeatureGroup.

Value

A list with the following syntax: 

list(
  FeatureGroupArn = "string"
)

Request syntax

svc$create_feature_group(
  FeatureGroupName = "string",
  RecordIdentifierFeatureName = "string",
  EventTimeFeatureName = "string",
  FeatureDefinitions = list(
    list(
      FeatureName = "string",
      FeatureType = "Integral"|"Fractional"|"String",
      CollectionType = "List"|"Set"|"Vector",
      CollectionConfig = list(
        VectorConfig = list(
          Dimension = 123
        )
      )
    )
  ),
  OnlineStoreConfig = list(
    SecurityConfig = list(
      KmsKeyId = "string"
    ),
    EnableOnlineStore = TRUE|FALSE,
    TtlDuration = list(
      Unit = "Seconds"|"Minutes"|"Hours"|"Days"|"Weeks",
      Value = 123
    ),
    StorageType = "Standard"|"InMemory"
  ),
  OfflineStoreConfig = list(
    S3StorageConfig = list(
      S3Uri = "string",
      KmsKeyId = "string",
      ResolvedOutputS3Uri = "string"
    ),
    DisableGlueTableCreation = TRUE|FALSE,
    DataCatalogConfig = list(
      TableName = "string",
      Catalog = "string",
      Database = "string"
    ),
    TableFormat = "Default"|"Glue"|"Iceberg"
  ),
  ThroughputConfig = list(
    ThroughputMode = "OnDemand"|"Provisioned",
    ProvisionedReadCapacityUnits = 123,
    ProvisionedWriteCapacityUnits = 123
  ),
  RoleArn = "string",
  Description = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)