geoanalytics

auth

geoanalytics.auth(**kwargs)

Used to authorize GeoAnalytics Engine.

Example: geoanalytics.auth(usename=”User1”, password=”pas$$word”)

Parameters
  • username (str) – GeoAnalytics Engine account username.

  • password (str) – GeoAnalytics Engine account password.

  • token (str) – GeoAnalytics Engine token used in place of a username and password. A token can be generated using the REST generateToken POST method or with ArcPy.

  • license_file (str) – Path to the GeoAnalytics Engine license file.

auth_info

geoanalytics.auth_info()

Returns the GeoAnalytics Engine authorization information for the authorized user.

Example: geoanalytics.auth_info()

Returns

DataFrame containing the authorization information.

Return type

pyspark.sql.dataframe.DataFrame

deauth

geoanalytics.deauth()

Used to deauthorize GeoAnalytics Engine.

Example: geoanalytics.deauth()

usage

geoanalytics.usage(**kwargs)

Returns GeoAnalytics Engine usage information for the authorized user.

Valid time units for the span and period input parameters:

  • h, hour, hours

  • d, day, days

  • w, week, weeks

  • m, month, months

  • y, year, years

Example: geoanalytics.usage(span=”1m”, period=”2days”)

Parameters
  • span (str, optional) – The time range covered by the returned usage DataFrame.

  • period (str, optional) – The aggregation interval for each row in the returned usage DataFrame.

Returns

DataFrame containing the usage information.

Return type

pyspark.sql.dataframe.DataFrame

version

geoanalytics.version()

Returns the GeoAnalytics Engine version.

Returns

GeoAnalytics Engine version.

Return type

str

enable_warnings

geoanalytics.enable_warnings()

Enables GeoAnalytics Engine warnings.