AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon SageMaker Service CreateFeatureGroup API operation.

Syntax

New-SMFeatureGroup
-FeatureGroupName <String>
-DataCatalogConfig_Catalog <String>
-DataCatalogConfig_Database <String>
-Description <String>
-OfflineStoreConfig_DisableGlueTableCreation <Boolean>
-OnlineStoreConfig_EnableOnlineStore <Boolean>
-EventTimeFeatureName <String>
-FeatureDefinition <FeatureDefinition[]>
-S3StorageConfig_KmsKeyId <String>
-SecurityConfig_KmsKeyId <String>
-ThroughputConfig_ProvisionedReadCapacityUnit <Int32>
-ThroughputConfig_ProvisionedWriteCapacityUnit <Int32>
-RecordIdentifierFeatureName <String>
-S3StorageConfig_ResolvedOutputS3Uri <String>
-RoleArn <String>
-S3StorageConfig_S3Uri <String>
-OnlineStoreConfig_StorageType <StorageType>
-OfflineStoreConfig_TableFormat <TableFormat>
-DataCatalogConfig_TableName <String>
-Tag <Tag[]>
-ThroughputConfig_ThroughputMode <ThroughputMode>
-TtlDuration_Unit <TtlDurationUnit>
-TtlDuration_Value <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonSageMakerConfig>

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. Note that it can take approximately 10-15 minutes to provision an OnlineStoreFeatureGroup with the InMemoryStorageType. You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

Parameters

-ClientConfig <AmazonSageMakerConfig>
Amazon.PowerShell.Cmdlets.SM.AmazonSageMakerClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataCatalogConfig_Catalog <String>
The name of the Glue table catalog.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOfflineStoreConfig_DataCatalogConfig_Catalog
-DataCatalogConfig_Database <String>
The name of the Glue table database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOfflineStoreConfig_DataCatalogConfig_Database
-DataCatalogConfig_TableName <String>
The name of the Glue table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOfflineStoreConfig_DataCatalogConfig_TableName
-Description <String>
A free-form description of a FeatureGroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EventTimeFeatureName <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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FeatureDefinition <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_timeYou can create up to 2,500 FeatureDefinitions per FeatureGroup.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFeatureDefinitions
-FeatureGroupName <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 with an alphanumeric character.
  • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OfflineStoreConfig_DisableGlueTableCreation <Boolean>
Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to False, Feature Store will name the OfflineStore Glue table following Athena's naming recommendations.The default value is False.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OfflineStoreConfig_TableFormat <TableFormat>
Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OnlineStoreConfig_EnableOnlineStore <Boolean>
Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag. The default value is False.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OnlineStoreConfig_StorageType <StorageType>
Option for different tiers of low latency storage for real-time data retrieval.
  • Standard: A managed low latency data store for feature groups.
  • InMemory: A managed data store for feature groups that supports very low latency retrieval.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the FeatureGroupName parameter. The -PassThru parameter is deprecated, use -Select '^FeatureGroupName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RecordIdentifierFeatureName <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 with an alphanumeric character.
  • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3StorageConfig_KmsKeyId <String>
The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:
  • "kms:GenerateDataKey"
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOfflineStoreConfig_S3StorageConfig_KmsKeyId
-S3StorageConfig_ResolvedOutputS3Uri <String>
The S3 path where offline records are written.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOfflineStoreConfig_S3StorageConfig_ResolvedOutputS3Uri
-S3StorageConfig_S3Uri <String>
The S3 URI, or location in Amazon S3, of OfflineStore.S3 URIs have a format similar to the following: s3://example-bucket/prefix/.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOfflineStoreConfig_S3StorageConfig_S3Uri
-SecurityConfig_KmsKeyId <String>
The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStoreKmsKeyId:
  • "kms:Encrypt"
  • "kms:Decrypt"
  • "kms:DescribeKey"
  • "kms:CreateGrant"
  • "kms:RetireGrant"
  • "kms:ReEncryptFrom"
  • "kms:ReEncryptTo"
  • "kms:GenerateDataKey"
  • "kms:ListAliases"
  • "kms:ListGrants"
  • "kms:RevokeGrant"
The caller (either user or IAM role) to all DataPlane operations (PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:
  • "kms:Decrypt"
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnlineStoreConfig_SecurityConfig_KmsKeyId
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'FeatureGroupArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateFeatureGroupResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateFeatureGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Tags used to identify Features in each FeatureGroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-ThroughputConfig_ProvisionedReadCapacityUnit <Int32>
For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling. This field is not applicable for on-demand feature groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesThroughputConfig_ProvisionedReadCapacityUnits
-ThroughputConfig_ProvisionedWriteCapacityUnit <Int32>
For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling. This field is not applicable for on-demand feature groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesThroughputConfig_ProvisionedWriteCapacityUnits
-ThroughputConfig_ThroughputMode <ThroughputMode>
The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TtlDuration_Unit <TtlDurationUnit>
TtlDuration time unit.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnlineStoreConfig_TtlDuration_Unit
-TtlDuration_Value <Int32>
TtlDuration time value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnlineStoreConfig_TtlDuration_Value

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.SageMaker.Model.CreateFeatureGroupResponse
This cmdlet returns a System.String object. The service call response (type Amazon.SageMaker.Model.CreateFeatureGroupResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z