sdk.aoi_version.create()

elements.sdk.api.aoi_version

Create a new version of an existing AOI.

Create a new AOI Version that is tied to the original AOI by reference of the AOI ID. After specifying the AOI modifications, the original is copied and modified. Further, AOI Versions are immutable.

Parameters

  • aoi_id (str) : ID of the AOI for which to create a new version
  • aoi_modification_input (AOIInput) : key/value pairs of AOI metadata fields to be modified, with the new values

Returns

AOIVersion.id

Example(s)

# Create a new AOI Version with a modification to the existing AOI
await sdk.aoi_version.create(aoi_id="18d6207a-091f-4852-8ab3-f2dbbcca3fc5",
                             aoi_modification_input=AOIInput(name="South Beach Starbucks"))

# Outptut (AOIVersion.id)
[34979282]