| 1 |
{ |
| 2 |
"version": "2.0", |
| 3 |
"service": "<p>Contains all data plane API operations and data types for the Amazon SageMaker Feature Store. Use this API to put, delete, and retrieve (get) features from a feature store.</p> <p>Use the following operations to configure your <code>OnlineStore</code> and <code>OfflineStore</code> features, and to create and manage feature groups:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateFeatureGroup.html\">CreateFeatureGroup</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteFeatureGroup.html\">DeleteFeatureGroup</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeFeatureGroup.html\">DescribeFeatureGroup</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListFeatureGroups.html\">ListFeatureGroups</a> </p> </li> </ul>", |
| 4 |
"operations": { |
| 5 |
"BatchGetRecord": "<p>Retrieves a batch of <code>Records</code> from a <code>FeatureGroup</code>.</p>", |
| 6 |
"DeleteRecord": "<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> with feature values set to <code>null</code>, <code>is_deleted</code> value set to <code>True</code>, and <code>EventTime</code> set to the delete input <code>EventTime</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 (undeleted) 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>", |
| 7 |
"GetRecord": "<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>", |
| 8 |
"PutRecord": "<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>" |
| 9 |
}, |
| 10 |
"shapes": { |
| 11 |
"AccessForbidden": { |
| 12 |
"base": "<p>You do not have permission to perform an action.</p>", |
| 13 |
"refs": { |
| 14 |
} |
| 15 |
}, |
| 16 |
"BatchGetRecordError": { |
| 17 |
"base": "<p>The error that has occurred when attempting to retrieve a batch of Records.</p>", |
| 18 |
"refs": { |
| 19 |
"BatchGetRecordErrors$member": null |
| 20 |
} |
| 21 |
}, |
| 22 |
"BatchGetRecordErrors": { |
| 23 |
"base": null, |
| 24 |
"refs": { |
| 25 |
"BatchGetRecordResponse$Errors": "<p>A list of errors that have occurred when retrieving a batch of Records.</p>" |
| 26 |
} |
| 27 |
}, |
| 28 |
"BatchGetRecordIdentifier": { |
| 29 |
"base": "<p>The identifier that identifies the batch of Records you are retrieving in a batch.</p>", |
| 30 |
"refs": { |
| 31 |
"BatchGetRecordIdentifiers$member": null, |
| 32 |
"UnprocessedIdentifiers$member": null |
| 33 |
} |
| 34 |
}, |
| 35 |
"BatchGetRecordIdentifiers": { |
| 36 |
"base": null, |
| 37 |
"refs": { |
| 38 |
"BatchGetRecordRequest$Identifiers": "<p>A list containing the name or Amazon Resource Name (ARN) of the <code>FeatureGroup</code>, the list of names of <code>Feature</code>s to be retrieved, and the corresponding <code>RecordIdentifier</code> values as strings.</p>" |
| 39 |
} |
| 40 |
}, |
| 41 |
"BatchGetRecordRequest": { |
| 42 |
"base": null, |
| 43 |
"refs": { |
| 44 |
} |
| 45 |
}, |
| 46 |
"BatchGetRecordResponse": { |
| 47 |
"base": null, |
| 48 |
"refs": { |
| 49 |
} |
| 50 |
}, |
| 51 |
"BatchGetRecordResultDetail": { |
| 52 |
"base": "<p>The output of records that have been retrieved in a batch.</p>", |
| 53 |
"refs": { |
| 54 |
"BatchGetRecordResultDetails$member": null |
| 55 |
} |
| 56 |
}, |
| 57 |
"BatchGetRecordResultDetails": { |
| 58 |
"base": null, |
| 59 |
"refs": { |
| 60 |
"BatchGetRecordResponse$Records": "<p>A list of Records you requested to be retrieved in batch.</p>" |
| 61 |
} |
| 62 |
}, |
| 63 |
"DeleteRecordRequest": { |
| 64 |
"base": null, |
| 65 |
"refs": { |
| 66 |
} |
| 67 |
}, |
| 68 |
"DeletionMode": { |
| 69 |
"base": null, |
| 70 |
"refs": { |
| 71 |
"DeleteRecordRequest$DeletionMode": "<p>The name of the deletion mode for deleting the record. By default, the deletion mode is set to <code>SoftDelete</code>.</p>" |
| 72 |
} |
| 73 |
}, |
| 74 |
"ExpirationTimeResponse": { |
| 75 |
"base": null, |
| 76 |
"refs": { |
| 77 |
"BatchGetRecordRequest$ExpirationTimeResponse": "<p>Parameter to request <code>ExpiresAt</code> in response. If <code>Enabled</code>, <code>BatchGetRecord</code> will return the value of <code>ExpiresAt</code>, if it is not null. If <code>Disabled</code> and null, <code>BatchGetRecord</code> will return null.</p>", |
| 78 |
"GetRecordRequest$ExpirationTimeResponse": "<p>Parameter to request <code>ExpiresAt</code> in response. If <code>Enabled</code>, <code>GetRecord</code> will return the value of <code>ExpiresAt</code>, if it is not null. If <code>Disabled</code> and null, <code>GetRecord</code> will return null.</p>" |
| 79 |
} |
| 80 |
}, |
| 81 |
"ExpiresAt": { |
| 82 |
"base": null, |
| 83 |
"refs": { |
| 84 |
"BatchGetRecordResultDetail$ExpiresAt": "<p>The <code>ExpiresAt</code> ISO string of the requested record.</p>", |
| 85 |
"GetRecordResponse$ExpiresAt": "<p>The <code>ExpiresAt</code> ISO string of the requested record.</p>" |
| 86 |
} |
| 87 |
}, |
| 88 |
"FeatureGroupNameOrArn": { |
| 89 |
"base": null, |
| 90 |
"refs": { |
| 91 |
"BatchGetRecordIdentifier$FeatureGroupName": "<p>The name or Amazon Resource Name (ARN) of the <code>FeatureGroup</code> containing the records you are retrieving in a batch.</p>", |
| 92 |
"DeleteRecordRequest$FeatureGroupName": "<p>The name or Amazon Resource Name (ARN) of the feature group to delete the record from. </p>", |
| 93 |
"GetRecordRequest$FeatureGroupName": "<p>The name or Amazon Resource Name (ARN) of the feature group from which you want to retrieve a record.</p>", |
| 94 |
"PutRecordRequest$FeatureGroupName": "<p>The name or Amazon Resource Name (ARN) of the feature group that you want to insert the record into.</p>" |
| 95 |
} |
| 96 |
}, |
| 97 |
"FeatureName": { |
| 98 |
"base": null, |
| 99 |
"refs": { |
| 100 |
"FeatureNames$member": null, |
| 101 |
"FeatureValue$FeatureName": "<p>The name of a feature that a feature value corresponds to.</p>" |
| 102 |
} |
| 103 |
}, |
| 104 |
"FeatureNames": { |
| 105 |
"base": null, |
| 106 |
"refs": { |
| 107 |
"BatchGetRecordIdentifier$FeatureNames": "<p>List of names of Features to be retrieved. If not specified, the latest value for all the Features are returned.</p>", |
| 108 |
"GetRecordRequest$FeatureNames": "<p>List of names of Features to be retrieved. If not specified, the latest value for all the Features are returned.</p>" |
| 109 |
} |
| 110 |
}, |
| 111 |
"FeatureValue": { |
| 112 |
"base": "<p>The value associated with a feature.</p>", |
| 113 |
"refs": { |
| 114 |
"Record$member": null |
| 115 |
} |
| 116 |
}, |
| 117 |
"GetRecordRequest": { |
| 118 |
"base": null, |
| 119 |
"refs": { |
| 120 |
} |
| 121 |
}, |
| 122 |
"GetRecordResponse": { |
| 123 |
"base": null, |
| 124 |
"refs": { |
| 125 |
} |
| 126 |
}, |
| 127 |
"InternalFailure": { |
| 128 |
"base": "<p>An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.</p>", |
| 129 |
"refs": { |
| 130 |
} |
| 131 |
}, |
| 132 |
"Message": { |
| 133 |
"base": null, |
| 134 |
"refs": { |
| 135 |
"AccessForbidden$Message": null, |
| 136 |
"BatchGetRecordError$ErrorMessage": "<p>The error message of an error that has occurred when attempting to retrieve a record in the batch.</p>", |
| 137 |
"InternalFailure$Message": null, |
| 138 |
"ResourceNotFound$Message": null, |
| 139 |
"ServiceUnavailable$Message": null, |
| 140 |
"ValidationError$Message": null |
| 141 |
} |
| 142 |
}, |
| 143 |
"PutRecordRequest": { |
| 144 |
"base": null, |
| 145 |
"refs": { |
| 146 |
} |
| 147 |
}, |
| 148 |
"Record": { |
| 149 |
"base": null, |
| 150 |
"refs": { |
| 151 |
"BatchGetRecordResultDetail$Record": "<p>The <code>Record</code> retrieved.</p>", |
| 152 |
"GetRecordResponse$Record": "<p>The record you requested. A list of <code>FeatureValues</code>.</p>", |
| 153 |
"PutRecordRequest$Record": "<p>List of FeatureValues to be inserted. This will be a full over-write. If you only want to update few of the feature values, do the following:</p> <ul> <li> <p>Use <code>GetRecord</code> to retrieve the latest record.</p> </li> <li> <p>Update the record returned from <code>GetRecord</code>. </p> </li> <li> <p>Use <code>PutRecord</code> to update feature values.</p> </li> </ul>" |
| 154 |
} |
| 155 |
}, |
| 156 |
"RecordIdentifiers": { |
| 157 |
"base": null, |
| 158 |
"refs": { |
| 159 |
"BatchGetRecordIdentifier$RecordIdentifiersValueAsString": "<p>The value for a list of record identifiers in string format.</p>" |
| 160 |
} |
| 161 |
}, |
| 162 |
"ResourceNotFound": { |
| 163 |
"base": "<p>A resource that is required to perform an action was not found.</p>", |
| 164 |
"refs": { |
| 165 |
} |
| 166 |
}, |
| 167 |
"ServiceUnavailable": { |
| 168 |
"base": "<p>The service is currently unavailable.</p>", |
| 169 |
"refs": { |
| 170 |
} |
| 171 |
}, |
| 172 |
"TargetStore": { |
| 173 |
"base": null, |
| 174 |
"refs": { |
| 175 |
"TargetStores$member": null |
| 176 |
} |
| 177 |
}, |
| 178 |
"TargetStores": { |
| 179 |
"base": null, |
| 180 |
"refs": { |
| 181 |
"DeleteRecordRequest$TargetStores": "<p>A list of stores from which you're deleting the record. By default, Feature Store deletes the record from all of the stores that you're using for the <code>FeatureGroup</code>.</p>", |
| 182 |
"PutRecordRequest$TargetStores": "<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>" |
| 183 |
} |
| 184 |
}, |
| 185 |
"TtlDuration": { |
| 186 |
"base": "<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>", |
| 187 |
"refs": { |
| 188 |
"PutRecordRequest$TtlDuration": "<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>" |
| 189 |
} |
| 190 |
}, |
| 191 |
"TtlDurationUnit": { |
| 192 |
"base": null, |
| 193 |
"refs": { |
| 194 |
"TtlDuration$Unit": "<p> <code>TtlDuration</code> time unit.</p>" |
| 195 |
} |
| 196 |
}, |
| 197 |
"TtlDurationValue": { |
| 198 |
"base": null, |
| 199 |
"refs": { |
| 200 |
"TtlDuration$Value": "<p> <code>TtlDuration</code> time value.</p>" |
| 201 |
} |
| 202 |
}, |
| 203 |
"UnprocessedIdentifiers": { |
| 204 |
"base": null, |
| 205 |
"refs": { |
| 206 |
"BatchGetRecordResponse$UnprocessedIdentifiers": "<p>A unprocessed list of <code>FeatureGroup</code> names, with their corresponding <code>RecordIdentifier</code> value, and Feature name.</p>" |
| 207 |
} |
| 208 |
}, |
| 209 |
"ValidationError": { |
| 210 |
"base": "<p>There was an error validating your request.</p>", |
| 211 |
"refs": { |
| 212 |
} |
| 213 |
}, |
| 214 |
"ValueAsString": { |
| 215 |
"base": null, |
| 216 |
"refs": { |
| 217 |
"BatchGetRecordError$FeatureGroupName": "<p>The name of the feature group that the record belongs to.</p>", |
| 218 |
"BatchGetRecordError$RecordIdentifierValueAsString": "<p>The value for the <code>RecordIdentifier</code> in string format of a Record from a <code>FeatureGroup</code> that is causing an error when attempting to be retrieved.</p>", |
| 219 |
"BatchGetRecordError$ErrorCode": "<p>The error code of an error that has occurred when attempting to retrieve a batch of Records. For more information on errors, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_GetRecord.html#API_feature_store_GetRecord_Errors\">Errors</a>.</p>", |
| 220 |
"BatchGetRecordResultDetail$FeatureGroupName": "<p>The <code>FeatureGroupName</code> containing Records you retrieved in a batch.</p>", |
| 221 |
"BatchGetRecordResultDetail$RecordIdentifierValueAsString": "<p>The value of the record identifier in string format.</p>", |
| 222 |
"DeleteRecordRequest$RecordIdentifierValueAsString": "<p>The value for the <code>RecordIdentifier</code> that uniquely identifies the record, in string format. </p>", |
| 223 |
"DeleteRecordRequest$EventTime": "<p>Timestamp indicating when the deletion event occurred. <code>EventTime</code> can be used to query data at a certain point in time.</p>", |
| 224 |
"FeatureValue$ValueAsString": "<p>The value in string format associated with a feature. Used when your <code>CollectionType</code> is <code>None</code>. Note that features types can be <code>String</code>, <code>Integral</code>, or <code>Fractional</code>. This value represents all three types as a string.</p>", |
| 225 |
"GetRecordRequest$RecordIdentifierValueAsString": "<p>The value that corresponds to <code>RecordIdentifier</code> type and uniquely identifies the record in the <code>FeatureGroup</code>. </p>", |
| 226 |
"RecordIdentifiers$member": null, |
| 227 |
"ValueAsStringList$member": null |
| 228 |
} |
| 229 |
}, |
| 230 |
"ValueAsStringList": { |
| 231 |
"base": null, |
| 232 |
"refs": { |
| 233 |
"FeatureValue$ValueAsStringList": "<p>The list of values in string format associated with a feature. Used when your <code>CollectionType</code> is a <code>List</code>, <code>Set</code>, or <code>Vector</code>. Note that features types can be <code>String</code>, <code>Integral</code>, or <code>Fractional</code>. These values represents all three types as a string.</p>" |
| 234 |
} |
| 235 |
} |
| 236 |
} |
| 237 |
} |