| 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.LookoutVision.UpdateDatasetEntries
Description
Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes information about an image used for training or testing an Amazon Lookout for Vision model.
To update an existing JSON Line, use the source-ref field to identify
the JSON Line. The JSON line that you supply replaces the existing JSON
line. Any existing annotations that are not in the new JSON line are
removed from the dataset.
For more information, see /Defining JSON lines for anomaly classification/ in the Amazon Lookout for Vision Developer Guide.
The images you reference in the source-ref field of a JSON line, must
be in the same S3 bucket as the existing images in the dataset.
Updating a dataset might take a while to complete. To check the current
status, call DescribeDataset and check the Status field in the
response.
This operation requires permissions to perform the
lookoutvision:UpdateDatasetEntries operation.
Synopsis
- data UpdateDatasetEntries = UpdateDatasetEntries' {
- clientToken :: Maybe Text
- projectName :: Text
- datasetType :: Text
- changes :: Base64
- newUpdateDatasetEntries :: Text -> Text -> ByteString -> UpdateDatasetEntries
- updateDatasetEntries_clientToken :: Lens' UpdateDatasetEntries (Maybe Text)
- updateDatasetEntries_projectName :: Lens' UpdateDatasetEntries Text
- updateDatasetEntries_datasetType :: Lens' UpdateDatasetEntries Text
- updateDatasetEntries_changes :: Lens' UpdateDatasetEntries ByteString
- data UpdateDatasetEntriesResponse = UpdateDatasetEntriesResponse' {}
- newUpdateDatasetEntriesResponse :: Int -> UpdateDatasetEntriesResponse
- updateDatasetEntriesResponse_status :: Lens' UpdateDatasetEntriesResponse (Maybe DatasetStatus)
- updateDatasetEntriesResponse_httpStatus :: Lens' UpdateDatasetEntriesResponse Int
Creating a Request
data UpdateDatasetEntries Source #
See: newUpdateDatasetEntries smart constructor.
Constructors
| UpdateDatasetEntries' | |
Fields
| |
Instances
newUpdateDatasetEntries Source #
Arguments
| :: Text | |
| -> Text | |
| -> ByteString | |
| -> 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:
$sel:clientToken:UpdateDatasetEntries', updateDatasetEntries_clientToken - ClientToken is an idempotency token that ensures a call to
UpdateDatasetEntries completes only once. You choose the value to
pass. For example, An issue might prevent you from getting a response
from UpdateDatasetEntries. In this case, safely retry your call to
UpdateDatasetEntries by using the same ClientToken parameter value.
If you don't supply a value for ClientToken, the AWS SDK you are
using inserts a value for you. This prevents retries after a network
error from making multiple updates with the same dataset entries.
You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the
first request. Using a different value for ClientToken is considered a
new call to UpdateDatasetEntries. An idempotency token is active for 8
hours.
UpdateDatasetEntries, updateDatasetEntries_projectName - The name of the project that contains the dataset that you want to
update.
UpdateDatasetEntries, updateDatasetEntries_datasetType - The type of the dataset that you want to update. Specify train to
update the training dataset. Specify test to update the test dataset.
If you have a single dataset project, specify train.
$sel:changes:UpdateDatasetEntries', updateDatasetEntries_changes - The entries to add to the dataset.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
Request Lenses
updateDatasetEntries_clientToken :: Lens' UpdateDatasetEntries (Maybe Text) Source #
ClientToken is an idempotency token that ensures a call to
UpdateDatasetEntries completes only once. You choose the value to
pass. For example, An issue might prevent you from getting a response
from UpdateDatasetEntries. In this case, safely retry your call to
UpdateDatasetEntries by using the same ClientToken parameter value.
If you don't supply a value for ClientToken, the AWS SDK you are
using inserts a value for you. This prevents retries after a network
error from making multiple updates with the same dataset entries.
You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the
first request. Using a different value for ClientToken is considered a
new call to UpdateDatasetEntries. An idempotency token is active for 8
hours.
updateDatasetEntries_projectName :: Lens' UpdateDatasetEntries Text Source #
The name of the project that contains the dataset that you want to update.
updateDatasetEntries_datasetType :: Lens' UpdateDatasetEntries Text Source #
The type of the dataset that you want to update. Specify train to
update the training dataset. Specify test to update the test dataset.
If you have a single dataset project, specify train.
updateDatasetEntries_changes :: Lens' UpdateDatasetEntries ByteString Source #
The entries to add to the dataset.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
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:
UpdateDatasetEntriesResponse, updateDatasetEntriesResponse_status - The status of the dataset update.
$sel:httpStatus:UpdateDatasetEntriesResponse', updateDatasetEntriesResponse_httpStatus - The response's http status code.
Response Lenses
updateDatasetEntriesResponse_status :: Lens' UpdateDatasetEntriesResponse (Maybe DatasetStatus) Source #
The status of the dataset update.
updateDatasetEntriesResponse_httpStatus :: Lens' UpdateDatasetEntriesResponse Int Source #
The response's http status code.