|
5 | 5 | "endpointPrefix":"featurestore-runtime.sagemaker", |
6 | 6 | "jsonVersion":"1.1", |
7 | 7 | "protocol":"rest-json", |
| 8 | + "protocols":["rest-json"], |
8 | 9 | "serviceFullName":"Amazon SageMaker Feature Store Runtime", |
9 | 10 | "serviceId":"SageMaker FeatureStore Runtime", |
10 | 11 | "signatureVersion":"v4", |
11 | 12 | "signingName":"sagemaker", |
12 | | - "uid":"sagemaker-featurestore-runtime-2020-07-01" |
| 13 | + "uid":"sagemaker-featurestore-runtime-2020-07-01", |
| 14 | + "auth":["aws.auth#sigv4"] |
13 | 15 | }, |
14 | 16 | "operations":{ |
15 | 17 | "BatchGetRecord":{ |
|
28 | 30 | ], |
29 | 31 | "documentation":"<p>Retrieves a batch of <code>Records</code> from a <code>FeatureGroup</code>.</p>" |
30 | 32 | }, |
| 33 | + "BatchWriteRecord":{ |
| 34 | + "name":"BatchWriteRecord", |
| 35 | + "http":{ |
| 36 | + "method":"POST", |
| 37 | + "requestUri":"/BatchWriteRecord" |
| 38 | + }, |
| 39 | + "input":{"shape":"BatchWriteRecordRequest"}, |
| 40 | + "output":{"shape":"BatchWriteRecordResponse"}, |
| 41 | + "errors":[ |
| 42 | + {"shape":"ValidationError"}, |
| 43 | + {"shape":"ResourceNotFound"}, |
| 44 | + {"shape":"InternalFailure"}, |
| 45 | + {"shape":"ServiceUnavailable"}, |
| 46 | + {"shape":"AccessForbidden"} |
| 47 | + ], |
| 48 | + "documentation":"<p>Writes a batch of <code>Records</code> to one or more <code>FeatureGroup</code>s. Use this API for bulk ingestion of records into the <code>OnlineStore</code> and <code>OfflineStore</code>.</p> <p>You can set the ingested records to expire at a given time to live (TTL) duration after the record's event time by specifying the <code>TtlDuration</code> parameter. A request level <code>TtlDuration</code> applies to all entries that do not specify their own <code>TtlDuration</code>.</p>" |
| 49 | + }, |
31 | 50 | "DeleteRecord":{ |
32 | 51 | "name":"DeleteRecord", |
33 | 52 | "http":{ |
|
41 | 60 | {"shape":"ServiceUnavailable"}, |
42 | 61 | {"shape":"AccessForbidden"} |
43 | 62 | ], |
44 | | - "documentation":"<p>Deletes a <code>Record</code> from a <code>FeatureGroup</code> in the <code>OnlineStore</code>. Feature Store supports both <code>SoftDelete</code> and <code>HardDelete</code>. For <code>SoftDelete</code> (default), feature columns are set to <code>null</code> and the record is no longer retrievable by <code>GetRecord</code> or <code>BatchGetRecord</code>. For <code>HardDelete</code>, the complete <code>Record</code> is removed from the <code>OnlineStore</code>. In both cases, Feature Store appends the deleted record marker to the <code>OfflineStore</code>. The deleted record marker is a record with the same <code>RecordIdentifer</code> as the original, but with <code>is_deleted</code> value set to <code>True</code>, <code>EventTime</code> set to the delete input <code>EventTime</code>, and other feature values set to <code>null</code>.</p> <p>Note that the <code>EventTime</code> specified in <code>DeleteRecord</code> should be set later than the <code>EventTime</code> of the existing record in the <code>OnlineStore</code> for that <code>RecordIdentifer</code>. If it is not, the deletion does not occur:</p> <ul> <li> <p>For <code>SoftDelete</code>, the existing (not deleted) record remains in the <code>OnlineStore</code>, though the delete record marker is still written to the <code>OfflineStore</code>.</p> </li> <li> <p> <code>HardDelete</code> returns <code>EventTime</code>: <code>400 ValidationException</code> to indicate that the delete operation failed. No delete record marker is written to the <code>OfflineStore</code>.</p> </li> </ul> <p>When a record is deleted from the <code>OnlineStore</code>, the deleted record marker is appended to the <code>OfflineStore</code>. If you have the Iceberg table format enabled for your <code>OfflineStore</code>, you can remove all history of a record from the <code>OfflineStore</code> using Amazon Athena or Apache Spark. For information on how to hard delete a record from the <code>OfflineStore</code> with the Iceberg table format enabled, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-delete-records-offline-store.html#feature-store-delete-records-offline-store\">Delete records from the offline store</a>.</p>" |
| 63 | + "documentation":"<p>Deletes a <code>Record</code> from a <code>FeatureGroup</code> in the <code>OnlineStore</code>. Feature Store supports both <code>SoftDelete</code> and <code>HardDelete</code>. For <code>SoftDelete</code> (default), feature columns are set to <code>null</code> and the record is no longer retrievable by <code>GetRecord</code> or <code>BatchGetRecord</code>. For <code>HardDelete</code>, the complete <code>Record</code> is removed from the <code>OnlineStore</code>. In both cases, Feature Store appends the deleted record marker to the <code>OfflineStore</code>. The deleted record marker is a record with the same <code>RecordIdentifer</code> as the original, but with <code>is_deleted</code> value set to <code>True</code>, <code>EventTime</code> set to the delete input <code>EventTime</code>, and other feature values set to <code>null</code>.</p> <p>Note that the <code>EventTime</code> specified in <code>DeleteRecord</code> should be set later than the <code>EventTime</code> of the existing record in the <code>OnlineStore</code> for that <code>RecordIdentifer</code>. If it is not, the deletion does not occur:</p> <ul> <li> <p>For <code>SoftDelete</code>, the existing (not deleted) record remains in the <code>OnlineStore</code>, though the delete record marker is still written to the <code>OfflineStore</code>.</p> </li> <li> <p> <code>HardDelete</code> returns <code>EventTime</code>: <code>400 ValidationException</code> to indicate that the delete operation failed. No delete record marker is written to the <code>OfflineStore</code>.</p> </li> </ul> <p>When a record is deleted from the <code>OnlineStore</code>, the deleted record marker is appended to the <code>OfflineStore</code>. If you have the Iceberg table format enabled for your <code>OfflineStore</code>, you can remove all history of a record from the <code>OfflineStore</code> using Amazon Athena or Apache Spark. For information on how to hard delete a record from the <code>OfflineStore</code> with the Iceberg table format enabled, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-delete-records.html#feature-store-delete-records-offline-store\">Delete records from the offline store</a>.</p>" |
45 | 64 | }, |
46 | 65 | "GetRecord":{ |
47 | 66 | "name":"GetRecord", |
|
60 | 79 | ], |
61 | 80 | "documentation":"<p>Use for <code>OnlineStore</code> serving from a <code>FeatureStore</code>. Only the latest records stored in the <code>OnlineStore</code> can be retrieved. If no Record with <code>RecordIdentifierValue</code> is found, then an empty result is returned. </p>" |
62 | 81 | }, |
| 82 | + "ListRecords":{ |
| 83 | + "name":"ListRecords", |
| 84 | + "http":{ |
| 85 | + "method":"POST", |
| 86 | + "requestUri":"/FeatureGroup/{FeatureGroupName}/ListRecords" |
| 87 | + }, |
| 88 | + "input":{"shape":"ListRecordsRequest"}, |
| 89 | + "output":{"shape":"ListRecordsResponse"}, |
| 90 | + "errors":[ |
| 91 | + {"shape":"ValidationError"}, |
| 92 | + {"shape":"ResourceNotFound"}, |
| 93 | + {"shape":"InternalFailure"}, |
| 94 | + {"shape":"ServiceUnavailable"}, |
| 95 | + {"shape":"AccessForbidden"} |
| 96 | + ], |
| 97 | + "documentation":"<p>Lists the <code>RecordIdentifier</code> values of all records stored in a <code>FeatureGroup</code>'s <code>OnlineStore</code>. This enables you to discover which records exist without retrieving the full record data.</p>", |
| 98 | + "readonly":true |
| 99 | + }, |
63 | 100 | "PutRecord":{ |
64 | 101 | "name":"PutRecord", |
65 | 102 | "http":{ |
|
216 | 253 | "member":{"shape":"BatchGetRecordResultDetail"}, |
217 | 254 | "min":0 |
218 | 255 | }, |
| 256 | + "BatchWriteRecordEntries":{ |
| 257 | + "type":"list", |
| 258 | + "member":{"shape":"BatchWriteRecordEntry"}, |
| 259 | + "max":25, |
| 260 | + "min":1 |
| 261 | + }, |
| 262 | + "BatchWriteRecordEntry":{ |
| 263 | + "type":"structure", |
| 264 | + "required":[ |
| 265 | + "FeatureGroupName", |
| 266 | + "Record" |
| 267 | + ], |
| 268 | + "members":{ |
| 269 | + "FeatureGroupName":{ |
| 270 | + "shape":"FeatureGroupNameOrArn", |
| 271 | + "documentation":"<p>The name or Amazon Resource Name (ARN) of the <code>FeatureGroup</code> to write the record to.</p>" |
| 272 | + }, |
| 273 | + "Record":{ |
| 274 | + "shape":"Record", |
| 275 | + "documentation":"<p>List of FeatureValues to be inserted. This will be a full over-write.</p>" |
| 276 | + }, |
| 277 | + "TargetStores":{ |
| 278 | + "shape":"TargetStores", |
| 279 | + "documentation":"<p>A list of stores to which you're adding the record. By default, Feature Store adds the record to all of the stores that you're using for the <code>FeatureGroup</code>.</p>" |
| 280 | + }, |
| 281 | + "TtlDuration":{ |
| 282 | + "shape":"TtlDuration", |
| 283 | + "documentation":"<p>Time to live duration for this entry, where the record is hard deleted after the expiration time is reached; <code>ExpiresAt</code> = <code>EventTime</code> + <code>TtlDuration</code>. This overrides the request level <code>TtlDuration</code>.</p>" |
| 284 | + } |
| 285 | + }, |
| 286 | + "documentation":"<p>An entry to write as part of a <code>BatchWriteRecord</code> request.</p>" |
| 287 | + }, |
| 288 | + "BatchWriteRecordError":{ |
| 289 | + "type":"structure", |
| 290 | + "required":[ |
| 291 | + "Entry", |
| 292 | + "ErrorCode", |
| 293 | + "ErrorMessage" |
| 294 | + ], |
| 295 | + "members":{ |
| 296 | + "Entry":{ |
| 297 | + "shape":"BatchWriteRecordEntry", |
| 298 | + "documentation":"<p>The entry that failed to be written.</p>" |
| 299 | + }, |
| 300 | + "ErrorCode":{ |
| 301 | + "shape":"ValueAsString", |
| 302 | + "documentation":"<p>The error code for the failed record write.</p>" |
| 303 | + }, |
| 304 | + "ErrorMessage":{ |
| 305 | + "shape":"Message", |
| 306 | + "documentation":"<p>The error message for the failed record write.</p>" |
| 307 | + } |
| 308 | + }, |
| 309 | + "documentation":"<p>The error that has occurred when attempting to write a record in a batch.</p>" |
| 310 | + }, |
| 311 | + "BatchWriteRecordErrors":{ |
| 312 | + "type":"list", |
| 313 | + "member":{"shape":"BatchWriteRecordError"}, |
| 314 | + "min":0 |
| 315 | + }, |
| 316 | + "BatchWriteRecordRequest":{ |
| 317 | + "type":"structure", |
| 318 | + "required":["Entries"], |
| 319 | + "members":{ |
| 320 | + "Entries":{ |
| 321 | + "shape":"BatchWriteRecordEntries", |
| 322 | + "documentation":"<p>A list of records to write. Each entry specifies the <code>FeatureGroup</code>, the record data, and optionally target stores and a TTL duration.</p>" |
| 323 | + }, |
| 324 | + "TtlDuration":{ |
| 325 | + "shape":"TtlDuration", |
| 326 | + "documentation":"<p>Time to live duration applied to all entries in the batch that do not specify their own <code>TtlDuration</code>; <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>" |
| 327 | + } |
| 328 | + } |
| 329 | + }, |
| 330 | + "BatchWriteRecordResponse":{ |
| 331 | + "type":"structure", |
| 332 | + "required":[ |
| 333 | + "Errors", |
| 334 | + "UnprocessedEntries" |
| 335 | + ], |
| 336 | + "members":{ |
| 337 | + "Errors":{ |
| 338 | + "shape":"BatchWriteRecordErrors", |
| 339 | + "documentation":"<p>A list of errors that occurred when writing records in the batch.</p>" |
| 340 | + }, |
| 341 | + "UnprocessedEntries":{ |
| 342 | + "shape":"UnprocessedBatchWriteRecordEntries", |
| 343 | + "documentation":"<p>A list of entries that were not processed. These entries can be retried.</p>" |
| 344 | + } |
| 345 | + } |
| 346 | + }, |
| 347 | + "Boolean":{"type":"boolean"}, |
219 | 348 | "DeleteRecordRequest":{ |
220 | 349 | "type":"structure", |
221 | 350 | "required":[ |
|
364 | 493 | "fault":true, |
365 | 494 | "synthetic":true |
366 | 495 | }, |
| 496 | + "ListRecordsMaxResults":{ |
| 497 | + "type":"integer", |
| 498 | + "max":100, |
| 499 | + "min":1 |
| 500 | + }, |
| 501 | + "ListRecordsNextToken":{ |
| 502 | + "type":"string", |
| 503 | + "max":8192, |
| 504 | + "min":1 |
| 505 | + }, |
| 506 | + "ListRecordsRequest":{ |
| 507 | + "type":"structure", |
| 508 | + "required":["FeatureGroupName"], |
| 509 | + "members":{ |
| 510 | + "FeatureGroupName":{ |
| 511 | + "shape":"FeatureGroupNameOrArn", |
| 512 | + "documentation":"<p>The name or Amazon Resource Name (ARN) of the feature group to list records from.</p>", |
| 513 | + "location":"uri", |
| 514 | + "locationName":"FeatureGroupName" |
| 515 | + }, |
| 516 | + "MaxResults":{ |
| 517 | + "shape":"ListRecordsMaxResults", |
| 518 | + "documentation":"<p>The maximum number of record identifiers to return in a single page of results. For the <code>InMemory</code> tier, this value is a hint and not a strict requirement. The response may contain more or fewer results than the specified <code>MaxResults</code>.</p>" |
| 519 | + }, |
| 520 | + "NextToken":{ |
| 521 | + "shape":"ListRecordsNextToken", |
| 522 | + "documentation":"<p>A token to resume pagination of <code>ListRecords</code> results.</p>" |
| 523 | + }, |
| 524 | + "IncludeSoftDeletedRecords":{ |
| 525 | + "shape":"Boolean", |
| 526 | + "documentation":"<p>If set to <code>true</code>, the result includes records that have been soft deleted.</p>" |
| 527 | + } |
| 528 | + } |
| 529 | + }, |
| 530 | + "ListRecordsResponse":{ |
| 531 | + "type":"structure", |
| 532 | + "required":["RecordIdentifiers"], |
| 533 | + "members":{ |
| 534 | + "RecordIdentifiers":{ |
| 535 | + "shape":"RecordIdentifierList", |
| 536 | + "documentation":"<p>A list of record identifier values for the records stored in the <code>OnlineStore</code>.</p>" |
| 537 | + }, |
| 538 | + "NextToken":{ |
| 539 | + "shape":"ListRecordsNextToken", |
| 540 | + "documentation":"<p>A token to resume pagination if the response includes more record identifiers than <code>MaxResults</code>.</p>" |
| 541 | + } |
| 542 | + } |
| 543 | + }, |
367 | 544 | "Message":{ |
368 | 545 | "type":"string", |
369 | 546 | "max":2048 |
|
400 | 577 | "member":{"shape":"FeatureValue"}, |
401 | 578 | "min":1 |
402 | 579 | }, |
| 580 | + "RecordIdentifierList":{ |
| 581 | + "type":"list", |
| 582 | + "member":{"shape":"ValueAsString"} |
| 583 | + }, |
403 | 584 | "RecordIdentifiers":{ |
404 | 585 | "type":"list", |
405 | 586 | "member":{"shape":"ValueAsString"}, |
|
471 | 652 | "type":"integer", |
472 | 653 | "min":1 |
473 | 654 | }, |
| 655 | + "UnprocessedBatchWriteRecordEntries":{ |
| 656 | + "type":"list", |
| 657 | + "member":{"shape":"BatchWriteRecordEntry"}, |
| 658 | + "min":0 |
| 659 | + }, |
474 | 660 | "UnprocessedIdentifiers":{ |
475 | 661 | "type":"list", |
476 | 662 | "member":{"shape":"BatchGetRecordIdentifier"}, |
|
0 commit comments