| Column Name | Column Data Type |
|---|
feature_group_name Required Input Column
he name of the FeatureGroup. | VARCHAR |
next_token Input Column
A token to resume pagination of the list of Features (FeatureDefinitions). | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
creation_time
A timestamp indicating when SageMaker created the FeatureGroup. | TIMESTAMP_S |
description
A free form description of the feature group. | VARCHAR |
event_time_feature_name
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 have a corresponding EventTime. | VARCHAR |
failure_reason
The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because: | VARCHAR |
feature_definitions
A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType. | STRUCT(
"feature_name" VARCHAR,
"feature_type" VARCHAR,
"collection_type" VARCHAR,
"collection_config" STRUCT(
"vector_config" STRUCT(
"dimension" BIGINT
)
)
)[] |
Show child fields- feature_definitions[]
Show child fields- feature_definitions[].collection_config
Configuration for your collection. Show child fields- feature_definitions[].collection_config.vector_config
Configuration for your vector collection type. Show child fields- feature_definitions[].collection_config.vector_config.dimension
The number of elements in your vector.
- feature_definitions[].collection_type
A grouping of elements where each element within the collection must have the same feature type (String, Integral, or Fractional). -
List: An ordered collection of elements. -
Set: An unordered collection of unique elements. -
Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types. - feature_definitions[].feature_name
The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time. The name: -
Must start with an alphanumeric character. -
Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed. - feature_definitions[].feature_type
The value type of a feature. Valid values are Integral, Fractional, or String.
|
feature_group_arn
The Amazon Resource Name (ARN) of the FeatureGroup. | VARCHAR |
feature_group_status
The status of the feature group. | VARCHAR |
last_modified_time
A timestamp indicating when the feature group was last updated. | TIMESTAMP_S |
last_update_status
A value indicating whether the update made to the feature group was successful. | STRUCT(
"status" VARCHAR,
"failure_reason" VARCHAR
) |
Show child fields- last_update_status.failure_reason
If the update wasn't successful, indicates the reason why it failed. - last_update_status.status
A value that indicates whether the update was made successful.
|
offline_store_config
The configuration of the offline store. It includes the following configurations: -
Amazon S3 location of the offline store. -
Configuration of the Glue data catalog. -
Table format of the offline store. -
Option to disable the automatic creation of a Glue table for the offline store. -
Encryption configuration. | STRUCT(
"s3_storage_config" STRUCT(
"s3_uri" VARCHAR,
"kms_key_id" VARCHAR,
"resolved_output_s3_uri" VARCHAR
),
"disable_glue_table_creation" BOOLEAN,
"data_catalog_config" STRUCT(
"table_name" VARCHAR,
"catalog" VARCHAR,
"database" VARCHAR
),
"table_format" VARCHAR
) |
Show child fields- offline_store_config.data_catalog_config
The meta data of the Glue table that is autogenerated when an OfflineStore is created. Show child fields- offline_store_config.data_catalog_config.catalog
The name of the Glue table catalog. - offline_store_config.data_catalog_config.database
The name of the Glue table database. - offline_store_config.data_catalog_config.table_name
The name of the Glue table.
- offline_store_config.disable_glue_table_creation
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. - offline_store_config.s3_storage_config
The Amazon Simple Storage (Amazon S3) location of OfflineStore. Show child fields- offline_store_config.s3_storage_config.kms_key_id
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: - offline_store_config.s3_storage_config.resolved_output_s3_uri
The S3 path where offline records are written. - offline_store_config.s3_storage_config.s3_uri
The S3 URI, or location in Amazon S3, of OfflineStore. S3 URIs have a format similar to the following: s3://example-bucket/prefix/.
- offline_store_config.table_format
Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
|
offline_store_status
The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked | STRUCT(
"status" VARCHAR,
"blocked_reason" VARCHAR
) |
Show child fields- offline_store_status.blocked_reason
The justification for why the OfflineStoreStatus is Blocked (if applicable). - offline_store_status.status
An OfflineStore status.
|
online_store_config
The configuration for the OnlineStore. | STRUCT(
"security_config" STRUCT(
"kms_key_id" VARCHAR
),
"enable_online_store" BOOLEAN,
"ttl_duration" STRUCT(
"unit" VARCHAR,
"value" BIGINT
),
"storage_type" VARCHAR
) |
Show child fields- online_store_config.enable_online_store
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. - online_store_config.security_config
Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore. Show child fields- online_store_config.security_config.kms_key_id
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 OnlineStore KmsKeyId: -
"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:
- online_store_config.storage_type
Option for different tiers of low latency storage for real-time data retrieval. - online_store_config.ttl_duration
Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide. Show child fields- online_store_config.ttl_duration.unit
TtlDuration time unit. - online_store_config.ttl_duration.value
TtlDuration time value.
|
online_store_total_size_bytes
The size of the OnlineStore in bytes. | BIGINT |
record_identifier_feature_name
The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store. | VARCHAR |
role_arn
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided. | VARCHAR |
throughput_config
Active throughput configuration of the feature group. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled. Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store. | STRUCT(
"throughput_mode" VARCHAR,
"provisioned_read_capacity_units" BIGINT,
"provisioned_write_capacity_units" BIGINT
) |
Show child fields- throughput_config.provisioned_read_capacity_units
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. - throughput_config.provisioned_write_capacity_units
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. - throughput_config.throughput_mode
The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.
|