You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 8d924cb
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: sagemaker-core/sample/sagemaker-featurestore-runtime/2020-07-01/service-2.json
+58Lines changed: 58 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -111,6 +111,23 @@
111
111
{"shape":"AccessForbidden"}
112
112
],
113
113
"documentation":"<p>The <code>PutRecord</code> API is used to ingest a list of <code>Records</code> into your feature group. </p> <p>If a new record’s <code>EventTime</code> is greater, the new record is written to both the <code>OnlineStore</code> and <code>OfflineStore</code>. Otherwise, the record is a historic record and it is written only to the <code>OfflineStore</code>. </p> <p>You can specify the ingestion to be applied to the <code>OnlineStore</code>, <code>OfflineStore</code>, or both by using the <code>TargetStores</code> request parameter. </p> <p>You can set the ingested record to expire at a given time to live (TTL) duration after the record’s event time, <code>ExpiresAt</code> = <code>EventTime</code> + <code>TtlDuration</code>, by specifying the <code>TtlDuration</code> parameter. A record level <code>TtlDuration</code> is set when specifying the <code>TtlDuration</code> parameter using the <code>PutRecord</code> API call. If the input <code>TtlDuration</code> is <code>null</code> or unspecified, <code>TtlDuration</code> is set to the default feature group level <code>TtlDuration</code>. A record level <code>TtlDuration</code> supersedes the group level <code>TtlDuration</code>.</p>"
"documentation":"<p>Updates one or more feature values for an existing record in the specified feature group. Features that you do not include in the request remain unchanged. You can update up to 100 features per call. This operation requires the online store and is available only for feature groups that use the <code>Standard_V2</code> or <code>InMemory</code> online store type.</p> <p>The record must already exist in the online store; if it does not exist or has been soft-deleted, the operation returns a <code>ResourceNotFound</code> error. To create a record, use <code>PutRecord</code>.</p> <p>Pass <code>EventTime</code> as a feature in the <code>Features</code> list rather than as a top-level parameter. If you provide an <code>EventTime</code> that is older than the record's current <code>EventTime</code>, the update is rejected with a <code>ConflictException</code>; if it is equal to or newer, the update is applied; if you omit it, the record's existing <code>EventTime</code> is kept. If you specify <code>TtlDuration</code> you must also provide an <code>EventTime</code>, otherwise a <code>ValidationError</code> is returned. <code>TargetStores</code> must include the <code>OnlineStore</code>; a value that resolves to the <code>OfflineStore</code> only is rejected.</p>"
114
131
}
115
132
},
116
133
"shapes":{
@@ -124,6 +141,15 @@
124
141
"exception":true,
125
142
"synthetic":true
126
143
},
144
+
"ConflictException":{
145
+
"type":"structure",
146
+
"members":{
147
+
"Message":{"shape":"Message"}
148
+
},
149
+
"documentation":"<p>The request conflicts with the current state of the record. This is returned by <code>UpdateRecord</code> when the supplied <code>EventTime</code> is not greater than the record's current <code>EventTime</code>.</p>",
150
+
"error":{"httpStatusCode":409},
151
+
"exception":true
152
+
},
127
153
"BatchGetRecordError":{
128
154
"type":"structure",
129
155
"required":[
@@ -662,6 +688,38 @@
662
688
"member":{"shape":"BatchGetRecordIdentifier"},
663
689
"min":0
664
690
},
691
+
"UpdateRecordRequest":{
692
+
"type":"structure",
693
+
"required":[
694
+
"FeatureGroupName",
695
+
"RecordIdentifierValueAsString",
696
+
"Features"
697
+
],
698
+
"members":{
699
+
"FeatureGroupName":{
700
+
"shape":"FeatureGroupNameOrArn",
701
+
"documentation":"<p>The name or Amazon Resource Name (ARN) of the feature group that contains the record you want to update. The feature group must use an <code>OnlineStoreConfig</code> <code>StorageType</code> of <code>Standard_V2</code> or <code>InMemory</code>.</p>",
702
+
"location":"uri",
703
+
"locationName":"FeatureGroupName"
704
+
},
705
+
"RecordIdentifierValueAsString":{
706
+
"shape":"ValueAsString",
707
+
"documentation":"<p>The value for the <code>RecordIdentifier</code> that uniquely identifies the record to update, in string format.</p>"
708
+
},
709
+
"Features":{
710
+
"shape":"Record",
711
+
"documentation":"<p>The feature values to write to the record. Only the features included here are written; features that are not listed are preserved. Pass <code>EventTime</code> as a feature in this list. You can update up to 100 features per call.</p>"
712
+
},
713
+
"TargetStores":{
714
+
"shape":"TargetStores",
715
+
"documentation":"<p>A list of stores to which the update is applied. By default, Feature Store applies the update to all of the stores that you're using for the <code>FeatureGroup</code>. A value that resolves to the <code>OfflineStore</code> only is rejected.</p>"
716
+
},
717
+
"TtlDuration":{
718
+
"shape":"TtlDuration",
719
+
"documentation":"<p>Time to live duration, where the record is hard deleted after the expiration time is reached; <code>ExpiresAt</code> = <code>EventTime</code> + <code>TtlDuration</code>. Specifying <code>TtlDuration</code> requires <code>EventTime</code> to be present in <code>Features</code>.</p>"
Copy file name to clipboardExpand all lines: sagemaker-core/sample/sagemaker/2017-07-24/service-2.json
+5Lines changed: 5 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -38675,6 +38675,10 @@
38675
38675
"TtlDuration":{
38676
38676
"shape":"TtlDuration",
38677
38677
"documentation":"<p>Time to live duration, where the record is hard deleted after the expiration time is reached; <code>ExpiresAt</code> = <code>EventTime</code> + <code>TtlDuration</code>. For information on HardDelete, see the <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html\">DeleteRecord</a> API in the Amazon SageMaker API Reference guide.</p>"
38678
+
},
38679
+
"StorageType":{
38680
+
"shape":"StorageType",
38681
+
"documentation":"<p>The online store storage type to migrate the feature group to. Use this parameter to migrate an existing feature group from <code>Standard</code> to <code>Standard_V2</code> storage format, enabling support for the <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_UpdateRecord.html\">UpdateRecord</a> operation. Migration is a one-way operation and cannot be reversed.</p>"
38678
38682
}
38679
38683
},
38680
38684
"documentation":"<p>Updates the feature group online store configuration.</p>"
The UpdateRecord API performs a feature-level write to a Record in a feature group whose OnlineStoreConfig StorageType is Standard_V2 or InMemory. Only the supplied Features are written; features not included are preserved. The record must already exist in the online store.
12297
+
12298
+
Parameters:
12299
+
record_identifier_value_as_string: The value for the RecordIdentifier that uniquely identifies the record to update, in string format.
12300
+
features: The list of FeatureValues to update. Only the features included here are written; features that are not listed are preserved. Pass EventTime as a feature in this list. A maximum of 100 features can be updated in a single request.
12301
+
target_stores: A list of stores to which the update is applied. By default, Feature Store applies the update to all of the stores that you're using for the FeatureGroup. A value that resolves to the OfflineStore only is rejected.
12302
+
ttl_duration: Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. Specifying TtlDuration requires EventTime to be present in Features.
12303
+
session: Boto3 session.
12304
+
region: Region name.
12305
+
12306
+
Raises:
12307
+
botocore.exceptions.ClientError: This exception is raised for AWS service related errors.
12308
+
The error message and error code can be parsed from the exception as follows:
12309
+
```
12310
+
try:
12311
+
# AWS service call here
12312
+
except botocore.exceptions.ClientError as e:
12313
+
error_message = e.response['Error']['Message']
12314
+
error_code = e.response['Error']['Code']
12315
+
```
12316
+
AccessForbidden: You do not have permission to perform an action.
12317
+
ConflictException: There was a conflict when you attempted to modify a record; the supplied EventTime was not greater than the record's current EventTime.
12318
+
InternalFailure: An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
12319
+
ResourceNotFound: A resource that is required to perform an action was not found.
12320
+
ServiceUnavailable: The service is currently unavailable.
12321
+
ValidationError: There was an error validating your request.
Copy file name to clipboardExpand all lines: sagemaker-core/src/sagemaker/core/shapes/shapes.py
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -14670,9 +14670,11 @@ class OnlineStoreConfigUpdate(Base):
14670
14670
Attributes
14671
14671
----------------------
14672
14672
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.
14673
+
storage_type: 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.
0 commit comments