| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Rekognition.UpdateDatasetEntries
Description
Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Image-Level labels in manifest files and Object localization in manifest files in the /Amazon Rekognition Custom Labels Developer Guide/.
If the source-ref field in the JSON line references an existing image,
the existing image in the dataset is updated. If source-ref field
doesn't reference an existing image, the image is added as a new image
to the dataset.
You specify the changes that you want to make in the Changes input
parameter. There isn't a limit to the number JSON Lines that you can
change, but the size of Changes must be less than 5MB.
UpdateDatasetEntries returns immediatly, but the dataset update might
take a while to complete. Use DescribeDataset to check the current
status. The dataset updated successfully if the value of Status is
UPDATE_COMPLETE.
To check if any non-terminal errors occured, call ListDatasetEntries and
check for the presence of errors lists in the JSON Lines.
Dataset update fails if a terminal error occurs (Status =
UPDATE_FAILED). Currently, you can't access the terminal error
information from the Amazon Rekognition Custom Labels SDK.
This operation requires permissions to perform the
rekognition:UpdateDatasetEntries action.
Synopsis
- data UpdateDatasetEntries = UpdateDatasetEntries' {}
- newUpdateDatasetEntries :: Text -> DatasetChanges -> UpdateDatasetEntries
- updateDatasetEntries_datasetArn :: Lens' UpdateDatasetEntries Text
- updateDatasetEntries_changes :: Lens' UpdateDatasetEntries DatasetChanges
- data UpdateDatasetEntriesResponse = UpdateDatasetEntriesResponse' {
- httpStatus :: Int
- newUpdateDatasetEntriesResponse :: Int -> UpdateDatasetEntriesResponse
- updateDatasetEntriesResponse_httpStatus :: Lens' UpdateDatasetEntriesResponse Int
Creating a Request
data UpdateDatasetEntries Source #
See: newUpdateDatasetEntries smart constructor.
Constructors
| UpdateDatasetEntries' | |
Fields
| |
Instances
newUpdateDatasetEntries Source #
Arguments
| :: Text | |
| -> DatasetChanges | |
| -> UpdateDatasetEntries |
Create a value of UpdateDatasetEntries with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDatasetEntries, updateDatasetEntries_datasetArn - The Amazon Resource Name (ARN) of the dataset that you want to update.
$sel:changes:UpdateDatasetEntries', updateDatasetEntries_changes - The changes that you want to make to the dataset.
Request Lenses
updateDatasetEntries_datasetArn :: Lens' UpdateDatasetEntries Text Source #
The Amazon Resource Name (ARN) of the dataset that you want to update.
updateDatasetEntries_changes :: Lens' UpdateDatasetEntries DatasetChanges Source #
The changes that you want to make to the dataset.
Destructuring the Response
data UpdateDatasetEntriesResponse Source #
See: newUpdateDatasetEntriesResponse smart constructor.
Constructors
| UpdateDatasetEntriesResponse' | |
Fields
| |
Instances
newUpdateDatasetEntriesResponse Source #
Create a value of UpdateDatasetEntriesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDatasetEntriesResponse', updateDatasetEntriesResponse_httpStatus - The response's http status code.
Response Lenses
updateDatasetEntriesResponse_httpStatus :: Lens' UpdateDatasetEntriesResponse Int Source #
The response's http status code.