String consumerArn
The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS.
Format example: arn:partition:service:region:account-id:resource-type:resource-id
String trackerName
The name of the tracker resource to be associated with a geofence collection.
BatchItemError error
Contains details associated to the batch error.
String geofenceId
The geofence associated with the error message.
String deviceId
The device associated with the position evaluation error.
BatchItemError error
Contains details associated to the batch error.
Date sampleTime
Specifies a timestamp for when the error occurred in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String deviceId
The ID of the device that didn't return a position.
BatchItemError error
Contains details related to the error code.
BatchItemError error
Contains details associated to the batch error.
String geofenceId
The geofence associated with the error message.
String geofenceId
The identifier for the geofence to be stored in a given geofence collection.
GeofenceGeometry geometry
The geometry details for the geofence.
Date createTime
The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String geofenceId
The geofence successfully stored in a geofence collection.
Date updateTime
The timestamp for when the geofence was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String deviceId
The device associated with the failed location update.
BatchItemError error
Contains details related to the error code such as the error code and error message.
Date sampleTime
The timestamp for when a position sample was attempted in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String collectionName
A custom name for the geofence collection.
Requirements:
Contain only alphanumeric characters (A–Z, a–z, 0-9), hyphens (-), and underscores (_).
Must be a unique geofence collection name.
No spaces allowed. For example, ExampleGeofenceCollection.
String description
An optional description for the geofence collection.
String pricingPlan
Specifies the pricing plan for your geofence collection. There's three pricing plan options:
RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.
MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.
MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
String collectionArn
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
String collectionName
The name for the geofence collection.
Date createTime
The timestamp for when the geofence collection was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
MapConfiguration configuration
Specifies the map style selected from an available data provider.
String description
An optional description for the map resource.
String mapName
The name for the map resource.
Requirements:
Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), and underscores (_).
Must be a unique map resource name.
No spaces allowed. For example, ExampleMap.
String pricingPlan
Specifies the pricing plan for your map resource. There's three pricing plan options:
RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.
MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.
MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
Date createTime
The timestamp for when the map resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String mapArn
The Amazon Resource Name (ARN) for the map resource. Used when you need to specify a resource across all AWS.
Format example: arn:partition:service:region:account-id:resource-type:resource-id
String mapName
The name of the map resource.
String dataSource
Specifies the data provider of geospatial data.
DataSourceConfiguration dataSourceConfiguration
Specifies the data storage option for requesting Places.
String description
The optional description for the Place index resource.
String indexName
The name of the Place index resource.
Requirements:
Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-) and underscores (_) ).
Must be a unique Place index resource name.
No spaces allowed. For example, ExamplePlaceIndex.
String pricingPlan
Specifies the pricing plan for your Place index resource. There's three pricing plan options:
RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.
MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.
MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
Date createTime
The timestamp for when the Place index resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String indexArn
The Amazon Resource Name (ARN) for the Place index resource. Used when you need to specify a resource across all AWS.
String indexName
The name for the Place index resource.
String description
An optional description for the tracker resource.
String pricingPlan
Specifies the pricing plan for your tracker resource. There's three pricing plan options:
RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.
MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.
MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
String trackerName
The name for the tracker resource.
Requirements:
Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-) and underscores (_).
Must be a unique tracker resource name.
No spaces allowed. For example, ExampleTracker.
Date createTime
The timestamp for when the tracker resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String trackerArn
The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.
String trackerName
The name of the tracker resource.
String intendedUse
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
String collectionName
The name of the geofence collection to be deleted.
String mapName
The name of the map resource to be deleted.
String indexName
The name of the Place index resource to be deleted.
String trackerName
The name of the tracker resource to be deleted.
String collectionName
The name of the geofence collection.
String collectionArn
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.
String collectionName
The name of the geofence collection.
Date createTime
The timestamp for when the geofence resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String description
The optional description for the geofence collection.
Date updateTime
The timestamp for when the geofence collection was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String mapName
The name of the map resource.
MapConfiguration configuration
Specifies the map tile style selected from a partner data provider.
Date createTime
The timestamp for when the map resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String dataSource
Specifies the data provider for the associated map tiles.
String description
The optional description for the map resource.
String mapArn
The Amazon Resource Name (ARN) for the map resource. Used when you need to specify a resource across all AWS.
String mapName
The map style selected from an available provider.
Date updateTime
The timestamp for when the map resource was last update in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String indexName
The name of the Place index resource.
Date createTime
The timestamp for when the Place index resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String dataSource
The data provider of geospatial data.
DataSourceConfiguration dataSourceConfiguration
The specified data storage option for requesting Places.
String description
The optional description for the Place index resource.
String indexArn
The Amazon Resource Name (ARN) for the Place index resource. Used when you need to specify a resource across all AWS.
String indexName
The name of the Place index resource being described.
Date updateTime
The timestamp for when the Place index resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String trackerName
The name of the tracker resource.
Date createTime
The timestamp for when the tracker resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String description
The optional description for the tracker resource.
String trackerArn
The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.
String trackerName
The name of the tracker resource.
Date updateTime
The timestamp for when the tracker resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String deviceId
The device whose position you retrieved.
List<E> position
The last known device position.
Date receivedTime
The timestamp for when the tracker resource recieved the position in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Date sampleTime
The timestamp for when the position was detected and sampled in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String deviceId
The device associated to the position update.
List<E> position
The latest device position defined in WGS 84
format: [Xlongitude, Ylatitude].
Date sampleTime
The timestamp for when the position update was received in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String consumerArn
The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all AWS.
Format example: arn:partition:service:region:account-id:resource-type:resource-id
String trackerName
The name of the tracker resource to be dissociated from the consumer.
List<E> polygon
An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last
vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form:
[longitude, latitude].
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
String deviceId
The device whose position history you want to retrieve.
Date endTimeExclusive
Specify the end time for the position history in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
The given time for EndTimeExclusive must be after the time for StartTimeInclusive.
String nextToken
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
Date startTimeInclusive
Specify the start time for the position history in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
The given time for EndTimeExclusive must be after the time for StartTimeInclusive.
String trackerName
The tracker resource receiving the request for the device position history.
String deviceId
The device whose position you retrieved.
List<E> position
The last known device position.
Date receivedTime
The timestamp for when the tracker resource recieved the position in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Date sampleTime
The timestamp for when the position was detected and sampled in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Date createTime
The timestamp for when the geofence collection was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String geofenceId
The geofence identifier.
GeofenceGeometry geometry
Contains the geofence geometry details describing a polygon.
String status
Identifies the state of the geofence. A geofence will hold one of the following states:
ACTIVE — The geofence has been indexed by the system.
PENDING — The geofence is being processed by the system.
FAILED — The geofence failed to be indexed by the system.
DELETED — The geofence has been deleted from the system index.
DELETING — The geofence is being deleted from the system index.
Date updateTime
The timestamp for when the geofence collection was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String fontStack
A comma-separated list of fonts to load glyphs from in order of preference.. For example,
Noto Sans, Arial Unicode.
String fontUnicodeRange
A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example,
0-255 includes all characters from range U+0000 to 00FF. Must be aligned to multiples
of 256.
String mapName
The map resource associated with the glyph file.
ByteBuffer blob
The blob's content type.
String contentType
The map glyph content type. For example, application/octet-stream.
String fileName
The name of the sprite file. Use the following file names for the sprite sheet:
sprites.png
sprites@2x.png for high pixel density displays
For the JSON document contain image offsets. Use the following file names:
sprites.json
sprites@2x.json for high pixel density displays
String mapName
The map resource associated with the sprite file.
ByteBuffer blob
Contains the body of the sprite sheet or JSON offset file.
String contentType
The content type of the sprite sheet and offsets. For example, the sprite sheet content type is
image/png, and the sprite offset JSON document is application/json.
String mapName
The map resource to retrieve the style descriptor from.
ByteBuffer blob
Contains the body of the style descriptor.
String contentType
The style descriptor's content type. For example, application/json.
ByteBuffer blob
Contains Mapbox Vector Tile (MVT) data.
String contentType
The map tile's content type. For example, application/vnd.mapbox-vector-tile.
Integer maxResults
An optional limit for the number of resources returned in a single call.
Default value: 100
String nextToken
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
String collectionName
The name of the geofence collection.
Date createTime
The timestamp for when the geofence collection was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String description
The description for the geofence collection
Date updateTime
Specifies a timestamp for when the resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
Date createTime
The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String geofenceId
The geofence identifier.
GeofenceGeometry geometry
Contains the geofence geometry details describing a polygon.
String status
Identifies the state of the geofence. A geofence will hold one of the following states:
ACTIVE — The geofence has been indexed by the system.
PENDING — The geofence is being processed by the system.
FAILED — The geofence failed to be indexed by the system.
DELETED — The geofence has been deleted from the system index.
DELETING — The geofence is being deleted from the system index.
Date updateTime
The timestamp for when the geofence was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
Integer maxResults
An optional limit for the number of resources returned in a single call.
Default value: 100
String nextToken
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
Date createTime
The timestamp for when the map resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String dataSource
Specifies the data provider for the associated map tiles.
String description
The description for the map resource.
String mapName
The name of the associated map resource.
Date updateTime
The timestamp for when the map resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Integer maxResults
An optional limit for the maximum number of results returned in a single call.
Default value: 100
String nextToken
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
Date createTime
The timestamp for when the Place index resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String dataSource
The data provider of geospatial data.
String description
The optional description for the Place index resource.
String indexName
The name of the Place index resource.
Date updateTime
The timestamp for when the Place index resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Integer maxResults
An optional limit for the number of resources returned in a single call.
Default value: 100
String nextToken
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
String trackerName
The tracker resource whose associated geofence collections you want to list.
Integer maxResults
An optional limit for the number of resources returned in a single call.
Default value: 100
String nextToken
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
Date createTime
The timestamp for when the tracker resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String description
The description for the tracker resource.
String trackerName
The name of the tracker resource.
Date updateTime
The timestamp for when the position was detected and sampled in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
List<E> entries
Contains tracker resources in your AWS account. Details include tracker name, description and timestamps for when the tracker was created and last updated.
String nextToken
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.
String style
Specifies the map style selected from an available data provider.
Valid styles: VectorEsriStreets, VectorEsriTopographic,
VectorEsriNavigation, VectorEsriDarkGrayCanvas, VectorEsriLightGrayCanvas,
VectorHereBerlin.
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.
String addressNumber
The numerical portion of an address, such as a building number.
String country
A country/region specified using ISO 3166 3-digit
country/region code. For example, CAN.
PlaceGeometry geometry
String label
The full name and address of the point of interest such as a city, region, or country. For example,
123 Any Street, Any Town, USA.
String municipality
A name for a local area, such as a city or town name. For example, Toronto.
String neighborhood
The name of a community district. For example, Downtown.
String postalCode
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
String region
A name for an area or geographical division, such as a province or state name. For example,
British Columbia.
String street
The name for a street or a road to identify a location. For example, Main Street.
String subRegion
A country, or an area that's part of a larger region . For example, Metro Vancouver.
String collectionName
The geofence collection to store the geofence in.
String geofenceId
An identifier for the geofence. For example, ExampleGeofence-1.
GeofenceGeometry geometry
Contains the polygon details to specify the position of the geofence.
Date createTime
The timestamp for when the geofence was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String geofenceId
The geofence identifier entered in the request.
Date updateTime
The timestamp for when the geofence was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
Place place
Contains details about the relevant point of interest.
Place place
Contains details about the relevant point of interest.
String indexName
The name of the Place index resource you want to use for the search.
Integer maxResults
An optional paramer. The maximum number of results returned per request.
Default value: 50
List<E> position
Specifies a coordinate for the query defined by a longitude, and latitude.
The first position is the X coordinate, or longitude.
The second position is the Y coordinate, or latitude.
For example, position=xLongitude&position=yLatitude .
List<E> results
Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.
SearchPlaceIndexForPositionSummary summary
Contains a summary of the request.
List<E> biasPosition
Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.
The first bias position is the X coordinate, or longitude.
The second bias position is the Y coordinate, or latitude.
For example, bias=xLongitude&bias=yLatitude.
List<E> filterBBox
Filters the results by returning only Places within the provided bounding box. An optional parameter.
The first 2 bbox parameters describe the lower southwest corner:
The first bbox position is the X coordinate or longitude of the lower southwest corner.
The second bbox position is the Y coordinate or latitude of the lower southwest corner.
For example, bbox=xLongitudeSW&bbox=yLatitudeSW.
The next bbox parameters describe the upper northeast corner:
The third bbox position is the X coordinate, or longitude of the upper northeast corner.
The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.
For example, bbox=xLongitudeNE&bbox=yLatitudeNE
List<E> filterCountries
Limits the search to the given a list of countries/regions. An optional parameter.
Use the ISO 3166 3-digit country code. For example,
Australia uses three upper-case characters: AUS.
String indexName
The name of the Place index resource you want to use for the search.
Integer maxResults
An optional parameter. The maximum number of results returned per request.
The default: 50
String text
The address, name, city, or region to be used in the search. In free-form text format. For example,
123 Any Street.
List<E> results
A list of Places closest to the specified position. Each result contains additional information about the specific point of interest.
SearchPlaceIndexForTextSummary summary
Contains a summary of the request. Contains the BiasPosition, DataSource,
FilterBBox, FilterCountries, MaxResults, ResultBBox, and
Text.
List<E> biasPosition
Contains the coordinates for the bias position entered in the geocoding request.
String dataSource
The data provider of geospatial data for the Place index resource.
List<E> filterBBox
Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
List<E> filterCountries
Contains the country filter entered in the geocoding request.
Integer maxResults
Contains the maximum number of results indicated for the request.
List<E> resultBBox
A bounding box that contains the search results within the specified area indicated by FilterBBox. A
subset of bounding box specified using FilterBBox.
String text
The address, name, city or region to be used in the geocoding request. In free-form text format. For example,
Vancouver.
Copyright © 2021. All rights reserved.