github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/lookoutvision/2020-11-20/docs-2.json (about) 1 { 2 "version": "2.0", 3 "service": "<p>This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, data types, common parameters, and common errors.</p> <p>Amazon Lookout for Vision enables you to find visual defects in industrial products, accurately and at scale. It uses computer vision to identify missing components in an industrial product, damage to vehicles or structures, irregularities in production lines, and even minuscule defects in silicon wafers — or any other physical item where quality is important such as a missing capacitor on printed circuit boards.</p>", 4 "operations": { 5 "CreateDataset": "<p>Creates a new dataset in an Amazon Lookout for Vision project. <code>CreateDataset</code> can create a training or a test dataset from a valid dataset source (<code>DatasetSource</code>).</p> <p>If you want a single dataset project, specify <code>train</code> for the value of <code>DatasetType</code>.</p> <p>To have a project with separate training and test datasets, call <code>CreateDataset</code> twice. On the first call, specify <code>train</code> for the value of <code>DatasetType</code>. On the second call, specify <code>test</code> for the value of <code>DatasetType</code>. </p> <p>This operation requires permissions to perform the <code>lookoutvision:CreateDataset</code> operation.</p>", 6 "CreateModel": "<p>Creates a new version of a model within an an Amazon Lookout for Vision project. <code>CreateModel</code> is an asynchronous operation in which Amazon Lookout for Vision trains, tests, and evaluates a new version of a model. </p> <p>To get the current status, check the <code>Status</code> field returned in the response from <a>DescribeModel</a>.</p> <p>If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test the model. </p> <p>After training completes, the evaluation metrics are stored at the location specified in <code>OutputConfig</code>. </p> <p>This operation requires permissions to perform the <code>lookoutvision:CreateModel</code> operation. If you want to tag your model, you also require permission to the <code>lookoutvision:TagResource</code> operation.</p>", 7 "CreateProject": "<p>Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling <a>CreateDataset</a>.</p> <p>This operation requires permissions to perform the <code>lookoutvision:CreateProject</code> operation.</p>", 8 "DeleteDataset": "<p>Deletes an existing Amazon Lookout for Vision <code>dataset</code>. </p> <p>If your the project has a single dataset, you must create a new dataset before you can create a model.</p> <p>If you project has a training dataset and a test dataset consider the following. </p> <ul> <li> <p>If you delete the test dataset, your project reverts to a single dataset project. If you then train the model, Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset.</p> </li> <li> <p>If you delete the training dataset, you must create a training dataset before you can create a model.</p> </li> </ul> <p>This operation requires permissions to perform the <code>lookoutvision:DeleteDataset</code> operation.</p>", 9 "DeleteModel": "<p>Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the <a>StopModel</a> operation.</p> <p>It might take a few seconds to delete a model. To determine if a model has been deleted, call <a>ListProjects</a> and check if the version of the model (<code>ModelVersion</code>) is in the <code>Models</code> array. </p> <p>This operation requires permissions to perform the <code>lookoutvision:DeleteModel</code> operation.</p>", 10 "DeleteProject": "<p>Deletes an Amazon Lookout for Vision project.</p> <p>To delete a project, you must first delete each version of the model associated with the project. To delete a model use the <a>DeleteModel</a> operation.</p> <p>You also have to delete the dataset(s) associated with the model. For more information, see <a>DeleteDataset</a>. The images referenced by the training and test datasets aren't deleted. </p> <p>This operation requires permissions to perform the <code>lookoutvision:DeleteProject</code> operation.</p>", 11 "DescribeDataset": "<p>Describe an Amazon Lookout for Vision dataset.</p> <p>This operation requires permissions to perform the <code>lookoutvision:DescribeDataset</code> operation.</p>", 12 "DescribeModel": "<p>Describes a version of an Amazon Lookout for Vision model.</p> <p>This operation requires permissions to perform the <code>lookoutvision:DescribeModel</code> operation.</p>", 13 "DescribeProject": "<p>Describes an Amazon Lookout for Vision project.</p> <p>This operation requires permissions to perform the <code>lookoutvision:DescribeProject</code> operation.</p>", 14 "DetectAnomalies": "<p>Detects anomalies in an image that you supply. </p> <p>The response from <code>DetectAnomalies</code> includes a boolean prediction that the image contains one or more anomalies and a confidence value for the prediction.</p> <note> <p>Before calling <code>DetectAnomalies</code>, you must first start your model with the <a>StartModel</a> operation. You are charged for the amount of time, in minutes, that a model runs and for the number of anomaly detection units that your model uses. If you are not using a model, use the <a>StopModel</a> operation to stop your model. </p> </note> <p>This operation requires permissions to perform the <code>lookoutvision:DetectAnomalies</code> operation.</p>", 15 "ListDatasetEntries": "<p>Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information for a single image, including the image location and the assigned label.</p> <p>This operation requires permissions to perform the <code>lookoutvision:ListDatasetEntries</code> operation.</p>", 16 "ListModels": "<p>Lists the versions of a model in an Amazon Lookout for Vision project.</p> <p>This operation requires permissions to perform the <code>lookoutvision:ListModels</code> operation.</p>", 17 "ListProjects": "<p>Lists the Amazon Lookout for Vision projects in your AWS account.</p> <p>This operation requires permissions to perform the <code>lookoutvision:ListProjects</code> operation.</p>", 18 "ListTagsForResource": "<p>Returns a list of tags attached to the specified Amazon Lookout for Vision model.</p> <p>This operation requires permissions to perform the <code>lookoutvision:ListTagsForResource</code> operation.</p>", 19 "StartModel": "<p>Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to complete. To check the current state of the model, use <a>DescribeModel</a>.</p> <p>A model is ready to use when its status is <code>HOSTED</code>.</p> <p>Once the model is running, you can detect custom labels in new images by calling <a>DetectAnomalies</a>.</p> <note> <p>You are charged for the amount of time that the model is running. To stop a running model, call <a>StopModel</a>.</p> </note> <p>This operation requires permissions to perform the <code>lookoutvision:StartModel</code> operation.</p>", 20 "StopModel": "<p>Stops the hosting of a running model. The operation might take a while to complete. To check the current status, call <a>DescribeModel</a>. </p> <p>After the model hosting stops, the <code>Status</code> of the model is <code>TRAINED</code>.</p> <p>This operation requires permissions to perform the <code>lookoutvision:StopModel</code> operation.</p>", 21 "TagResource": "<p>Adds one or more key-value tags to an Amazon Lookout for Vision model. For more information, see <i>Tagging a model</i> in the <i>Amazon Lookout for Vision Developer Guide</i>. </p> <p>This operation requires permissions to perform the <code>lookoutvision:TagResource</code> operation.</p>", 22 "UntagResource": "<p>Removes one or more tags from an Amazon Lookout for Vision model. For more information, see <i>Tagging a model</i> in the <i>Amazon Lookout for Vision Developer Guide</i>. </p> <p>This operation requires permissions to perform the <code>lookoutvision:UntagResource</code> operation.</p>", 23 "UpdateDatasetEntries": "<p>Adds one or more JSON Line entries to a dataset. A JSON Line includes information about an image used for training or testing an Amazon Lookout for Vision model. The following is an example JSON Line.</p> <p>Updating a dataset might take a while to complete. To check the current status, call <a>DescribeDataset</a> and check the <code>Status</code> field in the response.</p> <p>This operation requires permissions to perform the <code>lookoutvision:UpdateDatasetEntries</code> operation.</p>" 24 }, 25 "shapes": { 26 "AccessDeniedException": { 27 "base": "<p>You are not authorized to perform the action.</p>", 28 "refs": { 29 } 30 }, 31 "AnomalyClassFilter": { 32 "base": null, 33 "refs": { 34 "ListDatasetEntriesRequest$AnomalyClass": "<p>Specify <code>normal</code> to include only normal images. Specify <code>anomaly</code> to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.</p>" 35 } 36 }, 37 "Boolean": { 38 "base": null, 39 "refs": { 40 "DetectAnomalyResult$IsAnomalous": "<p>True if the image contains an anomaly, otherwise false.</p>" 41 } 42 }, 43 "ClientToken": { 44 "base": null, 45 "refs": { 46 "CreateDatasetRequest$ClientToken": "<p>ClientToken is an idempotency token that ensures a call to <code>CreateDataset</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>CreateDataset</code>. In this case, safely retry your call to <code>CreateDataset</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>CreateDataset</code>. An idempotency token is active for 8 hours. </p>", 47 "CreateModelRequest$ClientToken": "<p>ClientToken is an idempotency token that ensures a call to <code>CreateModel</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>CreateModel</code>. In this case, safely retry your call to <code>CreateModel</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>CreateModel</code>. An idempotency token is active for 8 hours.</p>", 48 "CreateProjectRequest$ClientToken": "<p>ClientToken is an idempotency token that ensures a call to <code>CreateProject</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>CreateProject</code>. In this case, safely retry your call to <code>CreateProject</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>CreateProject</code>. An idempotency token is active for 8 hours.</p>", 49 "DeleteDatasetRequest$ClientToken": "<p>ClientToken is an idempotency token that ensures a call to <code>DeleteDataset</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>DeleteDataset</code>. In this case, safely retry your call to <code>DeleteDataset</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>DeleteDataset</code>. An idempotency token is active for 8 hours.</p>", 50 "DeleteModelRequest$ClientToken": "<p>ClientToken is an idempotency token that ensures a call to <code>DeleteModel</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>DeleteModel</code>. In this case, safely retry your call to <code>DeleteModel</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>DeleteModel</code>. An idempotency token is active for 8 hours.</p>", 51 "DeleteProjectRequest$ClientToken": "<p>ClientToken is an idempotency token that ensures a call to <code>DeleteProject</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>DeleteProject</code>. In this case, safely retry your call to <code>DeleteProject</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>DeleteProject</code>. An idempotency token is active for 8 hours.</p>", 52 "StartModelRequest$ClientToken": "<p>ClientToken is an idempotency token that ensures a call to <code>StartModel</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>StartModel</code>. In this case, safely retry your call to <code>StartModel</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>StartModel</code>. An idempotency token is active for 8 hours. </p>", 53 "StopModelRequest$ClientToken": "<p>ClientToken is an idempotency token that ensures a call to <code>StopModel</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>StopModel</code>. In this case, safely retry your call to <code>StopModel</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>StopModel</code>. An idempotency token is active for 8 hours. </p>", 54 "UpdateDatasetEntriesRequest$ClientToken": "<p>ClientToken is an idempotency token that ensures a call to <code>UpdateDatasetEntries</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>UpdateDatasetEntries</code>. In this case, safely retry your call to <code>UpdateDatasetEntries</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>UpdateDatasetEntries</code>. An idempotency token is active for 8 hours. </p>" 55 } 56 }, 57 "ConflictException": { 58 "base": "<p>The update or deletion of a resource caused an inconsistent state.</p>", 59 "refs": { 60 } 61 }, 62 "ContentType": { 63 "base": null, 64 "refs": { 65 "DetectAnomaliesRequest$ContentType": "<p>The type of the image passed in <code>Body</code>. Valid values are <code>image/png</code> (PNG format images) and <code>image/jpeg</code> (JPG format images). </p>" 66 } 67 }, 68 "CreateDatasetRequest": { 69 "base": null, 70 "refs": { 71 } 72 }, 73 "CreateDatasetResponse": { 74 "base": null, 75 "refs": { 76 } 77 }, 78 "CreateModelRequest": { 79 "base": null, 80 "refs": { 81 } 82 }, 83 "CreateModelResponse": { 84 "base": null, 85 "refs": { 86 } 87 }, 88 "CreateProjectRequest": { 89 "base": null, 90 "refs": { 91 } 92 }, 93 "CreateProjectResponse": { 94 "base": null, 95 "refs": { 96 } 97 }, 98 "DatasetChanges": { 99 "base": null, 100 "refs": { 101 "UpdateDatasetEntriesRequest$Changes": "<p>The entries to add to the dataset.</p>" 102 } 103 }, 104 "DatasetDescription": { 105 "base": "<p>The description for a dataset. For more information, see <a>DescribeDataset</a>.</p>", 106 "refs": { 107 "DescribeDatasetResponse$DatasetDescription": "<p>The description of the requested dataset. </p>" 108 } 109 }, 110 "DatasetEntry": { 111 "base": null, 112 "refs": { 113 "DatasetEntryList$member": null 114 } 115 }, 116 "DatasetEntryList": { 117 "base": null, 118 "refs": { 119 "ListDatasetEntriesResponse$DatasetEntries": "<p>A list of the entries (JSON Lines) within the dataset.</p>" 120 } 121 }, 122 "DatasetGroundTruthManifest": { 123 "base": "<p>Location information about a manifest file. You can use a manifest file to create a dataset.</p>", 124 "refs": { 125 "DatasetSource$GroundTruthManifest": "<p>Location information for the manifest file.</p>" 126 } 127 }, 128 "DatasetImageStats": { 129 "base": "<p>Statistics about the images in a dataset.</p>", 130 "refs": { 131 "DatasetDescription$ImageStats": "<p/>" 132 } 133 }, 134 "DatasetMetadata": { 135 "base": "<p>Sumary information for an Amazon Lookout for Vision dataset.</p>", 136 "refs": { 137 "CreateDatasetResponse$DatasetMetadata": "<p>Information about the dataset.</p>", 138 "DatasetMetadataList$member": null 139 } 140 }, 141 "DatasetMetadataList": { 142 "base": null, 143 "refs": { 144 "ProjectDescription$Datasets": "<p>A list of datasets in the project.</p>" 145 } 146 }, 147 "DatasetSource": { 148 "base": "<p>Information about the location of a manifest file that Amazon Lookout for Vision uses to to create a dataset.</p>", 149 "refs": { 150 "CreateDatasetRequest$DatasetSource": "<p>The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.</p> <p>If you don't specify <code>DatasetSource</code>, an empty dataset is created and the operation synchronously returns. Later, you can add JSON Lines by calling <a>UpdateDatasetEntries</a>. </p> <p>If you specify a value for <code>DataSource</code>, the manifest at the S3 location is validated and used to create the dataset. The call to <code>CreateDataset</code> is asynchronous and might take a while to complete. To find out the current status, Check the value of <code>Status</code> returned in a call to <a>DescribeDataset</a>.</p>" 151 } 152 }, 153 "DatasetStatus": { 154 "base": null, 155 "refs": { 156 "DatasetDescription$Status": "<p>The status of the dataset.</p>", 157 "DatasetMetadata$Status": "<p>The status for the dataset.</p>", 158 "UpdateDatasetEntriesResponse$Status": "<p>The status of the dataset update.</p>" 159 } 160 }, 161 "DatasetStatusMessage": { 162 "base": null, 163 "refs": { 164 "DatasetDescription$StatusMessage": "<p>The status message for the dataset. </p>", 165 "DatasetMetadata$StatusMessage": "<p>The status message for the dataset.</p>" 166 } 167 }, 168 "DatasetType": { 169 "base": null, 170 "refs": { 171 "CreateDatasetRequest$DatasetType": "<p>The type of the dataset. Specify <code>train</code> for a training dataset. Specify <code>test</code> for a test dataset.</p>", 172 "DatasetDescription$DatasetType": "<p>The type of the dataset. The value <code>train</code> represents a training dataset or single dataset project. The value <code>test</code> represents a test dataset.</p>", 173 "DatasetMetadata$DatasetType": "<p>The type of the dataset.</p>", 174 "DeleteDatasetRequest$DatasetType": "<p>The type of the dataset to delete. Specify <code>train</code> to delete the training dataset. Specify <code>test</code> to delete the test dataset. To delete the dataset in a single dataset project, specify <code>train</code>.</p>", 175 "DescribeDatasetRequest$DatasetType": "<p>The type of the dataset to describe. Specify <code>train</code> to describe the training dataset. Specify <code>test</code> to describe the test dataset. If you have a single dataset project, specify <code>train</code> </p>", 176 "ListDatasetEntriesRequest$DatasetType": "<p>The type of the dataset that you want to list. Specify <code>train</code> to list the training dataset. Specify <code>test</code> to list the test dataset. If you have a single dataset project, specify <code>train</code>.</p>", 177 "UpdateDatasetEntriesRequest$DatasetType": "<p>The type of the dataset that you want to update. Specify <code>train</code> to update the training dataset. Specify <code>test</code> to update the test dataset. If you have a single dataset project, specify <code>train</code>.</p>" 178 } 179 }, 180 "DateTime": { 181 "base": null, 182 "refs": { 183 "DatasetDescription$CreationTimestamp": "<p>The Unix timestamp for the time and date that the dataset was created.</p>", 184 "DatasetDescription$LastUpdatedTimestamp": "<p>The Unix timestamp for the date and time that the dataset was last updated.</p>", 185 "DatasetMetadata$CreationTimestamp": "<p>The Unix timestamp for the date and time that the dataset was created. </p>", 186 "ListDatasetEntriesRequest$BeforeCreationDate": "<p>Only includes entries before the specified date in the response. For example, <code>2020-06-23T00:00:00</code>.</p>", 187 "ListDatasetEntriesRequest$AfterCreationDate": "<p>Only includes entries after the specified date in the response. For example, <code>2020-06-23T00:00:00</code>.</p>", 188 "ModelDescription$CreationTimestamp": "<p>The unix timestamp for the date and time that the model was created. </p>", 189 "ModelDescription$EvaluationEndTimestamp": "<p>The unix timestamp for the date and time that the evaluation ended. </p>", 190 "ModelMetadata$CreationTimestamp": "<p>The unix timestamp for the date and time that the model was created. </p>", 191 "ProjectDescription$CreationTimestamp": "<p>The unix timestamp for the date and time that the project was created. </p>", 192 "ProjectMetadata$CreationTimestamp": "<p>The unix timestamp for the date and time that the project was created. </p>" 193 } 194 }, 195 "DeleteDatasetRequest": { 196 "base": null, 197 "refs": { 198 } 199 }, 200 "DeleteDatasetResponse": { 201 "base": null, 202 "refs": { 203 } 204 }, 205 "DeleteModelRequest": { 206 "base": null, 207 "refs": { 208 } 209 }, 210 "DeleteModelResponse": { 211 "base": null, 212 "refs": { 213 } 214 }, 215 "DeleteProjectRequest": { 216 "base": null, 217 "refs": { 218 } 219 }, 220 "DeleteProjectResponse": { 221 "base": null, 222 "refs": { 223 } 224 }, 225 "DescribeDatasetRequest": { 226 "base": null, 227 "refs": { 228 } 229 }, 230 "DescribeDatasetResponse": { 231 "base": null, 232 "refs": { 233 } 234 }, 235 "DescribeModelRequest": { 236 "base": null, 237 "refs": { 238 } 239 }, 240 "DescribeModelResponse": { 241 "base": null, 242 "refs": { 243 } 244 }, 245 "DescribeProjectRequest": { 246 "base": null, 247 "refs": { 248 } 249 }, 250 "DescribeProjectResponse": { 251 "base": null, 252 "refs": { 253 } 254 }, 255 "DetectAnomaliesRequest": { 256 "base": null, 257 "refs": { 258 } 259 }, 260 "DetectAnomaliesResponse": { 261 "base": null, 262 "refs": { 263 } 264 }, 265 "DetectAnomalyResult": { 266 "base": "<p>The prediction results from a call to <a>DetectAnomalies</a>.</p>", 267 "refs": { 268 "DetectAnomaliesResponse$DetectAnomalyResult": "<p>The results of the <code>DetectAnomalies</code> operation.</p>" 269 } 270 }, 271 "ExceptionString": { 272 "base": null, 273 "refs": { 274 "AccessDeniedException$Message": null, 275 "ConflictException$Message": null, 276 "ConflictException$ResourceId": "<p>The ID of the resource.</p>", 277 "InternalServerException$Message": null, 278 "ResourceNotFoundException$Message": null, 279 "ResourceNotFoundException$ResourceId": "<p>The ID of the resource.</p>", 280 "ServiceQuotaExceededException$Message": null, 281 "ServiceQuotaExceededException$ResourceId": "<p>The ID of the resource.</p>", 282 "ServiceQuotaExceededException$QuotaCode": "<p>The quota code. </p>", 283 "ServiceQuotaExceededException$ServiceCode": "<p>The service code. </p>", 284 "ThrottlingException$Message": null, 285 "ThrottlingException$QuotaCode": "<p>The quota code. </p>", 286 "ThrottlingException$ServiceCode": "<p>The service code. </p>", 287 "ValidationException$Message": null 288 } 289 }, 290 "Float": { 291 "base": null, 292 "refs": { 293 "DetectAnomalyResult$Confidence": "<p>The confidence that Amazon Lookout for Vision has in the accuracy of the prediction.</p>", 294 "ModelPerformance$F1Score": "<p>The overall F1 score metric for the trained model.</p>", 295 "ModelPerformance$Recall": "<p>The overall recall metric value for the trained model. </p>", 296 "ModelPerformance$Precision": "<p>The overall precision metric value for the trained model.</p>" 297 } 298 }, 299 "ImageSource": { 300 "base": "<p>The source for an image.</p>", 301 "refs": { 302 "DetectAnomalyResult$Source": "<p>The source of the image that was analyzed. <code>direct</code> means that the images was supplied from the local computer. No other values are supported.</p>" 303 } 304 }, 305 "ImageSourceType": { 306 "base": null, 307 "refs": { 308 "ImageSource$Type": "<p>The type of the image.</p>" 309 } 310 }, 311 "InferenceUnits": { 312 "base": null, 313 "refs": { 314 "StartModelRequest$MinInferenceUnits": "<p>The minimum number of inference units to use. A single inference unit represents 1 hour of processing and can support up to 5 Transaction Pers Second (TPS). Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use. </p>" 315 } 316 }, 317 "InputS3Object": { 318 "base": "<p>Amazon S3 Location information for an input manifest file. </p>", 319 "refs": { 320 "DatasetGroundTruthManifest$S3Object": "<p>The S3 bucket location for the manifest file.</p>" 321 } 322 }, 323 "Integer": { 324 "base": null, 325 "refs": { 326 "DatasetImageStats$Total": "<p>The total number of images in the dataset.</p>", 327 "DatasetImageStats$Labeled": "<p>The total number of labeled images.</p>", 328 "DatasetImageStats$Normal": "<p>The total number of images labeled as normal.</p>", 329 "DatasetImageStats$Anomaly": "<p>the total number of images labeled as an anomaly.</p>" 330 } 331 }, 332 "InternalServerException": { 333 "base": "<p>Amazon Lookout for Vision experienced a service issue. Try your call again.</p>", 334 "refs": { 335 } 336 }, 337 "IsLabeled": { 338 "base": null, 339 "refs": { 340 "ListDatasetEntriesRequest$Labeled": "<p>Specify <code>true</code> to include labeled entries, otherwise specify <code>false</code>. If you don't specify a value, Lookout for Vision returns all entries.</p>" 341 } 342 }, 343 "KmsKeyId": { 344 "base": null, 345 "refs": { 346 "CreateModelRequest$KmsKeyId": "<p>The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK). The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.</p>", 347 "ModelDescription$KmsKeyId": "<p>The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.</p>" 348 } 349 }, 350 "ListDatasetEntriesRequest": { 351 "base": null, 352 "refs": { 353 } 354 }, 355 "ListDatasetEntriesResponse": { 356 "base": null, 357 "refs": { 358 } 359 }, 360 "ListModelsRequest": { 361 "base": null, 362 "refs": { 363 } 364 }, 365 "ListModelsResponse": { 366 "base": null, 367 "refs": { 368 } 369 }, 370 "ListProjectsRequest": { 371 "base": null, 372 "refs": { 373 } 374 }, 375 "ListProjectsResponse": { 376 "base": null, 377 "refs": { 378 } 379 }, 380 "ListTagsForResourceRequest": { 381 "base": null, 382 "refs": { 383 } 384 }, 385 "ListTagsForResourceResponse": { 386 "base": null, 387 "refs": { 388 } 389 }, 390 "ModelArn": { 391 "base": null, 392 "refs": { 393 "DeleteModelResponse$ModelArn": "<p>The Amazon Resource Name (ARN) of the model that was deleted.</p>", 394 "ModelDescription$ModelArn": "<p>The Amazon Resource Name (ARN) of the model.</p>", 395 "ModelMetadata$ModelArn": "<p>The Amazon Resource Name (ARN) of the model.</p>" 396 } 397 }, 398 "ModelDescription": { 399 "base": "<p>Describes an Amazon Lookout for Vision model.</p>", 400 "refs": { 401 "DescribeModelResponse$ModelDescription": "<p>Contains the description of the model.</p>" 402 } 403 }, 404 "ModelDescriptionMessage": { 405 "base": null, 406 "refs": { 407 "CreateModelRequest$Description": "<p>A description for the version of the model.</p>", 408 "ModelDescription$Description": "<p>The description for the model.</p>", 409 "ModelMetadata$Description": "<p>The description for the model.</p>" 410 } 411 }, 412 "ModelHostingStatus": { 413 "base": null, 414 "refs": { 415 "StartModelResponse$Status": "<p>The current running status of the model.</p>", 416 "StopModelResponse$Status": "<p>The status of the model.</p>" 417 } 418 }, 419 "ModelMetadata": { 420 "base": "<p>Describes an Amazon Lookout for Vision model.</p>", 421 "refs": { 422 "CreateModelResponse$ModelMetadata": "<p>The response from a call to <code>CreateModel</code>.</p>", 423 "ModelMetadataList$member": null 424 } 425 }, 426 "ModelMetadataList": { 427 "base": null, 428 "refs": { 429 "ListModelsResponse$Models": "<p>A list of model versions in the specified project. </p>" 430 } 431 }, 432 "ModelPerformance": { 433 "base": "<p>Information about the evaluation performance of a trained model. </p>", 434 "refs": { 435 "ModelDescription$Performance": "<p>Performance metrics for the model. Created during training.</p>", 436 "ModelMetadata$Performance": "<p>Performance metrics for the model. Not available until training has successfully completed.</p>" 437 } 438 }, 439 "ModelStatus": { 440 "base": null, 441 "refs": { 442 "ModelDescription$Status": "<p>The status of the model.</p>", 443 "ModelMetadata$Status": "<p>The status of the model.</p>" 444 } 445 }, 446 "ModelStatusMessage": { 447 "base": null, 448 "refs": { 449 "ModelDescription$StatusMessage": "<p>The status message for the model.</p>", 450 "ModelMetadata$StatusMessage": "<p>The status message for the model.</p>" 451 } 452 }, 453 "ModelVersion": { 454 "base": null, 455 "refs": { 456 "DeleteModelRequest$ModelVersion": "<p>The version of the model that you want to delete.</p>", 457 "DescribeModelRequest$ModelVersion": "<p>The version of the model that you want to describe.</p>", 458 "DetectAnomaliesRequest$ModelVersion": "<p>The version of the model that you want to use.</p>", 459 "ModelDescription$ModelVersion": "<p>The version of the model</p>", 460 "ModelMetadata$ModelVersion": "<p>The version of the model.</p>", 461 "StartModelRequest$ModelVersion": "<p>The version of the model that you want to start.</p>", 462 "StopModelRequest$ModelVersion": "<p>The version of the model that you want to stop.</p>" 463 } 464 }, 465 "OutputConfig": { 466 "base": "<p>The S3 location where Amazon Lookout for Vision saves model training files.</p>", 467 "refs": { 468 "CreateModelRequest$OutputConfig": "<p>The location where Amazon Lookout for Vision saves the training results.</p>", 469 "ModelDescription$OutputConfig": "<p>The S3 location where Amazon Lookout for Vision saves model training files.</p>" 470 } 471 }, 472 "OutputS3Object": { 473 "base": "<p>The S3 location where Amazon Lookout for Vision saves training output.</p>", 474 "refs": { 475 "ModelDescription$EvaluationManifest": "<p>The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.</p>", 476 "ModelDescription$EvaluationResult": "<p>The S3 location where Amazon Lookout for Vision saves the performance metrics.</p>" 477 } 478 }, 479 "PageSize": { 480 "base": null, 481 "refs": { 482 "ListDatasetEntriesRequest$MaxResults": "<p>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.</p>", 483 "ListModelsRequest$MaxResults": "<p>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.</p>", 484 "ListProjectsRequest$MaxResults": "<p>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.</p>" 485 } 486 }, 487 "PaginationToken": { 488 "base": null, 489 "refs": { 490 "ListDatasetEntriesRequest$NextToken": "<p>If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.</p>", 491 "ListDatasetEntriesResponse$NextToken": "<p>If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set ofdataset entries.</p>", 492 "ListModelsRequest$NextToken": "<p>If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of models.</p>", 493 "ListModelsResponse$NextToken": "<p>If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of models. </p>", 494 "ListProjectsRequest$NextToken": "<p>If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of projects.</p>", 495 "ListProjectsResponse$NextToken": "<p>If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of projects.</p>" 496 } 497 }, 498 "ProjectArn": { 499 "base": null, 500 "refs": { 501 "DeleteProjectResponse$ProjectArn": "<p>The Amazon Resource Name (ARN) of the project that was deleted.</p>", 502 "ProjectDescription$ProjectArn": "<p>The Amazon Resource Name (ARN) of the project.</p>", 503 "ProjectMetadata$ProjectArn": "<p>The Amazon Resource Name (ARN) of the project.</p>" 504 } 505 }, 506 "ProjectDescription": { 507 "base": "<p>Describe an Amazon Lookout for Vision project. For more information, see <a>DescribeProject</a>.</p>", 508 "refs": { 509 "DescribeProjectResponse$ProjectDescription": "<p>The description of the project.</p>" 510 } 511 }, 512 "ProjectMetadata": { 513 "base": "<p>Metadata about an Amazon Lookout for Vision project.</p>", 514 "refs": { 515 "CreateProjectResponse$ProjectMetadata": "<p>Information about the project.</p>", 516 "ProjectMetadataList$member": null 517 } 518 }, 519 "ProjectMetadataList": { 520 "base": null, 521 "refs": { 522 "ListProjectsResponse$Projects": "<p>A list of projects in your AWS account.</p>" 523 } 524 }, 525 "ProjectName": { 526 "base": null, 527 "refs": { 528 "CreateDatasetRequest$ProjectName": "<p>The name of the project in which you want to create a dataset.</p>", 529 "CreateModelRequest$ProjectName": "<p>The name of the project in which you want to create a model version.</p>", 530 "CreateProjectRequest$ProjectName": "<p>The name for the project.</p>", 531 "DatasetDescription$ProjectName": "<p>The name of the project that contains the dataset.</p>", 532 "DeleteDatasetRequest$ProjectName": "<p>The name of the project that contains the dataset that you want to delete.</p>", 533 "DeleteModelRequest$ProjectName": "<p>The name of the project that contains the model that you want to delete.</p>", 534 "DeleteProjectRequest$ProjectName": "<p>The name of the project to delete.</p>", 535 "DescribeDatasetRequest$ProjectName": "<p>The name of the project that contains the dataset that you want to describe.</p>", 536 "DescribeModelRequest$ProjectName": "<p>The project that contains the version of a model that you want to describe.</p>", 537 "DescribeProjectRequest$ProjectName": "<p>The name of the project that you want to describe.</p>", 538 "DetectAnomaliesRequest$ProjectName": "<p>The name of the project that contains the model version that you want to use.</p>", 539 "ListDatasetEntriesRequest$ProjectName": "<p>The name of the project that contains the dataset that you want to list.</p>", 540 "ListModelsRequest$ProjectName": "<p>The name of the project that contains the model versions that you want to list.</p>", 541 "ProjectDescription$ProjectName": "<p>The name of the project.</p>", 542 "ProjectMetadata$ProjectName": "<p>The name of the project.</p>", 543 "StartModelRequest$ProjectName": "<p>The name of the project that contains the model that you want to start.</p>", 544 "StopModelRequest$ProjectName": "<p>The name of the project that contains the model that you want to stop.</p>", 545 "UpdateDatasetEntriesRequest$ProjectName": "<p>The name of the project that contains the dataset that you want to update.</p>" 546 } 547 }, 548 "QueryString": { 549 "base": null, 550 "refs": { 551 "ListDatasetEntriesRequest$SourceRefContains": "<p>Perform a \"contains\" search on the values of the <code>source-ref</code> key within the dataset. For example a value of \"IMG_17\" returns all JSON Lines where the <code>source-ref</code> key value matches <i>*IMG_17*</i>.</p>" 552 } 553 }, 554 "ResourceNotFoundException": { 555 "base": "<p>The resource could not be found.</p>", 556 "refs": { 557 } 558 }, 559 "ResourceType": { 560 "base": null, 561 "refs": { 562 "ConflictException$ResourceType": "<p>The type of the resource.</p>", 563 "ResourceNotFoundException$ResourceType": "<p>The type of the resource.</p>", 564 "ServiceQuotaExceededException$ResourceType": "<p>The type of the resource.</p>" 565 } 566 }, 567 "RetryAfterSeconds": { 568 "base": null, 569 "refs": { 570 "InternalServerException$RetryAfterSeconds": "<p>The period of time, in seconds, before the operation can be retried.</p>", 571 "ThrottlingException$RetryAfterSeconds": "<p>The period of time, in seconds, before the operation can be retried. </p>" 572 } 573 }, 574 "S3BucketName": { 575 "base": null, 576 "refs": { 577 "InputS3Object$Bucket": "<p>The Amazon S3 bucket that contains the manifest.</p>", 578 "OutputS3Object$Bucket": "<p>The bucket that contains the training output.</p>", 579 "S3Location$Bucket": "<p>The S3 bucket that contains the training output.</p>" 580 } 581 }, 582 "S3KeyPrefix": { 583 "base": null, 584 "refs": { 585 "S3Location$Prefix": "<p>The path of the folder, within the S3 bucket, that contains the training output.</p>" 586 } 587 }, 588 "S3Location": { 589 "base": "<p>Information about the location training output.</p>", 590 "refs": { 591 "OutputConfig$S3Location": "<p>The S3 location for the output.</p>" 592 } 593 }, 594 "S3ObjectKey": { 595 "base": null, 596 "refs": { 597 "InputS3Object$Key": "<p>The name and location of the manifest file withiin the bucket.</p>", 598 "OutputS3Object$Key": "<p>The location of the training output in the bucket.</p>" 599 } 600 }, 601 "S3ObjectVersion": { 602 "base": null, 603 "refs": { 604 "InputS3Object$VersionId": "<p>The version ID of the bucket.</p>" 605 } 606 }, 607 "ServiceQuotaExceededException": { 608 "base": "<p>A service quota was exceeded the allowed limit. For more information, see Limits in Amazon Lookout for Vision in the Amazon Lookout for Vision Developer Guide. </p>", 609 "refs": { 610 } 611 }, 612 "StartModelRequest": { 613 "base": null, 614 "refs": { 615 } 616 }, 617 "StartModelResponse": { 618 "base": null, 619 "refs": { 620 } 621 }, 622 "StopModelRequest": { 623 "base": null, 624 "refs": { 625 } 626 }, 627 "StopModelResponse": { 628 "base": null, 629 "refs": { 630 } 631 }, 632 "Stream": { 633 "base": null, 634 "refs": { 635 "DetectAnomaliesRequest$Body": "<p>The unencrypted image bytes that you want to analyze. </p>" 636 } 637 }, 638 "Tag": { 639 "base": "<p>A key and value pair that is attached to the specified Amazon Lookout for Vision model.</p>", 640 "refs": { 641 "TagList$member": null 642 } 643 }, 644 "TagArn": { 645 "base": null, 646 "refs": { 647 "ListTagsForResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the model for which you want to list tags. </p>", 648 "TagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the model to assign the tags.</p>", 649 "UntagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the model from which you want to remove tags. </p>" 650 } 651 }, 652 "TagKey": { 653 "base": null, 654 "refs": { 655 "Tag$Key": "<p>The key of the tag that is attached to the specified model.</p>", 656 "TagKeyList$member": null 657 } 658 }, 659 "TagKeyList": { 660 "base": null, 661 "refs": { 662 "UntagResourceRequest$TagKeys": "<p>A list of the keys of the tags that you want to remove.</p>" 663 } 664 }, 665 "TagList": { 666 "base": null, 667 "refs": { 668 "CreateModelRequest$Tags": "<p>A set of tags (key-value pairs) that you want to attach to the model.</p>", 669 "ListTagsForResourceResponse$Tags": "<p>A map of tag keys and values attached to the specified model.</p>", 670 "TagResourceRequest$Tags": "<p>The key-value tags to assign to the model.</p>" 671 } 672 }, 673 "TagResourceRequest": { 674 "base": null, 675 "refs": { 676 } 677 }, 678 "TagResourceResponse": { 679 "base": null, 680 "refs": { 681 } 682 }, 683 "TagValue": { 684 "base": null, 685 "refs": { 686 "Tag$Value": "<p>The value of the tag that is attached to the specified model.</p>" 687 } 688 }, 689 "ThrottlingException": { 690 "base": "<p>Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.</p>", 691 "refs": { 692 } 693 }, 694 "UntagResourceRequest": { 695 "base": null, 696 "refs": { 697 } 698 }, 699 "UntagResourceResponse": { 700 "base": null, 701 "refs": { 702 } 703 }, 704 "UpdateDatasetEntriesRequest": { 705 "base": null, 706 "refs": { 707 } 708 }, 709 "UpdateDatasetEntriesResponse": { 710 "base": null, 711 "refs": { 712 } 713 }, 714 "ValidationException": { 715 "base": "<p>An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.</p>", 716 "refs": { 717 } 718 } 719 } 720 }