sdk.aoi_collection.remove()

elements.sdk.api.aoi_collection

Remove AOIs from an AOI Collection.

Remove a list of AOI Versions from an AOI Collection by passing their Version IDs.

📘

AOI Collection Modifications

Note that AOI Collections can only be edited before they are submitted for a computation. After they are submitted for a computation, they become immutable.

Parameters

  • aoi_collection_id (str) - ID of the AOI Collection to remove the AOIs from
  • aoi_version_ids (list) - Version IDs of the AOIs to remove from the AOI Collection

Returns

None

Example(s)

# Remove an AOI Version from an AOI Collection
await sdk.aoi_collection.remove(aoi_collection_id="43af4120-959c-47be-a34c-9c7bf5ab37af", aoi_version_ids=[34979282])