2021/03/29 - Amazon Location Service - 10 updated api methods
Changes Amazon Location added support for specifying pricing plan information on resources in alignment with our cost model.
{'PricingPlanDataSource': 'string'}
Creates a geofence collection, which manages and stores geofences.
See also: AWS API Documentation
Request Syntax
client.create_geofence_collection(
CollectionName='string',
Description='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
PricingPlanDataSource='string'
)
string
[REQUIRED]
A custom name for the geofence collection.
Requirements:
Contain only alphanumeric characters (A–Z, a–z, 0-9), hyphens (-), periods (.), and underscores (_).
Must be a unique geofence collection name.
No spaces allowed. For example, ExampleGeofenceCollection .
string
An optional description for the geofence collection.
string
[REQUIRED]
Specifies the pricing plan for your geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
string
Specifies the plan data source. Required if the Mobile Asset Tracking (MAT) or the Mobile Asset Management (MAM) pricing plan is selected.
Billing is determined by the resource usage, the associated pricing plan, and the data source that was specified. For more information about each pricing plan option and restrictions, see the Amazon Location Service pricing page .
Valid Values: Esri | Here
dict
Response Syntax
{
'CollectionArn': 'string',
'CollectionName': 'string',
'CreateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CollectionArn (string) --
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
CollectionName (string) --
The name for the geofence collection.
CreateTime (datetime) --
The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
{'PricingPlanDataSource': 'string'}
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
See also: AWS API Documentation
Request Syntax
client.create_tracker(
Description='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
PricingPlanDataSource='string',
TrackerName='string'
)
string
An optional description for the tracker resource.
string
[REQUIRED]
Specifies the pricing plan for your tracker resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
string
Specifies the plan data source. Required if the Mobile Asset Tracking (MAT) or the Mobile Asset Management (MAM) pricing plan is selected.
Billing is determined by the resource usage, the associated pricing plan, and data source that was specified. For more information about each pricing plan option and restrictions, see the Amazon Location Service pricing page .
Valid Values: Esri | Here
string
[REQUIRED]
The name for the tracker resource.
Requirements:
Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
Must be a unique tracker resource name.
No spaces allowed. For example, ExampleTracker .
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'TrackerArn': 'string',
'TrackerName': 'string'
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
TrackerArn (string) --
The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.
TrackerName (string) --
The name of the tracker resource.
{'PricingPlan': 'RequestBasedUsage | MobileAssetTracking | '
'MobileAssetManagement',
'PricingPlanDataSource': 'string'}
Retrieves the geofence collection details.
See also: AWS API Documentation
Request Syntax
client.describe_geofence_collection(
CollectionName='string'
)
string
[REQUIRED]
The name of the geofence collection.
dict
Response Syntax
{
'CollectionArn': 'string',
'CollectionName': 'string',
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'PricingPlanDataSource': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CollectionArn (string) --
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
CollectionName (string) --
The name of the geofence collection.
CreateTime (datetime) --
The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Description (string) --
The optional description for the geofence collection.
PricingPlan (string) --
The pricing plan selected for the specified geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
PricingPlanDataSource (string) --
The data source selected for the geofence collection and associated pricing plan.
UpdateTime (datetime) --
The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
{'PricingPlan': 'RequestBasedUsage | MobileAssetTracking | '
'MobileAssetManagement'}
Retrieves the map resource details.
See also: AWS API Documentation
Request Syntax
client.describe_map(
MapName='string'
)
string
[REQUIRED]
The name of the map resource.
dict
Response Syntax
{
'Configuration': {
'Style': 'string'
},
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'Description': 'string',
'MapArn': 'string',
'MapName': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Configuration (dict) --
Specifies the map tile style selected from a partner data provider.
Style (string) --
Specifies the map style selected from an available data provider.
Valid styles: VectorEsriStreets , VectorEsriTopographic , VectorEsriNavigation , VectorEsriDarkGrayCanvas , VectorEsriLightGrayCanvas , VectorHereBerlin .
Note
When using HERE as your data provider, and selecting the Style VectorHereBerlin , you may not use HERE Maps for Asset Management. See the AWS Service Terms for Amazon Location Service.
CreateTime (datetime) --
The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
DataSource (string) --
Specifies the data provider for the associated map tiles.
Description (string) --
The optional description for the map resource.
MapArn (string) --
The Amazon Resource Name (ARN) for the map resource. Used when you need to specify a resource across all AWS.
MapName (string) --
The map style selected from an available provider.
PricingPlan (string) --
The pricing plan selected for the specified map resource.
<p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing page</a>.</p>
UpdateTime (datetime) --
The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
{'PricingPlan': 'RequestBasedUsage | MobileAssetTracking | '
'MobileAssetManagement'}
Retrieves the Place index resource details.
See also: AWS API Documentation
Request Syntax
client.describe_place_index(
IndexName='string'
)
string
[REQUIRED]
The name of the Place index resource.
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'DataSourceConfiguration': {
'IntendedUse': 'SingleUse'|'Storage'
},
'Description': 'string',
'IndexArn': 'string',
'IndexName': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the Place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
DataSource (string) --
The data provider of geospatial data. Indicates one of the available providers:
Esri
Here
For additional details on data providers, see the Amazon Location Service data providers page .
DataSourceConfiguration (dict) --
The specified data storage option for requesting Places.
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
Description (string) --
The optional description for the Place index resource.
IndexArn (string) --
The Amazon Resource Name (ARN) for the Place index resource. Used when you need to specify a resource across all AWS.
IndexName (string) --
The name of the Place index resource being described.
PricingPlan (string) --
The pricing plan selected for the specified Place index resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
UpdateTime (datetime) --
The timestamp for when the Place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
{'PricingPlan': 'RequestBasedUsage | MobileAssetTracking | '
'MobileAssetManagement',
'PricingPlanDataSource': 'string'}
Retrieves the tracker resource details.
See also: AWS API Documentation
Request Syntax
client.describe_tracker(
TrackerName='string'
)
string
[REQUIRED]
The name of the tracker resource.
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'PricingPlanDataSource': 'string',
'TrackerArn': 'string',
'TrackerName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Description (string) --
The optional description for the tracker resource.
PricingPlan (string) --
The pricing plan selected for the specified tracker resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
PricingPlanDataSource (string) --
The data source selected for the tracker resource and associated pricing plan.
TrackerArn (string) --
The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.
TrackerName (string) --
The name of the tracker resource.
UpdateTime (datetime) --
The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
{'Entries': {'PricingPlan': 'RequestBasedUsage | MobileAssetTracking | '
'MobileAssetManagement',
'PricingPlanDataSource': 'string'}}
Lists geofence collections in your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_geofence_collections(
MaxResults=123,
NextToken='string'
)
integer
An optional limit for the number of resources returned in a single call.
Default value: 100
string
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
dict
Response Syntax
{
'Entries': [
{
'CollectionName': 'string',
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'PricingPlanDataSource': 'string',
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Lists the geofence collections that exist in your AWS account.
(dict) --
Contains the geofence collection details.
CollectionName (string) --
The name of the geofence collection.
CreateTime (datetime) --
The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Description (string) --
The description for the geofence collection
PricingPlan (string) --
The pricing plan for the specified geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
PricingPlanDataSource (string) --
The data source selected for the geofence collection and associated pricing plan.
UpdateTime (datetime) --
Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
NextToken (string) --
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
{'Entries': {'PricingPlan': 'RequestBasedUsage | MobileAssetTracking | '
'MobileAssetManagement'}}
Lists map resources in your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_maps(
MaxResults=123,
NextToken='string'
)
integer
An optional limit for the number of resources returned in a single call.
Default value: 100
string
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
dict
Response Syntax
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'Description': 'string',
'MapName': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Contains a list of maps in your AWS account
(dict) --
Contains details of an existing map resource in your AWS account.
CreateTime (datetime) --
The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
DataSource (string) --
Specifies the data provider for the associated map tiles.
Description (string) --
The description for the map resource.
MapName (string) --
The name of the associated map resource.
PricingPlan (string) --
The pricing plan for the specified map resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
UpdateTime (datetime) --
The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
NextToken (string) --
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
{'Entries': {'PricingPlan': 'RequestBasedUsage | MobileAssetTracking | '
'MobileAssetManagement'}}
Lists Place index resources in your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_place_indexes(
MaxResults=123,
NextToken='string'
)
integer
An optional limit for the maximum number of results returned in a single call.
Default value: 100
string
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
dict
Response Syntax
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'Description': 'string',
'IndexName': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Lists the Place index resources that exist in your AWS account
(dict) --
A Place index resource listed in your AWS account.
CreateTime (datetime) --
The timestamp for when the Place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
DataSource (string) --
The data provider of geospatial data. Indicates one of the available providers:
Esri
HERE
For additional details on data providers, see the Amazon Location Service data providers page .
Description (string) --
The optional description for the Place index resource.
IndexName (string) --
The name of the Place index resource.
PricingPlan (string) --
The pricing plan for the specified Place index resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
UpdateTime (datetime) --
The timestamp for when the Place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
NextToken (string) --
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
{'Entries': {'PricingPlan': 'RequestBasedUsage | MobileAssetTracking | '
'MobileAssetManagement',
'PricingPlanDataSource': 'string'}}
Lists tracker resources in your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_trackers(
MaxResults=123,
NextToken='string'
)
integer
An optional limit for the number of resources returned in a single call.
Default value: 100
string
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
dict
Response Syntax
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'PricingPlanDataSource': 'string',
'TrackerName': 'string',
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Contains tracker resources in your AWS account. Details include tracker name, description and timestamps for when the tracker was created and last updated.
(dict) --
Contains the tracker resource details.
CreateTime (datetime) --
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Description (string) --
The description for the tracker resource.
PricingPlan (string) --
The pricing plan for the specified tracker resource.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
PricingPlanDataSource (string) --
The data source selected for the tracker resource and associated pricing plan.
TrackerName (string) --
The name of the tracker resource.
UpdateTime (datetime) --
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
NextToken (string) --
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.