sdk.aoi_version.get()

elements.sdk.api.aoi_version

Get a list of AOI Versions with specified metadata.

Get the AOI details specified by the provided versions. Additionally, choose which metadata fields should be returned. A list of AOI Collections that each AOI Version is a part of is also returned.

Parameters

  • aoi_version_ids (list) - AOI Versions to be returned
  • aoi_fields (List[AOIField]) - AOI metadata fields to be included in response

Returns

AOIVersion

Example(s)

# Get AOI Versions with select metadata fields
await sdk.aoi_version.get(
  aoi_version_ids=[41630968],
  aoi_fields=[AOIField.NAME, AOIField.GEOM_WKT]
)

# Output (AOIVersion)
[id: 41630968
aoi_id: "None"
aoi_name: "San Jose State University"
geom_wkt: "POLYGON ((-121.891336 37.345116, -121.882978 37.322622, -121.865618 37.335404, -121.891336 37.345116))"
attributes {
}
]