{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.sagemakerfeaturestoreruntime#AccessForbidden": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Message" } }, "traits": { "smithy.api#documentation": "

You do not have permission to perform an action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.sagemakerfeaturestoreruntime#AmazonSageMakerFeatureStoreRuntime": { "type": "service", "version": "2020-07-01", "operations": [ { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecord" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecord" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#DeleteRecord" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#GetRecord" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ListRecords" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#PutRecord" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#UpdateRecord" } ], "traits": { "aws.api#service": { "sdkId": "SageMaker FeatureStore Runtime", "arnNamespace": "sagemaker", "cloudFormationName": "SageMakerFeatureStoreRuntime", "cloudTrailEventSource": "sagemakerfeaturestoreruntime.amazonaws.com", "endpointPrefix": "featurestore-runtime.sagemaker" }, "aws.auth#sigv4": { "name": "sagemaker" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "

Contains all data plane API operations and data types for the Amazon SageMaker Feature\n Store. Use this API to put, delete, and retrieve (get) features from a feature\n store.

\n

Use the following operations to configure your OnlineStore and\n OfflineStore features, and to create and manage feature groups:

\n ", "smithy.api#title": "Amazon SageMaker Feature Store Runtime", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://featurestore-runtime.sagemaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://featurestore-runtime.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://featurestore-runtime.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://featurestore-runtime.sagemaker.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://featurestore-runtime.sagemaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://featurestore-runtime.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://featurestore-runtime.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://featurestore-runtime.sagemaker.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://featurestore-runtime.sagemaker.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecord": { "type": "operation", "input": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordRequest" }, "output": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordResponse" }, "errors": [ { "target": "com.amazonaws.sagemakerfeaturestoreruntime#AccessForbidden" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#InternalFailure" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ServiceUnavailable" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValidationError" } ], "traits": { "smithy.api#documentation": "

Retrieves a batch of Records from a FeatureGroup.

", "smithy.api#http": { "method": "POST", "uri": "/BatchGetRecord", "code": 200 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordError": { "type": "structure", "members": { "FeatureGroupName": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the feature group that the record belongs to.

", "smithy.api#required": {} } }, "RecordIdentifierValueAsString": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The value for the RecordIdentifier in string format of a Record from a\n FeatureGroup that is causing an error when attempting to be\n retrieved.

", "smithy.api#required": {} } }, "ErrorCode": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The error code of an error that has occurred when attempting to retrieve a batch of\n Records. For more information on errors, see Errors.

", "smithy.api#required": {} } }, "ErrorMessage": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Message", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The error message of an error that has occurred when attempting to retrieve a record in\n the batch.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The error that has occurred when attempting to retrieve a batch of Records.

" } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordErrors": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordError" }, "traits": { "smithy.api#length": { "min": 0 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordIdentifier": { "type": "structure", "members": { "FeatureGroupName": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureGroupNameOrArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the FeatureGroup containing the\n records you are retrieving in a batch.

", "smithy.api#required": {} } }, "RecordIdentifiersValueAsString": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#RecordIdentifiers", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The value for a list of record identifiers in string format.

", "smithy.api#required": {} } }, "FeatureNames": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureNames", "traits": { "smithy.api#documentation": "

List of names of Features to be retrieved. If not specified, the latest value for all\n the Features are returned.

" } } }, "traits": { "smithy.api#documentation": "

The identifier that identifies the batch of Records you are retrieving in a\n batch.

" } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordIdentifier" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordRequest": { "type": "structure", "members": { "Identifiers": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordIdentifiers", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

A list containing the name or Amazon Resource Name (ARN) of the\n FeatureGroup, the list of names of Features to be retrieved,\n and the corresponding RecordIdentifier values as strings.

", "smithy.api#required": {} } }, "ExpirationTimeResponse": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ExpirationTimeResponse", "traits": { "smithy.api#documentation": "

Parameter to request ExpiresAt in response. If Enabled,\n BatchGetRecord will return the value of ExpiresAt, if it is\n not null. If Disabled and null, BatchGetRecord will return\n null.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordResponse": { "type": "structure", "members": { "Records": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordResultDetails", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

A list of Records you requested to be retrieved in batch.

", "smithy.api#required": {} } }, "Errors": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordErrors", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

A list of errors that have occurred when retrieving a batch of Records.

", "smithy.api#required": {} } }, "UnprocessedIdentifiers": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#UnprocessedIdentifiers", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

A unprocessed list of FeatureGroup names, with their corresponding\n RecordIdentifier value, and Feature name.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordResultDetail": { "type": "structure", "members": { "FeatureGroupName": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The FeatureGroupName containing Records you retrieved in a batch.

", "smithy.api#required": {} } }, "RecordIdentifierValueAsString": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The value of the record identifier in string format.

", "smithy.api#required": {} } }, "Record": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Record", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Record retrieved.

", "smithy.api#required": {} } }, "ExpiresAt": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ExpiresAt", "traits": { "smithy.api#documentation": "

The ExpiresAt ISO string of the requested record.

" } } }, "traits": { "smithy.api#documentation": "

The output of records that have been retrieved in a batch.

" } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordResultDetails": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordResultDetail" }, "traits": { "smithy.api#length": { "min": 0 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecord": { "type": "operation", "input": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordRequest" }, "output": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordResponse" }, "errors": [ { "target": "com.amazonaws.sagemakerfeaturestoreruntime#AccessForbidden" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#InternalFailure" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ResourceNotFound" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ServiceUnavailable" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValidationError" } ], "traits": { "smithy.api#documentation": "

Writes a batch of Records to one or more FeatureGroups. Use\n this API for bulk ingestion of records into the OnlineStore and\n OfflineStore.

\n

You can set the ingested records to expire at a given time to live (TTL) duration after\n the record's event time by specifying the TtlDuration parameter. A request\n level TtlDuration applies to all entries that do not specify their own\n TtlDuration.

", "smithy.api#examples": [ { "title": "Write records to multiple feature groups", "input": { "Entries": [ { "FeatureGroupName": "my-feature-group", "Record": [ { "FeatureName": "customer_id", "ValueAsString": "cust-001" }, { "FeatureName": "age", "ValueAsString": "25" } ] } ] }, "output": { "Errors": [], "UnprocessedEntries": [] } } ], "smithy.api#http": { "method": "POST", "uri": "/BatchWriteRecord", "code": 200 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordEntries": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordEntry" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordEntry": { "type": "structure", "members": { "FeatureGroupName": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureGroupNameOrArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the FeatureGroup to write the\n record to.

", "smithy.api#required": {} } }, "Record": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Record", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

List of FeatureValues to be inserted. This will be a full over-write.

", "smithy.api#required": {} } }, "TargetStores": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#TargetStores", "traits": { "smithy.api#documentation": "

A list of stores to which you're adding the record. By default, Feature Store adds the\n record to all of the stores that you're using for the\n FeatureGroup.

" } }, "TtlDuration": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#TtlDuration", "traits": { "smithy.api#documentation": "

Time to live duration for this entry, where the record is hard deleted after the\n expiration time is reached; ExpiresAt = EventTime +\n TtlDuration. This overrides the request level\n TtlDuration.

" } } }, "traits": { "smithy.api#documentation": "

An entry to write as part of a BatchWriteRecord request.

" } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordError": { "type": "structure", "members": { "Entry": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordEntry", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The entry that failed to be written.

", "smithy.api#required": {} } }, "ErrorCode": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The error code for the failed record write.

", "smithy.api#required": {} } }, "ErrorMessage": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Message", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The error message for the failed record write.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The error that has occurred when attempting to write a record in a batch.

" } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordErrors": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordError" }, "traits": { "smithy.api#length": { "min": 0 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordRequest": { "type": "structure", "members": { "Entries": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordEntries", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

A list of records to write. Each entry specifies the FeatureGroup, the\n record data, and optionally target stores and a TTL duration.

", "smithy.api#required": {} } }, "TtlDuration": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#TtlDuration", "traits": { "smithy.api#documentation": "

Time to live duration applied to all entries in the batch that do not specify their own\n TtlDuration; ExpiresAt = EventTime +\n TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordResponse": { "type": "structure", "members": { "Errors": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordErrors", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

A list of errors that occurred when writing records in the batch.

", "smithy.api#required": {} } }, "UnprocessedEntries": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#UnprocessedBatchWriteRecordEntries", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

A list of entries that were not processed. These entries can be retried.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sagemakerfeaturestoreruntime#Boolean": { "type": "boolean" }, "com.amazonaws.sagemakerfeaturestoreruntime#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Message" } }, "traits": { "smithy.api#documentation": "

The service rejected the update because the provided EventTime is\n older than the record's current EventTime. To persist the update, retrieve\n the record's latest EventTime and resubmit the request with an\n EventTime that is equal to or newer than the current value.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.sagemakerfeaturestoreruntime#DeleteRecord": { "type": "operation", "input": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#DeleteRecordRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.sagemakerfeaturestoreruntime#AccessForbidden" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#InternalFailure" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ServiceUnavailable" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValidationError" } ], "traits": { "smithy.api#documentation": "

Deletes a Record from a FeatureGroup in the\n OnlineStore. Feature Store supports both SoftDelete and\n HardDelete. For SoftDelete (default), feature columns are set\n to null and the record is no longer retrievable by GetRecord or\n BatchGetRecord. For HardDelete, the complete\n Record is removed from the OnlineStore. In both cases, Feature\n Store appends the deleted record marker to the OfflineStore. The deleted\n record marker is a record with the same RecordIdentifer as the original, but\n with is_deleted value set to True, EventTime set to\n the delete input EventTime, and other feature values set to\n null.

\n

Note that the EventTime specified in DeleteRecord should be\n set later than the EventTime of the existing record in the\n OnlineStore for that RecordIdentifer. If it is not, the\n deletion does not occur:

\n \n

When a record is deleted from the OnlineStore, the deleted record marker is\n appended to the OfflineStore. If you have the Iceberg table format enabled for\n your OfflineStore, you can remove all history of a record from the\n OfflineStore using Amazon Athena or Apache Spark. For information on how to\n hard delete a record from the OfflineStore with the Iceberg table format\n enabled, see Delete records from the offline store.

", "smithy.api#http": { "method": "DELETE", "uri": "/FeatureGroup/{FeatureGroupName}", "code": 200 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#DeleteRecordRequest": { "type": "structure", "members": { "FeatureGroupName": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureGroupNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the feature group to delete the record from.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RecordIdentifierValueAsString": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The value for the RecordIdentifier that uniquely identifies the record, in\n string format.

", "smithy.api#httpQuery": "RecordIdentifierValueAsString", "smithy.api#required": {} } }, "EventTime": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Timestamp indicating when the deletion event occurred. EventTime can be\n used to query data at a certain point in time.

", "smithy.api#httpQuery": "EventTime", "smithy.api#required": {} } }, "TargetStores": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#TargetStores", "traits": { "smithy.api#documentation": "

A list of stores from which you're deleting the record. By default, Feature Store\n deletes the record from all of the stores that you're using for the\n FeatureGroup.

", "smithy.api#httpQuery": "TargetStores" } }, "DeletionMode": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#DeletionMode", "traits": { "smithy.api#documentation": "

The name of the deletion mode for deleting the record. By default, the deletion mode is\n set to SoftDelete.

", "smithy.api#httpQuery": "DeletionMode" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakerfeaturestoreruntime#DeletionMode": { "type": "enum", "members": { "SOFT_DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SoftDelete" } }, "HARD_DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HardDelete" } } } }, "com.amazonaws.sagemakerfeaturestoreruntime#ExpirationTimeResponse": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } } } }, "com.amazonaws.sagemakerfeaturestoreruntime#ExpiresAt": { "type": "string" }, "com.amazonaws.sagemakerfeaturestoreruntime#FeatureGroupNameOrArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 150 }, "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63})$" } }, "com.amazonaws.sagemakerfeaturestoreruntime#FeatureName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}$" } }, "com.amazonaws.sagemakerfeaturestoreruntime#FeatureNames": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureName" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#FeatureValue": { "type": "structure", "members": { "FeatureName": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of a feature that a feature value corresponds to.

", "smithy.api#required": {} } }, "ValueAsString": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString", "traits": { "smithy.api#documentation": "

The value in string format associated with a feature. Used when your\n CollectionType is None. Note that features types can be\n String, Integral, or Fractional. This value\n represents all three types as a string.

" } }, "ValueAsStringList": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsStringList", "traits": { "smithy.api#documentation": "

The list of values in string format associated with a feature. Used when your\n CollectionType is a List, Set, or\n Vector. Note that features types can be String,\n Integral, or Fractional. These values represents all three\n types as a string.

" } } }, "traits": { "smithy.api#documentation": "

The value associated with a feature.

" } }, "com.amazonaws.sagemakerfeaturestoreruntime#GetRecord": { "type": "operation", "input": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#GetRecordRequest" }, "output": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#GetRecordResponse" }, "errors": [ { "target": "com.amazonaws.sagemakerfeaturestoreruntime#AccessForbidden" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#InternalFailure" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ResourceNotFound" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ServiceUnavailable" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValidationError" } ], "traits": { "smithy.api#documentation": "

Use for OnlineStore serving from a FeatureStore. Only the\n latest records stored in the OnlineStore can be retrieved. If no Record with\n RecordIdentifierValue is found, then an empty result is returned.

", "smithy.api#http": { "method": "GET", "uri": "/FeatureGroup/{FeatureGroupName}", "code": 200 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#GetRecordRequest": { "type": "structure", "members": { "FeatureGroupName": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureGroupNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the feature group from which you want to\n retrieve a record.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RecordIdentifierValueAsString": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The value that corresponds to RecordIdentifier type and uniquely identifies\n the record in the FeatureGroup.

", "smithy.api#httpQuery": "RecordIdentifierValueAsString", "smithy.api#required": {} } }, "FeatureNames": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureNames", "traits": { "smithy.api#documentation": "

List of names of Features to be retrieved. If not specified, the latest value for all\n the Features are returned.

", "smithy.api#httpQuery": "FeatureName" } }, "ExpirationTimeResponse": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ExpirationTimeResponse", "traits": { "smithy.api#documentation": "

Parameter to request ExpiresAt in response. If Enabled,\n GetRecord will return the value of ExpiresAt, if it is not\n null. If Disabled and null, GetRecord will return null.

", "smithy.api#httpQuery": "ExpirationTimeResponse" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakerfeaturestoreruntime#GetRecordResponse": { "type": "structure", "members": { "Record": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Record", "traits": { "smithy.api#documentation": "

The record you requested. A list of FeatureValues.

" } }, "ExpiresAt": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ExpiresAt", "traits": { "smithy.api#documentation": "

The ExpiresAt ISO string of the requested record.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sagemakerfeaturestoreruntime#InternalFailure": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Message" } }, "traits": { "smithy.api#documentation": "

An internal failure occurred. Try your request again. If the problem persists, contact\n Amazon Web Services customer support.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.sagemakerfeaturestoreruntime#ListRecords": { "type": "operation", "input": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ListRecordsRequest" }, "output": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ListRecordsResponse" }, "errors": [ { "target": "com.amazonaws.sagemakerfeaturestoreruntime#AccessForbidden" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#InternalFailure" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ResourceNotFound" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ServiceUnavailable" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValidationError" } ], "traits": { "smithy.api#documentation": "

Lists the RecordIdentifier values of all records stored in a\n FeatureGroup's OnlineStore. This enables you to discover which\n records exist without retrieving the full record data.

", "smithy.api#examples": [ { "title": "List record identifiers from a feature group", "input": { "FeatureGroupName": "my-feature-group", "MaxResults": 10 }, "output": { "RecordIdentifiers": [ "record-id-1", "record-id-2" ], "NextToken": "eyJsYXN0RXZhbHVhdGVkS2V5IjoiYWJjMTIzIn0=" } } ], "smithy.api#http": { "method": "POST", "uri": "/FeatureGroup/{FeatureGroupName}/ListRecords", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RecordIdentifiers", "pageSize": "MaxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.sagemakerfeaturestoreruntime#ListRecordsMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#ListRecordsNextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 8192 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#ListRecordsRequest": { "type": "structure", "members": { "FeatureGroupName": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureGroupNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the feature group to list records from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ListRecordsMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of record identifiers to return in a single page of results. For the InMemory tier, this value is a hint and not a strict requirement. The response may contain more or fewer results than the specified MaxResults.

" } }, "NextToken": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ListRecordsNextToken", "traits": { "smithy.api#documentation": "

A token to resume pagination of ListRecords results.

" } }, "IncludeSoftDeletedRecords": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Boolean", "traits": { "smithy.api#documentation": "

If set to true, the result includes records that have been soft\n deleted.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakerfeaturestoreruntime#ListRecordsResponse": { "type": "structure", "members": { "RecordIdentifiers": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#RecordIdentifierList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

A list of record identifier values for the records stored in the\n OnlineStore.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ListRecordsNextToken", "traits": { "smithy.api#documentation": "

A token to resume pagination if the response includes more record identifiers than\n MaxResults.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sagemakerfeaturestoreruntime#Message": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#PutRecord": { "type": "operation", "input": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#PutRecordRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.sagemakerfeaturestoreruntime#AccessForbidden" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#InternalFailure" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ServiceUnavailable" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValidationError" } ], "traits": { "smithy.api#documentation": "

The PutRecord API is used to ingest a list of Records into\n your feature group.

\n

If a new record\u2019s EventTime is greater, the new record is written to both\n the OnlineStore and OfflineStore. Otherwise, the record is a\n historic record and it is written only to the OfflineStore.

\n

You can specify the ingestion to be applied to the OnlineStore,\n OfflineStore, or both by using the TargetStores request\n parameter.

\n

You can set the ingested record to expire at a given time to live (TTL) duration after\n the record\u2019s event time, ExpiresAt = EventTime +\n TtlDuration, by specifying the TtlDuration parameter. A record\n level TtlDuration is set when specifying the TtlDuration\n parameter using the PutRecord API call. If the input TtlDuration\n is null or unspecified, TtlDuration is set to the default feature\n group level TtlDuration. A record level TtlDuration supersedes\n the group level TtlDuration.

", "smithy.api#http": { "method": "PUT", "uri": "/FeatureGroup/{FeatureGroupName}", "code": 200 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#PutRecordRequest": { "type": "structure", "members": { "FeatureGroupName": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureGroupNameOrArn", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the feature group that you want to insert the\n record into.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Record": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Record", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

List of FeatureValues to be inserted. This will be a full over-write. If you only want\n to update few of the feature values, do the following:

\n ", "smithy.api#required": {} } }, "TargetStores": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#TargetStores", "traits": { "smithy.api#documentation": "

A list of stores to which you're adding the record. By default, Feature Store adds the\n record to all of the stores that you're using for the FeatureGroup.

" } }, "TtlDuration": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#TtlDuration", "traits": { "smithy.api#documentation": "

Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakerfeaturestoreruntime#Record": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureValue" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#RecordIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString" } }, "com.amazonaws.sagemakerfeaturestoreruntime#RecordIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#ResourceNotFound": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Message" } }, "traits": { "smithy.api#documentation": "

A resource that is required to perform an action was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.sagemakerfeaturestoreruntime#ServiceUnavailable": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Message" } }, "traits": { "smithy.api#documentation": "

The service is currently unavailable.

", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.sagemakerfeaturestoreruntime#TargetStore": { "type": "enum", "members": { "ONLINE_STORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OnlineStore" } }, "OFFLINE_STORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OfflineStore" } } } }, "com.amazonaws.sagemakerfeaturestoreruntime#TargetStores": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#TargetStore" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#TtlDuration": { "type": "structure", "members": { "Unit": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#TtlDurationUnit", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

\n TtlDuration time unit.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#TtlDurationValue", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

\n TtlDuration time value.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" } }, "com.amazonaws.sagemakerfeaturestoreruntime#TtlDurationUnit": { "type": "enum", "members": { "SECONDS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Seconds" } }, "MINUTES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Minutes" } }, "HOURS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Hours" } }, "DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Days" } }, "WEEKS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Weeks" } } } }, "com.amazonaws.sagemakerfeaturestoreruntime#TtlDurationValue": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#UnprocessedBatchWriteRecordEntries": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchWriteRecordEntry" }, "traits": { "smithy.api#length": { "min": 0 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#UnprocessedIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordIdentifier" }, "traits": { "smithy.api#length": { "min": 0 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#UpdateRecord": { "type": "operation", "input": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#UpdateRecordRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.sagemakerfeaturestoreruntime#AccessForbidden" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ConflictException" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#InternalFailure" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ResourceNotFound" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ServiceUnavailable" }, { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValidationError" } ], "traits": { "smithy.api#documentation": "

Updates one or more feature values for an existing record in the specified\n feature group. Features that you do not include in the request remain unchanged.\n You can update up to 100 features per call.

\n \n

This operation is available only for feature groups that use the\n Standard_V2 or InMemory online store type.

\n
\n

The record must already exist. If the record does not exist or has been\n soft-deleted, the operation returns a ResourceNotFound error. To create\n a record, use PutRecord.

\n

If you provide an EventTime that is older than the record's current\n EventTime, the service rejects the update with a\n ConflictException. If the EventTime is equal to or newer\n than the current value, the service applies the update. If you omit\n EventTime, the service keeps the record's existing\n EventTime and applies the update.

\n

If you specify a TtlDuration, you must also provide an\n EventTime in the request. Otherwise, the operation returns a\n ValidationError.

", "smithy.api#examples": [ { "title": "Update specific features in a record", "input": { "FeatureGroupName": "my-feature-group", "RecordIdentifierValueAsString": "cust-001", "Features": [ { "FeatureName": "age", "ValueAsString": "26" }, { "FeatureName": "membership_tier", "ValueAsString": "gold" }, { "FeatureName": "event_time", "ValueAsString": "2026-07-26T12:00:00Z" } ] }, "output": {} }, { "title": "Update features and set a time-to-live (TTL) duration", "input": { "FeatureGroupName": "my-feature-group", "RecordIdentifierValueAsString": "cust-001", "Features": [ { "FeatureName": "age", "ValueAsString": "26" }, { "FeatureName": "event_time", "ValueAsString": "2026-07-26T12:00:00Z" } ], "TtlDuration": { "Unit": "Weeks", "Value": 4 } }, "output": {} } ], "smithy.api#http": { "method": "POST", "uri": "/FeatureGroup/{FeatureGroupName}/Record", "code": 200 } } }, "com.amazonaws.sagemakerfeaturestoreruntime#UpdateRecordRequest": { "type": "structure", "members": { "FeatureGroupName": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureGroupNameOrArn", "traits": { "smithy.api#documentation": "

The identifier for the feature group that contains the record to update. You can\n specify one of the following:

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RecordIdentifierValueAsString": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The value that uniquely identifies the record in the feature group. This must\n match the value defined by the feature group's record identifier feature.

", "smithy.api#required": {} } }, "Features": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Record", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The feature values to write to the record.

", "smithy.api#required": {} } }, "TargetStores": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#TargetStores", "traits": { "smithy.api#documentation": "

The target stores for the record update. By default, Amazon SageMaker Feature\n Store updates the record in all stores associated with the\n FeatureGroup.

" } }, "TtlDuration": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#TtlDuration", "traits": { "smithy.api#documentation": "

The time-to-live (TTL) duration for the record. Amazon SageMaker Feature Store\n deletes the record when EventTime + TtlDuration\n elapses. If you omit this parameter, the record's existing TTL setting remains\n unchanged. For information about HardDelete, see the DeleteRecord operation in the Amazon SageMaker API Reference.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakerfeaturestoreruntime#ValidationError": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#Message" } }, "traits": { "smithy.api#documentation": "

There was an error validating your request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 358400 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsStringList": { "type": "list", "member": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString" }, "traits": { "smithy.api#length": { "min": 0, "max": 358400 } } } } }