Amazonka.Rekognition.UpdateDatasetEntries

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.

Creating a Request

data UpdateDatasetEntries

See: newUpdateDatasetEntries smart constructor.

Constructors

UpdateDatasetEntries'

Fields

• datasetArn :: Text

  The Amazon Resource Name (ARN) of the dataset that you want to update.

• changes :: DatasetChanges

  The changes that you want to make to the dataset.

Instances

ToJSON UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

toJSON :: UpdateDatasetEntries -> Value

toEncoding :: UpdateDatasetEntries -> Encoding

toJSONList :: [UpdateDatasetEntries] -> Value

toEncodingList :: [UpdateDatasetEntries] -> Encoding

ToHeaders UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

toHeaders :: UpdateDatasetEntries -> [Header]

ToPath UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

toPath :: UpdateDatasetEntries -> ByteString

ToQuery UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

toQuery :: UpdateDatasetEntries -> QueryString

AWSRequest UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Associated Types

type AWSResponse UpdateDatasetEntries

Methods

request :: (Service -> Service) -> UpdateDatasetEntries -> Request UpdateDatasetEntries

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDatasetEntries -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDatasetEntries)))

Generic UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Associated Types

type Rep UpdateDatasetEntries :: Type -> Type

Methods

from :: UpdateDatasetEntries -> Rep UpdateDatasetEntries x

to :: Rep UpdateDatasetEntries x -> UpdateDatasetEntries

Read UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

readsPrec :: Int -> ReadS UpdateDatasetEntries

readList :: ReadS [UpdateDatasetEntries]

readPrec :: ReadPrec UpdateDatasetEntries

readListPrec :: ReadPrec [UpdateDatasetEntries]

Show UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

showsPrec :: Int -> UpdateDatasetEntries -> ShowS

show :: UpdateDatasetEntries -> String

showList :: [UpdateDatasetEntries] -> ShowS

NFData UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

rnf :: UpdateDatasetEntries -> ()

Eq UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

(==) :: UpdateDatasetEntries -> UpdateDatasetEntries -> Bool

(/=) :: UpdateDatasetEntries -> UpdateDatasetEntries -> Bool

Hashable UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

hashWithSalt :: Int -> UpdateDatasetEntries -> Int

hash :: UpdateDatasetEntries -> Int

type AWSResponse UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

type AWSResponse UpdateDatasetEntries = UpdateDatasetEntriesResponse

type Rep UpdateDatasetEntries

Defined in Amazonka.Rekognition.UpdateDatasetEntries

type Rep UpdateDatasetEntries = D1 ('MetaData "UpdateDatasetEntries" "Amazonka.Rekognition.UpdateDatasetEntries" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "UpdateDatasetEntries'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DatasetChanges)))

newUpdateDatasetEntries

Arguments

:: Text

UpdateDatasetEntries

-> DatasetChanges

$sel:changes:UpdateDatasetEntries'

-> 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

The Amazon Resource Name (ARN) of the dataset that you want to update.

updateDatasetEntries_changes :: Lens' UpdateDatasetEntries DatasetChanges

The changes that you want to make to the dataset.

Destructuring the Response

data UpdateDatasetEntriesResponse

See: newUpdateDatasetEntriesResponse smart constructor.

Constructors

UpdateDatasetEntriesResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateDatasetEntriesResponse

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Associated Types

type Rep UpdateDatasetEntriesResponse :: Type -> Type

Methods

from :: UpdateDatasetEntriesResponse -> Rep UpdateDatasetEntriesResponse x

to :: Rep UpdateDatasetEntriesResponse x -> UpdateDatasetEntriesResponse

Read UpdateDatasetEntriesResponse

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

readsPrec :: Int -> ReadS UpdateDatasetEntriesResponse

readList :: ReadS [UpdateDatasetEntriesResponse]

readPrec :: ReadPrec UpdateDatasetEntriesResponse

readListPrec :: ReadPrec [UpdateDatasetEntriesResponse]

Show UpdateDatasetEntriesResponse

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

showsPrec :: Int -> UpdateDatasetEntriesResponse -> ShowS

show :: UpdateDatasetEntriesResponse -> String

showList :: [UpdateDatasetEntriesResponse] -> ShowS

NFData UpdateDatasetEntriesResponse

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

rnf :: UpdateDatasetEntriesResponse -> ()

Eq UpdateDatasetEntriesResponse

Defined in Amazonka.Rekognition.UpdateDatasetEntries

Methods

(==) :: UpdateDatasetEntriesResponse -> UpdateDatasetEntriesResponse -> Bool

(/=) :: UpdateDatasetEntriesResponse -> UpdateDatasetEntriesResponse -> Bool

type Rep UpdateDatasetEntriesResponse

Defined in Amazonka.Rekognition.UpdateDatasetEntries

type Rep UpdateDatasetEntriesResponse = D1 ('MetaData "UpdateDatasetEntriesResponse" "Amazonka.Rekognition.UpdateDatasetEntries" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "UpdateDatasetEntriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateDatasetEntriesResponse

Arguments

:: Int

$sel:httpStatus:UpdateDatasetEntriesResponse'

-> UpdateDatasetEntriesResponse

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

The response's http status code.