Amazonka.SageMaker.Types.FeatureGroup

Documentation

data FeatureGroup

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.

See: newFeatureGroup smart constructor.

Constructors

FeatureGroup'

Fields

• creationTime :: Maybe POSIX

  The time a FeatureGroup was created.

• description :: Maybe Text

  A free form description of a FeatureGroup.

• eventTimeFeatureName :: Maybe Text

  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.

• failureReason :: Maybe Text

  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.

• featureDefinitions :: Maybe (NonEmpty 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.

• featureGroupArn :: Maybe Text

  The Amazon Resource Name (ARN) of a FeatureGroup.

• featureGroupName :: Maybe Text

  The name of the FeatureGroup.

• featureGroupStatus :: Maybe FeatureGroupStatus

  A FeatureGroup status.

• lastModifiedTime :: Maybe POSIX

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

• lastUpdateStatus :: Maybe LastUpdateStatus

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

• offlineStoreConfig :: Maybe OfflineStoreConfig
• offlineStoreStatus :: Maybe OfflineStoreStatus
• onlineStoreConfig :: Maybe OnlineStoreConfig
• recordIdentifierFeatureName :: Maybe Text

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

• roleArn :: Maybe Text

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

• tags :: Maybe [Tag]

  Tags used to define a FeatureGroup.

Instances

FromJSON FeatureGroup

Defined in Amazonka.SageMaker.Types.FeatureGroup

Methods

parseJSON :: Value -> Parser FeatureGroup

parseJSONList :: Value -> Parser [FeatureGroup]

Generic FeatureGroup

Defined in Amazonka.SageMaker.Types.FeatureGroup

Associated Types

type Rep FeatureGroup :: Type -> Type

Methods

from :: FeatureGroup -> Rep FeatureGroup x

to :: Rep FeatureGroup x -> FeatureGroup

Read FeatureGroup

Defined in Amazonka.SageMaker.Types.FeatureGroup

Methods

readsPrec :: Int -> ReadS FeatureGroup

readList :: ReadS [FeatureGroup]

readPrec :: ReadPrec FeatureGroup

readListPrec :: ReadPrec [FeatureGroup]

Show FeatureGroup

Defined in Amazonka.SageMaker.Types.FeatureGroup

Methods

showsPrec :: Int -> FeatureGroup -> ShowS

show :: FeatureGroup -> String

showList :: [FeatureGroup] -> ShowS

NFData FeatureGroup

Defined in Amazonka.SageMaker.Types.FeatureGroup

Methods

rnf :: FeatureGroup -> ()

Eq FeatureGroup

Defined in Amazonka.SageMaker.Types.FeatureGroup

Methods

(==) :: FeatureGroup -> FeatureGroup -> Bool

(/=) :: FeatureGroup -> FeatureGroup -> Bool

Hashable FeatureGroup

Defined in Amazonka.SageMaker.Types.FeatureGroup

Methods

hashWithSalt :: Int -> FeatureGroup -> Int

hash :: FeatureGroup -> Int

type Rep FeatureGroup

Defined in Amazonka.SageMaker.Types.FeatureGroup

type Rep FeatureGroup = D1 ('MetaData "FeatureGroup" "Amazonka.SageMaker.Types.FeatureGroup" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "FeatureGroup'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "eventTimeFeatureName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "featureDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty FeatureDefinition))) :*: S1 ('MetaSel ('Just "featureGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "featureGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "featureGroupStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FeatureGroupStatus))))) :*: (((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lastUpdateStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LastUpdateStatus))) :*: (S1 ('MetaSel ('Just "offlineStoreConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OfflineStoreConfig)) :*: S1 ('MetaSel ('Just "offlineStoreStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OfflineStoreStatus)))) :*: ((S1 ('MetaSel ('Just "onlineStoreConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnlineStoreConfig)) :*: S1 ('MetaSel ('Just "recordIdentifierFeatureName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))))))

newFeatureGroup :: FeatureGroup

Create a value of FeatureGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:FeatureGroup', featureGroup_creationTime - The time a FeatureGroup was created.

$sel:description:FeatureGroup', featureGroup_description - A free form description of a FeatureGroup.

$sel:eventTimeFeatureName:FeatureGroup', featureGroup_eventTimeFeatureName - 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.

FeatureGroup, featureGroup_failureReason - 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.

$sel:featureDefinitions:FeatureGroup', featureGroup_featureDefinitions - 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.

$sel:featureGroupArn:FeatureGroup', featureGroup_featureGroupArn - The Amazon Resource Name (ARN) of a FeatureGroup.

$sel:featureGroupName:FeatureGroup', featureGroup_featureGroupName - The name of the FeatureGroup.

$sel:featureGroupStatus:FeatureGroup', featureGroup_featureGroupStatus - A FeatureGroup status.

$sel:lastModifiedTime:FeatureGroup', featureGroup_lastModifiedTime - A timestamp indicating the last time you updated the feature group.

$sel:lastUpdateStatus:FeatureGroup', featureGroup_lastUpdateStatus - A value that indicates whether the feature group was updated successfully.

$sel:offlineStoreConfig:FeatureGroup', featureGroup_offlineStoreConfig - Undocumented member.

$sel:offlineStoreStatus:FeatureGroup', featureGroup_offlineStoreStatus - Undocumented member.

$sel:onlineStoreConfig:FeatureGroup', featureGroup_onlineStoreConfig - Undocumented member.

$sel:recordIdentifierFeatureName:FeatureGroup', featureGroup_recordIdentifierFeatureName - The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

$sel:roleArn:FeatureGroup', featureGroup_roleArn - The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

$sel:tags:FeatureGroup', featureGroup_tags - Tags used to define a FeatureGroup.

featureGroup_creationTime :: Lens' FeatureGroup (Maybe UTCTime)

The time a FeatureGroup was created.

featureGroup_description :: Lens' FeatureGroup (Maybe Text)

A free form description of a FeatureGroup.

featureGroup_eventTimeFeatureName :: Lens' FeatureGroup (Maybe Text)

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.

featureGroup_failureReason :: Lens' FeatureGroup (Maybe Text)

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.

featureGroup_featureDefinitions :: Lens' FeatureGroup (Maybe (NonEmpty 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.

featureGroup_featureGroupArn :: Lens' FeatureGroup (Maybe Text)

The Amazon Resource Name (ARN) of a FeatureGroup.

featureGroup_featureGroupName :: Lens' FeatureGroup (Maybe Text)

The name of the FeatureGroup.

featureGroup_featureGroupStatus :: Lens' FeatureGroup (Maybe FeatureGroupStatus)

A FeatureGroup status.

featureGroup_lastModifiedTime :: Lens' FeatureGroup (Maybe UTCTime)

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

featureGroup_lastUpdateStatus :: Lens' FeatureGroup (Maybe LastUpdateStatus)

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

featureGroup_offlineStoreConfig :: Lens' FeatureGroup (Maybe OfflineStoreConfig)

Undocumented member.

featureGroup_offlineStoreStatus :: Lens' FeatureGroup (Maybe OfflineStoreStatus)

Undocumented member.

featureGroup_onlineStoreConfig :: Lens' FeatureGroup (Maybe OnlineStoreConfig)

Undocumented member.

featureGroup_recordIdentifierFeatureName :: Lens' FeatureGroup (Maybe Text)

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

featureGroup_roleArn :: Lens' FeatureGroup (Maybe Text)

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

featureGroup_tags :: Lens' FeatureGroup (Maybe [Tag])

Tags used to define a FeatureGroup.