Struct aws_sdk_sagemaker::types::FeatureGroup

#[non_exhaustive]
pub struct FeatureGroup {

    pub feature_group_arn: Option<String>,
    pub feature_group_name: Option<String>,
    pub record_identifier_feature_name: Option<String>,
    pub event_time_feature_name: Option<String>,
    pub feature_definitions: Option<Vec<FeatureDefinition>>,
    pub creation_time: Option<DateTime>,
    pub last_modified_time: Option<DateTime>,
    pub online_store_config: Option<OnlineStoreConfig>,
    pub offline_store_config: Option<OfflineStoreConfig>,
    pub role_arn: Option<String>,
    pub feature_group_status: Option<FeatureGroupStatus>,
    pub offline_store_status: Option<OfflineStoreStatus>,
    pub last_update_status: Option<LastUpdateStatus>,
    pub failure_reason: Option<String>,
    pub description: Option<String>,
    pub tags: Option<Vec<Tag>>,
}

Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

feature_group_arn: Option<String>

The Amazon Resource Name (ARN) of a FeatureGroup.

feature_group_name: Option<String>

The name of the FeatureGroup.

record_identifier_feature_name: Option<String>

The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

event_time_feature_name: Option<String>

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

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

feature_definitions: Option<Vec<FeatureDefinition>>

A list of Features. Each Feature must include a FeatureName and a FeatureType.

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

creation_time: Option<DateTime>

The time a FeatureGroup was created.

last_modified_time: Option<DateTime>

A timestamp indicating the last time you updated the feature group.

online_store_config: Option<OnlineStoreConfig>

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly.

The default value is False.

offline_store_config: Option<OfflineStoreConfig>

The configuration of an OfflineStore.

Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.

role_arn: Option<String>

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

feature_group_status: Option<FeatureGroupStatus>

A FeatureGroup status.

offline_store_status: Option<OfflineStoreStatus>

The status of OfflineStore.

last_update_status: Option<LastUpdateStatus>

A value that indicates whether the feature group was updated successfully.

failure_reason: Option<String>

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

description: Option<String>

A free form description of a FeatureGroup.

tags: Option<Vec<Tag>>

Tags used to define a FeatureGroup.

Implementations

impl FeatureGroup

pub fn feature_group_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of a FeatureGroup.

pub fn feature_group_name(&self) -> Option<&str>

The name of the FeatureGroup.

pub fn record_identifier_feature_name(&self) -> Option<&str>

The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

pub fn event_time_feature_name(&self) -> Option<&str>

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

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

pub fn feature_definitions(&self) -> &[FeatureDefinition]

A list of Features. Each Feature must include a FeatureName and a FeatureType.

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .feature_definitions.is_none().

pub fn creation_time(&self) -> Option<&DateTime>

The time a FeatureGroup was created.

pub fn last_modified_time(&self) -> Option<&DateTime>

A timestamp indicating the last time you updated the feature group.

pub fn online_store_config(&self) -> Option<&OnlineStoreConfig>

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly.

The default value is False.

pub fn offline_store_config(&self) -> Option<&OfflineStoreConfig>

The configuration of an OfflineStore.

Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.

pub fn role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

pub fn feature_group_status(&self) -> Option<&FeatureGroupStatus>

A FeatureGroup status.

pub fn offline_store_status(&self) -> Option<&OfflineStoreStatus>

The status of OfflineStore.

pub fn last_update_status(&self) -> Option<&LastUpdateStatus>

A value that indicates whether the feature group was updated successfully.

pub fn failure_reason(&self) -> Option<&str>

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

pub fn description(&self) -> Option<&str>

A free form description of a FeatureGroup.

pub fn tags(&self) -> &[Tag]

Tags used to define a FeatureGroup.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl FeatureGroup

pub fn builder() -> FeatureGroupBuilder

Creates a new builder-style object to manufacture FeatureGroup.

Trait Implementations

impl Clone for FeatureGroup

fn clone(&self) -> FeatureGroup

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FeatureGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for FeatureGroup

fn eq(&self, other: &FeatureGroup) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FeatureGroup