Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.CreateFeatureGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 FeatureGroups quota for your Amazon Web Services account.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

Synopsis

Creating a Request

data CreateFeatureGroup Source #

See: newCreateFeatureGroup smart constructor.

Constructors

CreateFeatureGroup'

Fields

description :: Maybe Text
A free-form description of a FeatureGroup.
offlineStoreConfig :: Maybe 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.
onlineStoreConfig :: Maybe 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 Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
tags :: Maybe [Tag]
Tags used to identify Features in each FeatureGroup.
featureGroupName :: Text
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.
recordIdentifierFeatureName :: Text
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 :: Text
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 :: NonEmpty FeatureDefinition
A list of Feature names and types. Name and Type is compulsory per Feature.
Valid feature 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.

Instances

Instances details

ToJSON CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods toJSON :: CreateFeatureGroup -> Value # toEncoding :: CreateFeatureGroup -> Encoding # toJSONList :: [CreateFeatureGroup] -> Value # toEncodingList :: [CreateFeatureGroup] -> Encoding #
ToHeaders CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods toHeaders :: CreateFeatureGroup -> [Header] #
ToPath CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods toPath :: CreateFeatureGroup -> ByteString #
ToQuery CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods toQuery :: CreateFeatureGroup -> QueryString #
AWSRequest CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Associated Types type AWSResponse CreateFeatureGroup # Methods request :: (Service -> Service) -> CreateFeatureGroup -> Request CreateFeatureGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFeatureGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFeatureGroup))) #
Generic CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Associated Types type Rep CreateFeatureGroup :: Type -> Type # Methods from :: CreateFeatureGroup -> Rep CreateFeatureGroup x # to :: Rep CreateFeatureGroup x -> CreateFeatureGroup #
Read CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods readsPrec :: Int -> ReadS CreateFeatureGroup # readList :: ReadS [CreateFeatureGroup] # readPrec :: ReadPrec CreateFeatureGroup # readListPrec :: ReadPrec [CreateFeatureGroup] #
Show CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods showsPrec :: Int -> CreateFeatureGroup -> ShowS # show :: CreateFeatureGroup -> String # showList :: [CreateFeatureGroup] -> ShowS #
NFData CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods rnf :: CreateFeatureGroup -> () #
Eq CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods (==) :: CreateFeatureGroup -> CreateFeatureGroup -> Bool # (/=) :: CreateFeatureGroup -> CreateFeatureGroup -> Bool #
Hashable CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods hashWithSalt :: Int -> CreateFeatureGroup -> Int # hash :: CreateFeatureGroup -> Int #
type AWSResponse CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup type AWSResponse CreateFeatureGroup = CreateFeatureGroupResponse
type Rep CreateFeatureGroup Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup type Rep CreateFeatureGroup = D1 ('MetaData "CreateFeatureGroup" "Amazonka.SageMaker.CreateFeatureGroup" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateFeatureGroup'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "offlineStoreConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OfflineStoreConfig))) :: (S1 ('MetaSel ('Just "onlineStoreConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnlineStoreConfig)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "featureGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "recordIdentifierFeatureName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "eventTimeFeatureName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "featureDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty FeatureDefinition)))))))

newCreateFeatureGroup Source #

Arguments

:: Text	`CreateFeatureGroup`
-> Text	`CreateFeatureGroup`
-> Text	`CreateFeatureGroup`
-> NonEmpty FeatureDefinition	`CreateFeatureGroup`
-> CreateFeatureGroup

Create a value of CreateFeatureGroup 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:

CreateFeatureGroup, createFeatureGroup_description - A free-form description of a FeatureGroup.

CreateFeatureGroup, createFeatureGroup_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.

CreateFeatureGroup, createFeatureGroup_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 Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

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

CreateFeatureGroup, createFeatureGroup_tags - Tags used to identify Features in each FeatureGroup.

CreateFeatureGroup, createFeatureGroup_featureGroupName - 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.

CreateFeatureGroup, createFeatureGroup_recordIdentifierFeatureName - 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.

CreateFeatureGroup, createFeatureGroup_eventTimeFeatureName - 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.

CreateFeatureGroup, createFeatureGroup_featureDefinitions - A list of Feature names and types. Name and Type is compulsory per Feature.

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

Request Lenses

createFeatureGroup_description :: Lens' CreateFeatureGroup (Maybe Text) Source #

A free-form description of a FeatureGroup.

createFeatureGroup_offlineStoreConfig :: Lens' CreateFeatureGroup (Maybe OfflineStoreConfig) Source #

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.

createFeatureGroup_onlineStoreConfig :: Lens' CreateFeatureGroup (Maybe OnlineStoreConfig) Source #

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 Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

createFeatureGroup_roleArn :: Lens' CreateFeatureGroup (Maybe Text) Source #

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

createFeatureGroup_tags :: Lens' CreateFeatureGroup (Maybe [Tag]) Source #

Tags used to identify Features in each FeatureGroup.

createFeatureGroup_featureGroupName :: Lens' CreateFeatureGroup Text Source #

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.

createFeatureGroup_recordIdentifierFeatureName :: Lens' CreateFeatureGroup Text Source #

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.

createFeatureGroup_eventTimeFeatureName :: Lens' CreateFeatureGroup Text Source #

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.

createFeatureGroup_featureDefinitions :: Lens' CreateFeatureGroup (NonEmpty FeatureDefinition) Source #

A list of Feature names and types. Name and Type is compulsory per Feature.

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

Destructuring the Response

data CreateFeatureGroupResponse Source #

See: newCreateFeatureGroupResponse smart constructor.

Constructors

CreateFeatureGroupResponse'
Fields httpStatus :: Int The response's http status code. featureGroupArn :: Text The Amazon Resource Name (ARN) of the `FeatureGroup`. This is a unique identifier for the feature group.

Instances

Instances details

Generic CreateFeatureGroupResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Associated Types type Rep CreateFeatureGroupResponse :: Type -> Type # Methods from :: CreateFeatureGroupResponse -> Rep CreateFeatureGroupResponse x # to :: Rep CreateFeatureGroupResponse x -> CreateFeatureGroupResponse #
Read CreateFeatureGroupResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods readsPrec :: Int -> ReadS CreateFeatureGroupResponse # readList :: ReadS [CreateFeatureGroupResponse] # readPrec :: ReadPrec CreateFeatureGroupResponse # readListPrec :: ReadPrec [CreateFeatureGroupResponse] #
Show CreateFeatureGroupResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods showsPrec :: Int -> CreateFeatureGroupResponse -> ShowS # show :: CreateFeatureGroupResponse -> String # showList :: [CreateFeatureGroupResponse] -> ShowS #
NFData CreateFeatureGroupResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods rnf :: CreateFeatureGroupResponse -> () #
Eq CreateFeatureGroupResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup Methods (==) :: CreateFeatureGroupResponse -> CreateFeatureGroupResponse -> Bool # (/=) :: CreateFeatureGroupResponse -> CreateFeatureGroupResponse -> Bool #
type Rep CreateFeatureGroupResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateFeatureGroup type Rep CreateFeatureGroupResponse = D1 ('MetaData "CreateFeatureGroupResponse" "Amazonka.SageMaker.CreateFeatureGroup" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateFeatureGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "featureGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateFeatureGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateFeatureGroupResponse'`
-> Text	`CreateFeatureGroupResponse`
-> CreateFeatureGroupResponse

Create a value of CreateFeatureGroupResponse 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:httpStatus:CreateFeatureGroupResponse', createFeatureGroupResponse_httpStatus - The response's http status code.

CreateFeatureGroupResponse, createFeatureGroupResponse_featureGroupArn - The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.

Response Lenses

createFeatureGroupResponse_httpStatus :: Lens' CreateFeatureGroupResponse Int Source #

The response's http status code.

createFeatureGroupResponse_featureGroupArn :: Lens' CreateFeatureGroupResponse Text Source #

The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.