Amazon SageMaker Sagemaker Feature Group API
The Sagemaker Feature Group API from Amazon SageMaker — 5 operation(s) for sagemaker feature group.
The Sagemaker Feature Group API from Amazon SageMaker — 5 operation(s) for sagemaker feature group.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-sagemaker:amazon-sagemaker-feature-group-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: Amazon SageMaker Service Feature Group API
version: '2017-07-24'
description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 5 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://api.sagemaker.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/#CreateFeatureGroup:
post:
operationId: CreateFeatureGroup
summary: Create Feature Group
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 OnlineStore FeatureGroup with
the InMemory StorageType. You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateFeatureGroupResponse'
'400':
description: ResourceInUse; ResourceLimitExceeded
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceInUse'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SageMaker.CreateFeatureGroup
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateFeatureGroupRequest'
tags:
- Feature Group
/#DeleteFeatureGroup:
post:
operationId: DeleteFeatureGroup
summary: Delete Feature Group
description: Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot
be accessed from the OnlineStore immediately after DeleteFeatureGroup is called. Data written into the OfflineStore
will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore
are not deleted. Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the
InMemory StorageType.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
type: string
'400':
description: ResourceNotFound
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFound'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SageMaker.DeleteFeatureGroup
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteFeatureGroupRequest'
tags:
- Feature Group
/#DescribeFeatureGroup:
post:
operationId: DescribeFeatureGroup
summary: Describe Feature Group
description: Use this operation to describe a FeatureGroup. The response includes information on the creation time,
FeatureGroup name, the unique identifier for each FeatureGroup, and more.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeFeatureGroupResponse'
'400':
description: ResourceNotFound
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFound'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SageMaker.DescribeFeatureGroup
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeFeatureGroupRequest'
tags:
- Feature Group
/#ListFeatureGroups:
post:
operationId: ListFeatureGroups
summary: List Feature Groups
description: List FeatureGroups based on given filter and order.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListFeatureGroupsResponse'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SageMaker.ListFeatureGroups
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListFeatureGroupsRequest'
tags:
- Feature Group
/#UpdateFeatureGroup:
post:
operationId: UpdateFeatureGroup
summary: Update Feature Group
description: Updates the feature group by either adding features or updating the online store configuration. Use one
of the following request parameters at a time while using the UpdateFeatureGroup API. You can add features for your
feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group. You can
update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified,
the default TtlDuration applies for all records added to the feature group after the feature group is updated. If
a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record
instead of the default TtlDuration. To remove the default TtlDuration from an existing feature group, use the UpdateFeatureGroup
API and set the TtlDuration Unit and Value to null.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateFeatureGroupResponse'
'400':
description: ResourceLimitExceeded; ResourceNotFound
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceLimitExceeded'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SageMaker.UpdateFeatureGroup
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateFeatureGroupRequest'
tags:
- Feature Group
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: sagemaker
schemas:
CollectionConfig:
type: object
properties:
VectorConfig:
$ref: '#/components/schemas/VectorConfig'
description: Exactly one member is set.
CreateFeatureGroupRequest:
type: object
properties:
FeatureGroupName:
type: string
description: '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.'
RecordIdentifierFeatureName:
type: string
description: '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.'
EventTimeFeatureName:
type: string
description: '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 '
FeatureDefinitions:
type: array
items:
$ref: '#/components/schemas/FeatureDefinition'
description: '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.'
OnlineStoreConfig:
$ref: '#/components/schemas/OnlineStoreConfig'
OfflineStoreConfig:
$ref: '#/components/schemas/OfflineStoreConfig'
ThroughputConfig:
$ref: '#/components/schemas/ThroughputConfig'
RoleArn:
type: string
description: The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore
if an OfflineStoreConfig is provided.
Description:
type: string
description: A free-form description of a FeatureGroup.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Tags used to identify Features in each FeatureGroup.
required:
- FeatureGroupName
- RecordIdentifierFeatureName
- EventTimeFeatureName
- FeatureDefinitions
CreateFeatureGroupResponse:
type: object
properties:
FeatureGroupArn:
type: string
description: The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.
required:
- FeatureGroupArn
DataCatalogConfig:
type: object
properties:
TableName:
type: string
description: The name of the Glue table.
Catalog:
type: string
description: The name of the Glue table catalog.
Database:
type: string
description: The name of the Glue table database.
required:
- TableName
- Catalog
- Database
DeleteFeatureGroupRequest:
type: object
properties:
FeatureGroupName:
type: string
description: The name of the FeatureGroup you want to delete. The name must be unique within an Amazon Web Services
Region in an Amazon Web Services account.
required:
- FeatureGroupName
DescribeFeatureGroupRequest:
type: object
properties:
FeatureGroupName:
type: string
description: The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.
NextToken:
type: string
description: A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned
by default.
required:
- FeatureGroupName
DescribeFeatureGroupResponse:
type: object
properties:
FeatureGroupArn:
type: string
description: The Amazon Resource Name (ARN) of the FeatureGroup.
FeatureGroupName:
type: string
description: he name of the FeatureGroup.
RecordIdentifierFeatureName:
type: string
description: The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored
in the feature store.
EventTimeFeatureName:
type: string
description: 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.
FeatureDefinitions:
type: array
items:
$ref: '#/components/schemas/FeatureDefinition'
description: A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.
CreationTime:
type: string
format: date-time
description: A timestamp indicating when SageMaker created the FeatureGroup.
LastModifiedTime:
type: string
format: date-time
description: A timestamp indicating when the feature group was last updated.
OnlineStoreConfig:
$ref: '#/components/schemas/OnlineStoreConfig'
OfflineStoreConfig:
$ref: '#/components/schemas/OfflineStoreConfig'
ThroughputConfig:
$ref: '#/components/schemas/ThroughputConfigDescription'
RoleArn:
type: string
description: The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore
if an OfflineStoreConfig is provided.
FeatureGroupStatus:
type: string
enum:
- Creating
- Created
- CreateFailed
- Deleting
- DeleteFailed
description: The status of the feature group.
OfflineStoreStatus:
$ref: '#/components/schemas/OfflineStoreStatus'
LastUpdateStatus:
$ref: '#/components/schemas/LastUpdateStatus'
FailureReason:
type: string
description: 'The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can
occur because: The FeatureGroup could not be created in the OfflineStore. The FeatureGroup could not be deleted
from the OfflineStore.'
Description:
type: string
description: A free form description of the feature group.
NextToken:
type: string
description: A token to resume pagination of the list of Features (FeatureDefinitions).
OnlineStoreTotalSizeBytes:
type: integer
description: The size of the OnlineStore in bytes.
required:
- FeatureGroupArn
- FeatureGroupName
- RecordIdentifierFeatureName
- EventTimeFeatureName
- FeatureDefinitions
- CreationTime
- NextToken
FeatureDefinition:
type: object
properties:
FeatureName:
type: string
description: '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.'
FeatureType:
type: string
enum:
- Integral
- Fractional
- String
description: The value type of a feature. Valid values are Integral, Fractional, or String.
CollectionType:
type: string
enum:
- List
- Set
- Vector
description: '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.'
CollectionConfig:
$ref: '#/components/schemas/CollectionConfig'
required:
- FeatureName
- FeatureType
FeatureGroupSummary:
type: object
properties:
FeatureGroupName:
type: string
description: The name of FeatureGroup.
FeatureGroupArn:
type: string
description: Unique identifier for the FeatureGroup.
CreationTime:
type: string
format: date-time
description: A timestamp indicating the time of creation time of the FeatureGroup.
FeatureGroupStatus:
type: string
enum:
- Creating
- Created
- CreateFailed
- Deleting
- DeleteFailed
description: 'The status of a FeatureGroup. The status can be any of the following: Creating, Created, CreateFail,
Deleting or DetailFail.'
OfflineStoreStatus:
$ref: '#/components/schemas/OfflineStoreStatus'
required:
- FeatureGroupName
- FeatureGroupArn
- CreationTime
LastUpdateStatus:
type: object
properties:
Status:
type: string
enum:
- Successful
- Failed
- InProgress
description: A value that indicates whether the update was made successful.
FailureReason:
type: string
description: If the update wasn't successful, indicates the reason why it failed.
required:
- Status
ListFeatureGroupsRequest:
type: object
properties:
NameContains:
type: string
description: A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.
FeatureGroupStatusEquals:
type: string
enum:
- Creating
- Created
- CreateFailed
- Deleting
- DeleteFailed
description: A FeatureGroup status. Filters by FeatureGroup status.
OfflineStoreStatusEquals:
type: string
enum:
- Active
- Blocked
- Disabled
description: An OfflineStore status. Filters by OfflineStore status.
CreationTimeAfter:
type: string
format: date-time
description: Use this parameter to search for FeatureGroupss created after a specific date and time.
CreationTimeBefore:
type: string
format: date-time
description: Use this parameter to search for FeatureGroupss created before a specific date and time.
SortOrder:
type: string
enum:
- Ascending
- Descending
description: The order in which feature groups are listed.
SortBy:
type: string
enum:
- Name
- FeatureGroupStatus
- OfflineStoreStatus
- CreationTime
description: The value on which the feature group list is sorted.
MaxResults:
type: integer
description: The maximum number of results returned by ListFeatureGroups.
NextToken:
type: string
description: A token to resume pagination of ListFeatureGroups results.
ListFeatureGroupsResponse:
type: object
properties:
FeatureGroupSummaries:
type: array
items:
$ref: '#/components/schemas/FeatureGroupSummary'
description: A summary of feature groups.
NextToken:
type: string
description: A token to resume pagination of ListFeatureGroups results.
required:
- FeatureGroupSummaries
OfflineStoreConfig:
type: object
properties:
S3StorageConfig:
$ref: '#/components/schemas/S3StorageConfig'
DisableGlueTableCreation:
type: boolean
description: 'Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring
an OfflineStore. If set to True and DataCatalogConfig is provided, Feature Store associates the provided catalog
configuration with the feature group without creating a table. In this case, you are responsible for creating
and managing the Glue table. If set to True without DataCatalogConfig, no Glue table is created or associated
with the feature group. The Iceberg table format is only supported when this is set to False. If set to False
and DataCatalogConfig is provided, Feature Store creates '
DataCatalogConfig:
$ref: '#/components/schemas/DataCatalogConfig'
TableFormat:
type: string
enum:
- Default
- Glue
- Iceberg
description: Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
required:
- S3StorageConfig
OfflineStoreStatus:
type: object
properties:
Status:
type: string
enum:
- Active
- Blocked
- Disabled
description: An OfflineStore status.
BlockedReason:
type: string
description: The justification for why the OfflineStoreStatus is Blocked (if applicable).
required:
- Status
OnlineStoreConfig:
type: object
properties:
SecurityConfig:
$ref: '#/components/schemas/OnlineStoreSecurityConfig'
EnableOnlineStore:
type: boolean
description: 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.
TtlDuration:
$ref: '#/components/schemas/TtlDuration'
StorageType:
type: string
enum:
- Standard
- Standard_V2
- InMemory
description: 'Option for different tiers of low latency storage for real-time data retrieval. Standard: A managed
low latency data store for feature groups. Standard_V2: A managed low latency data store for feature groups that
supports partial updates to individual features using the UpdateRecord operation. Choose this storage type at
feature group creation time if your use case requires updating specific feature values without rewriting the entire
record. InMemory: A managed data store for feature groups that supports very low latency retrieval.'
OnlineStoreConfigUpdate:
type: object
properties:
TtlDuration:
$ref: '#/components/schemas/TtlDuration'
StorageType:
type: string
enum:
- Standard
- Standard_V2
- InMemory
description: The online store storage type to migrate the feature group to. Use this parameter to migrate an existing
feature group from Standard to Standard_V2 storage format, enabling support for the UpdateRecord operation. Migration
is a one-way operation and cannot be reversed.
OnlineStoreSecurityConfig:
type: object
properties:
KmsKeyId:
type: string
description: '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 t'
ResourceInUse:
type: object
properties:
Message:
type: string
ResourceLimitExceeded:
type: object
properties:
Message:
type: string
ResourceNotFound:
type: object
properties:
Message:
type: string
S3StorageConfig:
type: object
properties:
S3Uri:
type: string
description: 'The S3 URI, or location in Amazon S3, of OfflineStore. S3 URIs have a format similar to the following:
s3://example-bucket/prefix/.'
KmsKeyId:
type: string
description: '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"'
ResolvedOutputS3Uri:
type: string
description: The S3 path where offline records are written.
required:
- S3Uri
Tag:
type: object
properties:
Key:
type: string
description: The tag key. Tag keys must be unique per resource.
Value:
type: string
description: The tag value.
required:
- Key
- Value
ThroughputConfig:
type: object
properties:
ThroughputMode:
type: string
enum:
- OnDemand
- Provisioned
description: 'The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.'
ProvisionedReadCapacityUnits:
type: integer
description: 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.
ProvisionedWriteCapacityUnits:
type: integer
description: 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:
- ThroughputMode
ThroughputConfigDescription:
type: object
properties:
ThroughputMode:
type: string
enum:
- OnDemand
- Provisioned
description: 'The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.'
ProvisionedReadCapacityUnits:
type: integer
description: 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.
ProvisionedWriteCapacityUnits:
type: integer
description: 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:
- ThroughputMode
ThroughputConfigUpdate:
type: object
properties:
ThroughputMode:
type: string
enum:
- OnDemand
- Provisioned
description: Target throughput mode of the feature group. Throughput update is an asynchronous operation, and the
outcome should be monitored by polling LastUpdateStatus field in DescribeFeatureGroup response. You cannot update
a feature group's throughput while another update is in progress.
ProvisionedReadCapacityUnits:
type: integer
description: For provisioned feature groups with online store enabled, this indicates the read throughput you are
billed for and can consume without throttling.
ProvisionedWriteCapacityUnits:
type: integer
description: For provisioned feature groups, this indicates the write throughput you are billed for and can consume
without throttling.
TtlDuration:
type: object
properties:
Unit:
type: string
enum:
- Seconds
- Minutes
- Hours
- Days
- Weeks
description: TtlDuration time unit.
Value:
type: integer
description: TtlDuration time value.
UpdateFeatureGroupRequest:
type: object
properties:
FeatureGroupName:
type: string
description: The name or Amazon Resource Name (ARN) of the feature group that you're updating.
FeatureAdditions:
type: array
items:
$ref: '#/components/schemas/FeatureDefinition'
description: Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP
200 response, you've made a valid request. It takes some time after you've made a valid request for Feature Store
to update the feature group.
OnlineStoreConfig:
$ref: '#/components/schemas/OnlineStoreConfigUpdate'
ThroughputConfig:
$ref: '#/components/schemas/ThroughputConfigUpdate'
required:
- FeatureGroupName
UpdateFeatureGroupResponse:
type: object
properties:
FeatureGroupArn:
type: string
description: The Amazon Resource Number (ARN) of the feature group that you're updating.
required:
- FeatureGroupArn
VectorConfig:
type: object
properties:
Dimension:
type: integer
description: The number of elements in your vector.
required:
- Dimension
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)