Amazon Location Service

2021/07/19 - Amazon Location Service - 5 new api methods

Changes  Add five new API operations: UpdateGeofenceCollection, UpdateMap, UpdatePlaceIndex, UpdateRouteCalculator, UpdateTracker.

UpdateMap (new) Link ¶

Updates the specified properties of a given map resource.

See also: AWS API Documentation

Request Syntax

client.update_map(
    Description='string',
    MapName='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
type Description:

string

param Description:

Updates the description for the map resource.

type MapName:

string

param MapName:

[REQUIRED]

The name of the map resource to update.

type PricingPlan:

string

param PricingPlan:

Updates the pricing plan for the map resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

rtype:

dict

returns:

Response Syntax

{
    'MapArn': 'string',
    'MapName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • MapArn (string) --

      The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:maps/ExampleMap

    • MapName (string) --

      The name of the updated map resource.

    • UpdateTime (datetime) --

      The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

UpdatePlaceIndex (new) Link ¶

Updates the specified properties of a given place index resource.

See also: AWS API Documentation

Request Syntax

client.update_place_index(
    DataSourceConfiguration={
        'IntendedUse': 'SingleUse'|'Storage'
    },
    Description='string',
    IndexName='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
type DataSourceConfiguration:

dict

param DataSourceConfiguration:

Updates the data storage option for the place index resource.

  • IntendedUse (string) --

    Specifies how the results of an operation will be stored by the caller.

    Valid values include:

    • SingleUse specifies that the results won't be stored.

    • Storage specifies that the result can be cached or stored in a database.

    Default value: SingleUse

type Description:

string

param Description:

Updates the description for the place index resource.

type IndexName:

string

param IndexName:

[REQUIRED]

The name of the place index resource to update.

type PricingPlan:

string

param PricingPlan:

Updates the pricing plan for the place index resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

rtype:

dict

returns:

Response Syntax

{
    'IndexArn': 'string',
    'IndexName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • IndexArn (string) --

      The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex

    • IndexName (string) --

      The name of the updated place index resource.

    • UpdateTime (datetime) --

      The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

UpdateGeofenceCollection (new) Link ¶

Updates the specified properties of a given geofence collection.

See also: AWS API Documentation

Request Syntax

client.update_geofence_collection(
    CollectionName='string',
    Description='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    PricingPlanDataSource='string'
)
type CollectionName:

string

param CollectionName:

[REQUIRED]

The name of the geofence collection to update.

type Description:

string

param Description:

Updates the description for the geofence collection.

type PricingPlan:

string

param PricingPlan:

Updates the pricing plan for the geofence collection.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

type PricingPlanDataSource:

string

param PricingPlanDataSource:

Updates the data provider for the geofence collection.

A required value for the following pricing plans: MobileAssetTracking``| ``MobileAssetManagement

For more information about data providers and pricing plans, see the Amazon Location Service product page.

rtype:

dict

returns:

Response Syntax

{
    'CollectionArn': 'string',
    'CollectionName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • CollectionArn (string) --

      The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

    • CollectionName (string) --

      The name of the updated geofence collection.

    • UpdateTime (datetime) --

      The time when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

UpdateTracker (new) Link ¶

Updates the specified properties of a given tracker resource.

See also: AWS API Documentation

Request Syntax

client.update_tracker(
    Description='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    PricingPlanDataSource='string',
    TrackerName='string'
)
type Description:

string

param Description:

Updates the description for the tracker resource.

type PricingPlan:

string

param PricingPlan:

Updates the pricing plan for the tracker resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

type PricingPlanDataSource:

string

param PricingPlanDataSource:

Updates the data provider for the tracker resource.

A required value for the following pricing plans: MobileAssetTracking``| ``MobileAssetManagement

For more information about data providers and pricing plans, see the Amazon Location Service product page

type TrackerName:

string

param TrackerName:

[REQUIRED]

The name of the tracker resource to update.

rtype:

dict

returns:

Response Syntax

{
    'TrackerArn': 'string',
    'TrackerName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • TrackerArn (string) --

      The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

    • TrackerName (string) --

      The name of the updated tracker resource.

    • UpdateTime (datetime) --

      The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

UpdateRouteCalculator (new) Link ¶

Updates the specified properties for a given route calculator resource.

See also: AWS API Documentation

Request Syntax

client.update_route_calculator(
    CalculatorName='string',
    Description='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
type CalculatorName:

string

param CalculatorName:

[REQUIRED]

The name of the route calculator resource to update.

type Description:

string

param Description:

Updates the description for the route calculator resource.

type PricingPlan:

string

param PricingPlan:

Updates the pricing plan for the route calculator resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

rtype:

dict

returns:

Response Syntax

{
    'CalculatorArn': 'string',
    'CalculatorName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • CalculatorArn (string) --

      The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS.

      • Format example: arn:aws:geo:region:account-id:route- calculator/ExampleCalculator

    • CalculatorName (string) --

      The name of the updated route calculator resource.

    • UpdateTime (datetime) --

      The timestamp for when the route calculator was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.