Class: Aws::SageMaker::Types::CreateFeatureGroupRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A free-form description of a ‘FeatureGroup`.

Returns:

  • (String) 


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5840

class CreateFeatureGroupRequest < Struct.new(
  :feature_group_name,
  :record_identifier_feature_name,
  :event_time_feature_name,
  :feature_definitions,
  :online_store_config,
  :offline_store_config,
  :role_arn,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#event_time_feature_name ⇒ String

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.

Returns:

  • (String) 


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5840

class CreateFeatureGroupRequest < Struct.new(
  :feature_group_name,
  :record_identifier_feature_name,
  :event_time_feature_name,
  :feature_definitions,
  :online_store_config,
  :offline_store_config,
  :role_arn,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#feature_definitions ⇒ Array<Types::FeatureDefinition>

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`.

Returns:



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5840

class CreateFeatureGroupRequest < Struct.new(
  :feature_group_name,
  :record_identifier_feature_name,
  :event_time_feature_name,
  :feature_definitions,
  :online_store_config,
  :offline_store_config,
  :role_arn,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#feature_group_name ⇒ String

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 and end with an alphanumeric character.

  • Can only contain alphanumeric character and hyphens. Spaces are not allowed.

Returns:

  • (String) 


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5840

class CreateFeatureGroupRequest < Struct.new(
  :feature_group_name,
  :record_identifier_feature_name,
  :event_time_feature_name,
  :feature_definitions,
  :online_store_config,
  :offline_store_config,
  :role_arn,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#offline_store_config ⇒ Types::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].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html [2]: iceberg.apache.org/ [3]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_OfflineStoreConfig.html

Returns:



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5840

class CreateFeatureGroupRequest < Struct.new(
  :feature_group_name,
  :record_identifier_feature_name,
  :event_time_feature_name,
  :feature_definitions,
  :online_store_config,
  :offline_store_config,
  :role_arn,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#online_store_config ⇒ Types::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`.

Returns:



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5840

class CreateFeatureGroupRequest < Struct.new(
  :feature_group_name,
  :record_identifier_feature_name,
  :event_time_feature_name,
  :feature_definitions,
  :online_store_config,
  :offline_store_config,
  :role_arn,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#record_identifier_feature_name ⇒ String

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.

Returns:

  • (String) 


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5840

class CreateFeatureGroupRequest < Struct.new(
  :feature_group_name,
  :record_identifier_feature_name,
  :event_time_feature_name,
  :feature_definitions,
  :online_store_config,
  :offline_store_config,
  :role_arn,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

  • (String) 


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5840

class CreateFeatureGroupRequest < Struct.new(
  :feature_group_name,
  :record_identifier_feature_name,
  :event_time_feature_name,
  :feature_definitions,
  :online_store_config,
  :offline_store_config,
  :role_arn,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Tags used to identify ‘Features` in each `FeatureGroup`.

Returns:



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 5840

class CreateFeatureGroupRequest < Struct.new(
  :feature_group_name,
  :record_identifier_feature_name,
  :event_time_feature_name,
  :feature_definitions,
  :online_store_config,
  :offline_store_config,
  :role_arn,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end