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 FeatureGroup
s 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 aRecord
defined in theFeatureStore
. Only the latest record per identifier value will be stored in theOnlineStore
.RecordIdentifierFeatureName
must be one of feature definitions' names.You use the
RecordIdentifierFeatureName
to access data in aFeatureStore
.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 aRecord
in aFeatureGroup
.An
EventTime
is a point in time when a new event occurs that corresponds to the creation or update of aRecord
in aFeatureGroup
. AllRecords
in theFeatureGroup
must have a correspondingEventTime
.An
EventTime
can be aString
orFractional
.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 supportedyyyy-MM-dd'T'HH:mm:ssZ
andyyyy-MM-dd'T'HH:mm:ss.SSSZ
whereyyyy
,MM
, anddd
represent the year, month, and day respectively andHH
,mm
,ss
, and if applicable,SSS
represent the hour, month, second and milliseconds respsectively.'T'
andZ
are constants.
FeatureDefinitions
[required] A list of
Feature
names and types.Name
andType
is compulsory perFeature
.Valid feature
FeatureType
s areIntegral
,Fractional
andString
.FeatureName
s cannot be any of the following:is_deleted
,write_time
,api_invocation_time
You can create up to 2,500
FeatureDefinition
s perFeatureGroup
.OnlineStoreConfig
You can turn the
OnlineStore
on or off by specifyingTrue
for theEnableOnlineStore
flag inOnlineStoreConfig
.You can also include an Amazon Web Services KMS key ID (
KMSKeyId
) for at-rest encryption of theOnlineStore
.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.
RoleArn
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the
OfflineStore
if anOfflineStoreConfig
is provided.Description
A free-form description of a
FeatureGroup
.Tags
Tags used to identify
Features
in eachFeatureGroup
.
Value¶
A list with the following syntax:
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"
)
)
)