paws.machine.learning: sagemaker_create_feature_group – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

paws.machine.learning

sagemaker_create_feature_group

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 AWS service quotas to see the FeatureGroups quota for your AWS account.

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, RoleArn, Description, Tags)

Arguments

`FeatureGroupName`	[required] The name of the `FeatureGroup`. The name must be unique within an AWS Region in an AWS account. The name: Must start and end with an alphanumeric character. Can only contain alphanumeric character 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 and end 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 `FeatureType`s are `Integral`, `Fractional` and `String`. `FeatureName`s cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time` You can create up to 2,500 `FeatureDefinition`s per `FeatureGroup`.
`OnlineStoreConfig`	You can turn the `OnlineStore` on or off by specifying `True` for the `EnableOnlineStore` flag in `OnlineStoreConfig`; the default value is `False`. You can also include an AWS KMS key ID (`KMSKeyId`) for at-rest encryption of the `OnlineStore`.
`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 AWS Glue or AWS Hive data cataolgue. An KMS encryption key to encrypt the Amazon S3 location used for `OfflineStore`. 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 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"
    )
  ),
  OnlineStoreConfig = list(
    SecurityConfig = list(
      KmsKeyId = "string"
    ),
    EnableOnlineStore = TRUE|FALSE
  ),
  OfflineStoreConfig = list(
    S3StorageConfig = list(
      S3Uri = "string",
      KmsKeyId = "string"
    ),
    DisableGlueTableCreation = TRUE|FALSE,
    DataCatalogConfig = list(
      TableName = "string",
      Catalog = "string",
      Database = "string"
    )
  ),
  RoleArn = "string",
  Description = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

paws.machine.learning

Amazon Web Services Machine Learning Services

v0.1.11

Apache License (>= 2.0)

Authors

David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]

Initial release

sagemaker_create_feature_group

Description

Usage

Arguments

Value

Request syntax

paws.machine.learning

We don't support your browser anymore