{ "version":"2.0", "metadata":{ "apiVersion":"2020-11-19", "auth":["aws.auth#sigv4"], "endpointPrefix":"geo", "protocol":"rest-json", "protocols":["rest-json"], "serviceFullName":"Amazon Location Service", "serviceId":"Location", "signatureVersion":"v4", "signingName":"geo", "uid":"location-2020-11-19" }, "operations":{ "AssociateTrackerConsumer":{ "name":"AssociateTrackerConsumer", "http":{ "method":"POST", "requestUri":"/tracking/v0/trackers/{TrackerName}/consumers", "responseCode":200 }, "input":{"shape":"AssociateTrackerConsumerRequest"}, "output":{"shape":"AssociateTrackerConsumerResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.

You can associate up to five geofence collections to each tracker resource.

Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.

", "endpoint":{"hostPrefix":"cp.tracking."} }, "BatchDeleteDevicePositionHistory":{ "name":"BatchDeleteDevicePositionHistory", "http":{ "method":"POST", "requestUri":"/tracking/v0/trackers/{TrackerName}/delete-positions", "responseCode":200 }, "input":{"shape":"BatchDeleteDevicePositionHistoryRequest"}, "output":{"shape":"BatchDeleteDevicePositionHistoryResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes the position history of one or more devices from a tracker resource.

", "endpoint":{"hostPrefix":"tracking."} }, "BatchDeleteGeofence":{ "name":"BatchDeleteGeofence", "http":{ "method":"POST", "requestUri":"/geofencing/v0/collections/{CollectionName}/delete-geofences", "responseCode":200 }, "input":{"shape":"BatchDeleteGeofenceRequest"}, "output":{"shape":"BatchDeleteGeofenceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes a batch of geofences from a geofence collection.

This operation deletes the resource permanently.

", "endpoint":{"hostPrefix":"geofencing."} }, "BatchEvaluateGeofences":{ "name":"BatchEvaluateGeofences", "http":{ "method":"POST", "requestUri":"/geofencing/v0/collections/{CollectionName}/positions", "responseCode":200 }, "input":{"shape":"BatchEvaluateGeofencesRequest"}, "output":{"shape":"BatchEvaluateGeofencesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Evaluates device positions against the geofence geometries from a given geofence collection.

This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:

The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.

Geofence evaluation uses the given device position. It does not account for the optional Accuracy of a DevicePositionUpdate.

The DeviceID is used as a string to represent the device. You do not need to have a Tracker associated with the DeviceID.

", "endpoint":{"hostPrefix":"geofencing."} }, "BatchGetDevicePosition":{ "name":"BatchGetDevicePosition", "http":{ "method":"POST", "requestUri":"/tracking/v0/trackers/{TrackerName}/get-positions", "responseCode":200 }, "input":{"shape":"BatchGetDevicePositionRequest"}, "output":{"shape":"BatchGetDevicePositionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists the latest device positions for requested devices.

", "endpoint":{"hostPrefix":"tracking."}, "readonly":true }, "BatchPutGeofence":{ "name":"BatchPutGeofence", "http":{ "method":"POST", "requestUri":"/geofencing/v0/collections/{CollectionName}/put-geofences", "responseCode":200 }, "input":{"shape":"BatchPutGeofenceRequest"}, "output":{"shape":"BatchPutGeofenceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

", "endpoint":{"hostPrefix":"geofencing."} }, "BatchUpdateDevicePosition":{ "name":"BatchUpdateDevicePosition", "http":{ "method":"POST", "requestUri":"/tracking/v0/trackers/{TrackerName}/positions", "responseCode":200 }, "input":{"shape":"BatchUpdateDevicePositionRequest"}, "output":{"shape":"BatchUpdateDevicePositionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch). Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.

Position updates are handled based on the PositionFiltering property of the tracker. When PositionFiltering is set to TimeBased, updates are evaluated against linked geofence collections, and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device ID.

When PositionFiltering is set to DistanceBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).

When PositionFiltering is set to AccuracyBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set to AccuracyBased filtering, Amazon Location uses the default value { \"Horizontal\": 0} when accuracy is not provided on a DevicePositionUpdate.

", "endpoint":{"hostPrefix":"tracking."} }, "CalculateRoute":{ "name":"CalculateRoute", "http":{ "method":"POST", "requestUri":"/routes/v0/calculators/{CalculatorName}/calculate/route", "responseCode":200 }, "input":{"shape":"CalculateRouteRequest"}, "output":{"shape":"CalculateRouteResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to CalculateRoutes or CalculateIsolines unless you require Grab data.

Calculates a route given the following required parameters: DeparturePosition and DestinationPosition. Requires that you first create a route calculator resource.

By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.

Additional options include:

", "endpoint":{"hostPrefix":"routes."}, "readonly":true }, "CalculateRouteMatrix":{ "name":"CalculateRouteMatrix", "http":{ "method":"POST", "requestUri":"/routes/v0/calculators/{CalculatorName}/calculate/route-matrix", "responseCode":200 }, "input":{"shape":"CalculateRouteMatrixRequest"}, "output":{"shape":"CalculateRouteMatrixResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the V2 CalculateRouteMatrix unless you require Grab data.

Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions. CalculateRouteMatrix calculates routes and returns the travel time and travel distance from each departure position to each destination position in the request. For example, given departure positions A and B, and destination positions X and Y, CalculateRouteMatrix will return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned (and routes calculated) will be the number of DeparturePositions times the number of DestinationPositions.

Your account is charged for each route calculated, not the number of requests.

Requires that you first create a route calculator resource.

By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes.

Additional options include:

", "endpoint":{"hostPrefix":"routes."}, "readonly":true }, "CreateGeofenceCollection":{ "name":"CreateGeofenceCollection", "http":{ "method":"POST", "requestUri":"/geofencing/v0/collections", "responseCode":200 }, "input":{"shape":"CreateGeofenceCollectionRequest"}, "output":{"shape":"CreateGeofenceCollectionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

Creates a geofence collection, which manages and stores geofences.

", "endpoint":{"hostPrefix":"cp.geofencing."}, "idempotent":true }, "CreateKey":{ "name":"CreateKey", "http":{ "method":"POST", "requestUri":"/metadata/v0/keys", "responseCode":200 }, "input":{"shape":"CreateKeyRequest"}, "output":{"shape":"CreateKeyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.

For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.

", "endpoint":{"hostPrefix":"cp.metadata."}, "idempotent":true }, "CreateMap":{ "name":"CreateMap", "http":{ "method":"POST", "requestUri":"/maps/v0/maps", "responseCode":200 }, "input":{"shape":"CreateMapRequest"}, "output":{"shape":"CreateMapResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers.

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.

", "endpoint":{"hostPrefix":"cp.maps."}, "idempotent":true }, "CreatePlaceIndex":{ "name":"CreatePlaceIndex", "http":{ "method":"POST", "requestUri":"/places/v0/indexes", "responseCode":200 }, "input":{"shape":"CreatePlaceIndexRequest"}, "output":{"shape":"CreatePlaceIndexResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.

", "endpoint":{"hostPrefix":"cp.places."}, "idempotent":true }, "CreateRouteCalculator":{ "name":"CreateRouteCalculator", "http":{ "method":"POST", "requestUri":"/routes/v0/calculators", "responseCode":200 }, "input":{"shape":"CreateRouteCalculatorRequest"}, "output":{"shape":"CreateRouteCalculatorResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

Creates a route calculator resource in your Amazon Web Services account.

You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.

", "endpoint":{"hostPrefix":"cp.routes."}, "idempotent":true }, "CreateTracker":{ "name":"CreateTracker", "http":{ "method":"POST", "requestUri":"/tracking/v0/trackers", "responseCode":200 }, "input":{"shape":"CreateTrackerRequest"}, "output":{"shape":"CreateTrackerResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], "documentation":"

Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.

", "endpoint":{"hostPrefix":"cp.tracking."}, "idempotent":true }, "DeleteGeofenceCollection":{ "name":"DeleteGeofenceCollection", "http":{ "method":"DELETE", "requestUri":"/geofencing/v0/collections/{CollectionName}", "responseCode":200 }, "input":{"shape":"DeleteGeofenceCollectionRequest"}, "output":{"shape":"DeleteGeofenceCollectionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes a geofence collection from your Amazon Web Services account.

This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.

", "endpoint":{"hostPrefix":"cp.geofencing."}, "idempotent":true }, "DeleteKey":{ "name":"DeleteKey", "http":{ "method":"DELETE", "requestUri":"/metadata/v0/keys/{KeyName}", "responseCode":200 }, "input":{"shape":"DeleteKeyRequest"}, "output":{"shape":"DeleteKeyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes the specified API key. The API key must have been deactivated more than 90 days previously.

For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.

", "endpoint":{"hostPrefix":"cp.metadata."}, "idempotent":true }, "DeleteMap":{ "name":"DeleteMap", "http":{ "method":"DELETE", "requestUri":"/maps/v0/maps/{MapName}", "responseCode":200 }, "input":{"shape":"DeleteMapRequest"}, "output":{"shape":"DeleteMapResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Deletes a map resource from your Amazon Web Services account.

This operation deletes the resource permanently. If the map is being used in an application, the map may not render.

", "endpoint":{"hostPrefix":"cp.maps."}, "idempotent":true }, "DeletePlaceIndex":{ "name":"DeletePlaceIndex", "http":{ "method":"DELETE", "requestUri":"/places/v0/indexes/{IndexName}", "responseCode":200 }, "input":{"shape":"DeletePlaceIndexRequest"}, "output":{"shape":"DeletePlaceIndexResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Deletes a place index resource from your Amazon Web Services account.

This operation deletes the resource permanently.

", "endpoint":{"hostPrefix":"cp.places."}, "idempotent":true }, "DeleteRouteCalculator":{ "name":"DeleteRouteCalculator", "http":{ "method":"DELETE", "requestUri":"/routes/v0/calculators/{CalculatorName}", "responseCode":200 }, "input":{"shape":"DeleteRouteCalculatorRequest"}, "output":{"shape":"DeleteRouteCalculatorResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

Deletes a route calculator resource from your Amazon Web Services account.

This operation deletes the resource permanently.

", "endpoint":{"hostPrefix":"cp.routes."}, "idempotent":true }, "DeleteTracker":{ "name":"DeleteTracker", "http":{ "method":"DELETE", "requestUri":"/tracking/v0/trackers/{TrackerName}", "responseCode":200 }, "input":{"shape":"DeleteTrackerRequest"}, "output":{"shape":"DeleteTrackerResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes a tracker resource from your Amazon Web Services account.

This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.

", "endpoint":{"hostPrefix":"cp.tracking."}, "idempotent":true }, "DescribeGeofenceCollection":{ "name":"DescribeGeofenceCollection", "http":{ "method":"GET", "requestUri":"/geofencing/v0/collections/{CollectionName}", "responseCode":200 }, "input":{"shape":"DescribeGeofenceCollectionRequest"}, "output":{"shape":"DescribeGeofenceCollectionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Retrieves the geofence collection details.

", "endpoint":{"hostPrefix":"cp.geofencing."}, "readonly":true }, "DescribeKey":{ "name":"DescribeKey", "http":{ "method":"GET", "requestUri":"/metadata/v0/keys/{KeyName}", "responseCode":200 }, "input":{"shape":"DescribeKeyRequest"}, "output":{"shape":"DescribeKeyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Retrieves the API key resource details.

For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.

", "endpoint":{"hostPrefix":"cp.metadata."}, "readonly":true }, "DescribeMap":{ "name":"DescribeMap", "http":{ "method":"GET", "requestUri":"/maps/v0/maps/{MapName}", "responseCode":200 }, "input":{"shape":"DescribeMapRequest"}, "output":{"shape":"DescribeMapResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Retrieves the map resource details.

", "endpoint":{"hostPrefix":"cp.maps."}, "readonly":true }, "DescribePlaceIndex":{ "name":"DescribePlaceIndex", "http":{ "method":"GET", "requestUri":"/places/v0/indexes/{IndexName}", "responseCode":200 }, "input":{"shape":"DescribePlaceIndexRequest"}, "output":{"shape":"DescribePlaceIndexResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Retrieves the place index resource details.

", "endpoint":{"hostPrefix":"cp.places."}, "readonly":true }, "DescribeRouteCalculator":{ "name":"DescribeRouteCalculator", "http":{ "method":"GET", "requestUri":"/routes/v0/calculators/{CalculatorName}", "responseCode":200 }, "input":{"shape":"DescribeRouteCalculatorRequest"}, "output":{"shape":"DescribeRouteCalculatorResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

Retrieves the route calculator resource details.

", "endpoint":{"hostPrefix":"cp.routes."}, "readonly":true }, "DescribeTracker":{ "name":"DescribeTracker", "http":{ "method":"GET", "requestUri":"/tracking/v0/trackers/{TrackerName}", "responseCode":200 }, "input":{"shape":"DescribeTrackerRequest"}, "output":{"shape":"DescribeTrackerResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Retrieves the tracker resource details.

", "endpoint":{"hostPrefix":"cp.tracking."}, "readonly":true }, "DisassociateTrackerConsumer":{ "name":"DisassociateTrackerConsumer", "http":{ "method":"DELETE", "requestUri":"/tracking/v0/trackers/{TrackerName}/consumers/{ConsumerArn}", "responseCode":200 }, "input":{"shape":"DisassociateTrackerConsumerRequest"}, "output":{"shape":"DisassociateTrackerConsumerResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Removes the association between a tracker resource and a geofence collection.

Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.

", "endpoint":{"hostPrefix":"cp.tracking."} }, "ForecastGeofenceEvents":{ "name":"ForecastGeofenceEvents", "http":{ "method":"POST", "requestUri":"/geofencing/v0/collections/{CollectionName}/forecast-geofence-events", "responseCode":200 }, "input":{"shape":"ForecastGeofenceEventsRequest"}, "output":{"shape":"ForecastGeofenceEventsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This action forecasts future geofence events that are likely to occur within a specified time horizon if a device continues moving at its current speed. Each forecasted event is associated with a geofence from a provided geofence collection. A forecast event can have one of the following states:

ENTER: The device position is outside the referenced geofence, but the device may cross into the geofence during the forecasting time horizon if it maintains its current speed.

EXIT: The device position is inside the referenced geofence, but the device may leave the geofence during the forecasted time horizon if the device maintains it's current speed.

IDLE:The device is inside the geofence, and it will remain inside the geofence through the end of the time horizon if the device maintains it's current speed.

Heading direction is not considered in the current version. The API takes a conservative approach and includes events that can occur for any heading.

", "endpoint":{"hostPrefix":"geofencing."}, "readonly":true }, "GetDevicePosition":{ "name":"GetDevicePosition", "http":{ "method":"GET", "requestUri":"/tracking/v0/trackers/{TrackerName}/devices/{DeviceId}/positions/latest", "responseCode":200 }, "input":{"shape":"GetDevicePositionRequest"}, "output":{"shape":"GetDevicePositionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Retrieves a device's most recent position according to its sample time.

Device positions are deleted after 30 days.

", "endpoint":{"hostPrefix":"tracking."}, "readonly":true }, "GetDevicePositionHistory":{ "name":"GetDevicePositionHistory", "http":{ "method":"POST", "requestUri":"/tracking/v0/trackers/{TrackerName}/devices/{DeviceId}/list-positions", "responseCode":200 }, "input":{"shape":"GetDevicePositionHistoryRequest"}, "output":{"shape":"GetDevicePositionHistoryResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Retrieves the device position history from a tracker resource within a specified range of time.

Device positions are deleted after 30 days.

", "endpoint":{"hostPrefix":"tracking."}, "readonly":true }, "GetGeofence":{ "name":"GetGeofence", "http":{ "method":"GET", "requestUri":"/geofencing/v0/collections/{CollectionName}/geofences/{GeofenceId}", "responseCode":200 }, "input":{"shape":"GetGeofenceRequest"}, "output":{"shape":"GetGeofenceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Retrieves the geofence details from a geofence collection.

The returned geometry will always match the geometry format used when the geofence was created.

", "endpoint":{"hostPrefix":"geofencing."}, "readonly":true }, "GetMapGlyphs":{ "name":"GetMapGlyphs", "http":{ "method":"GET", "requestUri":"/maps/v0/maps/{MapName}/glyphs/{FontStack}/{FontUnicodeRange}", "responseCode":200 }, "input":{"shape":"GetMapGlyphsRequest"}, "output":{"shape":"GetMapGlyphsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetGlyphs unless you require Grab data.

Retrieves glyphs used to display labels on a map.

", "endpoint":{"hostPrefix":"maps."}, "readonly":true }, "GetMapSprites":{ "name":"GetMapSprites", "http":{ "method":"GET", "requestUri":"/maps/v0/maps/{MapName}/sprites/{FileName}", "responseCode":200 }, "input":{"shape":"GetMapSpritesRequest"}, "output":{"shape":"GetMapSpritesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetSprites unless you require Grab data.

Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.

", "endpoint":{"hostPrefix":"maps."}, "readonly":true }, "GetMapStyleDescriptor":{ "name":"GetMapStyleDescriptor", "http":{ "method":"GET", "requestUri":"/maps/v0/maps/{MapName}/style-descriptor", "responseCode":200 }, "input":{"shape":"GetMapStyleDescriptorRequest"}, "output":{"shape":"GetMapStyleDescriptorResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetStyleDescriptor unless you require Grab data.

Retrieves the map style descriptor from a map resource.

The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.

", "endpoint":{"hostPrefix":"maps."}, "readonly":true }, "GetMapTile":{ "name":"GetMapTile", "http":{ "method":"GET", "requestUri":"/maps/v0/maps/{MapName}/tiles/{Z}/{X}/{Y}", "responseCode":200 }, "input":{"shape":"GetMapTileRequest"}, "output":{"shape":"GetMapTileResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetTile unless you require Grab data.

Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).

", "endpoint":{"hostPrefix":"maps."}, "readonly":true }, "GetPlace":{ "name":"GetPlace", "http":{ "method":"GET", "requestUri":"/places/v0/indexes/{IndexName}/places/{PlaceId}", "responseCode":200 }, "input":{"shape":"GetPlaceRequest"}, "output":{"shape":"GetPlaceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the V2 GetPlace operation unless you require Grab data.

Finds a place by its unique ID. A PlaceId is returned by other search operations.

A PlaceId is valid only if all of the following are the same in the original search request and the call to GetPlace.

If your Place index resource is configured with Grab as your geolocation provider and Storage as Intended use, the GetPlace operation is unavailable. For more information, see AWS service terms.

", "endpoint":{"hostPrefix":"places."}, "readonly":true }, "ListDevicePositions":{ "name":"ListDevicePositions", "http":{ "method":"POST", "requestUri":"/tracking/v0/trackers/{TrackerName}/list-positions", "responseCode":200 }, "input":{"shape":"ListDevicePositionsRequest"}, "output":{"shape":"ListDevicePositionsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

A batch request to retrieve all device positions.

", "endpoint":{"hostPrefix":"tracking."}, "readonly":true }, "ListGeofenceCollections":{ "name":"ListGeofenceCollections", "http":{ "method":"POST", "requestUri":"/geofencing/v0/list-collections", "responseCode":200 }, "input":{"shape":"ListGeofenceCollectionsRequest"}, "output":{"shape":"ListGeofenceCollectionsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists geofence collections in your Amazon Web Services account.

", "endpoint":{"hostPrefix":"cp.geofencing."}, "readonly":true }, "ListGeofences":{ "name":"ListGeofences", "http":{ "method":"POST", "requestUri":"/geofencing/v0/collections/{CollectionName}/list-geofences", "responseCode":200 }, "input":{"shape":"ListGeofencesRequest"}, "output":{"shape":"ListGeofencesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists geofences stored in a given geofence collection.

", "endpoint":{"hostPrefix":"geofencing."}, "readonly":true }, "ListKeys":{ "name":"ListKeys", "http":{ "method":"POST", "requestUri":"/metadata/v0/list-keys", "responseCode":200 }, "input":{"shape":"ListKeysRequest"}, "output":{"shape":"ListKeysResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists API key resources in your Amazon Web Services account.

For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.

", "endpoint":{"hostPrefix":"cp.metadata."}, "readonly":true }, "ListMaps":{ "name":"ListMaps", "http":{ "method":"POST", "requestUri":"/maps/v0/list-maps", "responseCode":200 }, "input":{"shape":"ListMapsRequest"}, "output":{"shape":"ListMapsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Lists map resources in your Amazon Web Services account.

", "endpoint":{"hostPrefix":"cp.maps."}, "readonly":true }, "ListPlaceIndexes":{ "name":"ListPlaceIndexes", "http":{ "method":"POST", "requestUri":"/places/v0/list-indexes", "responseCode":200 }, "input":{"shape":"ListPlaceIndexesRequest"}, "output":{"shape":"ListPlaceIndexesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Lists place index resources in your Amazon Web Services account.

", "endpoint":{"hostPrefix":"cp.places."}, "readonly":true }, "ListRouteCalculators":{ "name":"ListRouteCalculators", "http":{ "method":"POST", "requestUri":"/routes/v0/list-calculators", "responseCode":200 }, "input":{"shape":"ListRouteCalculatorsRequest"}, "output":{"shape":"ListRouteCalculatorsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

Lists route calculator resources in your Amazon Web Services account.

", "endpoint":{"hostPrefix":"cp.routes."}, "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Returns a list of tags that are applied to the specified Amazon Location resource.

", "endpoint":{"hostPrefix":"cp.metadata."}, "readonly":true }, "ListTrackerConsumers":{ "name":"ListTrackerConsumers", "http":{ "method":"POST", "requestUri":"/tracking/v0/trackers/{TrackerName}/list-consumers", "responseCode":200 }, "input":{"shape":"ListTrackerConsumersRequest"}, "output":{"shape":"ListTrackerConsumersResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists geofence collections currently associated to the given tracker resource.

", "endpoint":{"hostPrefix":"cp.tracking."}, "readonly":true }, "ListTrackers":{ "name":"ListTrackers", "http":{ "method":"POST", "requestUri":"/tracking/v0/list-trackers", "responseCode":200 }, "input":{"shape":"ListTrackersRequest"}, "output":{"shape":"ListTrackersResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists tracker resources in your Amazon Web Services account.

", "endpoint":{"hostPrefix":"cp.tracking."}, "readonly":true }, "PutGeofence":{ "name":"PutGeofence", "http":{ "method":"PUT", "requestUri":"/geofencing/v0/collections/{CollectionName}/geofences/{GeofenceId}", "responseCode":200 }, "input":{"shape":"PutGeofenceRequest"}, "output":{"shape":"PutGeofenceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

", "endpoint":{"hostPrefix":"geofencing."} }, "SearchPlaceIndexForPosition":{ "name":"SearchPlaceIndexForPosition", "http":{ "method":"POST", "requestUri":"/places/v0/indexes/{IndexName}/search/position", "responseCode":200 }, "input":{"shape":"SearchPlaceIndexForPositionRequest"}, "output":{"shape":"SearchPlaceIndexForPositionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to ReverseGeocode or SearchNearby unless you require Grab data.

Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.

", "endpoint":{"hostPrefix":"places."}, "readonly":true }, "SearchPlaceIndexForSuggestions":{ "name":"SearchPlaceIndexForSuggestions", "http":{ "method":"POST", "requestUri":"/places/v0/indexes/{IndexName}/search/suggestions", "responseCode":200 }, "input":{"shape":"SearchPlaceIndexForSuggestionsRequest"}, "output":{"shape":"SearchPlaceIndexForSuggestionsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to Suggest or Autocomplete unless you require Grab data.

Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.

Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.

You can search for suggested place names near a specified position by using BiasPosition, or filter results within a bounding box by using FilterBBox. These parameters are mutually exclusive; using both BiasPosition and FilterBBox in the same command returns an error.

", "endpoint":{"hostPrefix":"places."}, "readonly":true }, "SearchPlaceIndexForText":{ "name":"SearchPlaceIndexForText", "http":{ "method":"POST", "requestUri":"/places/v0/indexes/{IndexName}/search/text", "responseCode":200 }, "input":{"shape":"SearchPlaceIndexForTextRequest"}, "output":{"shape":"SearchPlaceIndexForTextResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to Geocode or SearchText unless you require Grab data.

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.

You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.

Search results are returned in order of highest to lowest relevance.

", "endpoint":{"hostPrefix":"places."}, "readonly":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.

You can use the TagResource operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate up to 50 tags with a resource.

", "endpoint":{"hostPrefix":"cp.metadata."} }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Removes one or more tags from the specified Amazon Location resource.

", "endpoint":{"hostPrefix":"cp.metadata."}, "idempotent":true }, "UpdateGeofenceCollection":{ "name":"UpdateGeofenceCollection", "http":{ "method":"PATCH", "requestUri":"/geofencing/v0/collections/{CollectionName}", "responseCode":200 }, "input":{"shape":"UpdateGeofenceCollectionRequest"}, "output":{"shape":"UpdateGeofenceCollectionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Updates the specified properties of a given geofence collection.

", "endpoint":{"hostPrefix":"cp.geofencing."}, "idempotent":true }, "UpdateKey":{ "name":"UpdateKey", "http":{ "method":"PATCH", "requestUri":"/metadata/v0/keys/{KeyName}", "responseCode":200 }, "input":{"shape":"UpdateKeyRequest"}, "output":{"shape":"UpdateKeyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Updates the specified properties of a given API key resource.

", "endpoint":{"hostPrefix":"cp.metadata."}, "idempotent":true }, "UpdateMap":{ "name":"UpdateMap", "http":{ "method":"PATCH", "requestUri":"/maps/v0/maps/{MapName}", "responseCode":200 }, "input":{"shape":"UpdateMapRequest"}, "output":{"shape":"UpdateMapResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

Updates the specified properties of a given map resource.

", "endpoint":{"hostPrefix":"cp.maps."}, "idempotent":true }, "UpdatePlaceIndex":{ "name":"UpdatePlaceIndex", "http":{ "method":"PATCH", "requestUri":"/places/v0/indexes/{IndexName}", "responseCode":200 }, "input":{"shape":"UpdatePlaceIndexRequest"}, "output":{"shape":"UpdatePlaceIndexResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

Updates the specified properties of a given place index resource.

", "endpoint":{"hostPrefix":"cp.places."}, "idempotent":true }, "UpdateRouteCalculator":{ "name":"UpdateRouteCalculator", "http":{ "method":"PATCH", "requestUri":"/routes/v0/calculators/{CalculatorName}", "responseCode":200 }, "input":{"shape":"UpdateRouteCalculatorRequest"}, "output":{"shape":"UpdateRouteCalculatorResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

Updates the specified properties for a given route calculator resource.

", "endpoint":{"hostPrefix":"cp.routes."}, "idempotent":true }, "UpdateTracker":{ "name":"UpdateTracker", "http":{ "method":"PATCH", "requestUri":"/tracking/v0/trackers/{TrackerName}", "responseCode":200 }, "input":{"shape":"UpdateTrackerRequest"}, "output":{"shape":"UpdateTrackerResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Updates the specified properties of a given tracker resource.

", "endpoint":{"hostPrefix":"cp.tracking."}, "idempotent":true }, "VerifyDevicePosition":{ "name":"VerifyDevicePosition", "http":{ "method":"POST", "requestUri":"/tracking/v0/trackers/{TrackerName}/positions/verify", "responseCode":200 }, "input":{"shape":"VerifyDevicePositionRequest"}, "output":{"shape":"VerifyDevicePositionResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.

The Location Integrity SDK provides enhanced features related to device verification, and it is available for use by request. To get access to the SDK, contact Sales Support.

", "endpoint":{"hostPrefix":"tracking."} } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AndroidApp":{ "type":"structure", "required":[ "Package", "CertificateFingerprint" ], "members":{ "Package":{ "shape":"AndroidPackageName", "documentation":"

Unique package name for an Android app.

" }, "CertificateFingerprint":{ "shape":"Sha1CertificateFingerprint", "documentation":"

20 byte SHA-1 certificate fingerprint associated with the Android app signing certificate.

" } }, "documentation":"

Unique identifying information for an Android app. Consists of a package name and a 20 byte SHA-1 certificate fingerprint.

" }, "AndroidPackageName":{ "type":"string", "max":255, "min":1, "pattern":"([A-Za-z][A-Za-z\\d_]*\\.)+[A-Za-z][A-Za-z\\d_]*" }, "ApiKey":{ "type":"string", "max":1000, "min":0, "sensitive":true }, "ApiKeyAction":{ "type":"string", "max":200, "min":5, "pattern":"(geo|geo-routes|geo-places|geo-maps):\\w*\\*?" }, "ApiKeyFilter":{ "type":"structure", "members":{ "KeyStatus":{ "shape":"Status", "documentation":"

Filter on Active or Expired API keys.

" } }, "documentation":"

Options for filtering API keys.

" }, "ApiKeyRestrictions":{ "type":"structure", "required":[ "AllowActions", "AllowResources" ], "members":{ "AllowActions":{ "shape":"ApiKeyRestrictionsAllowActionsList", "documentation":"

A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.

The following are valid values for the actions.

You must use these strings exactly. For example, to provide access to map rendering, the only valid action is geo:GetMap* as an input to the list. [\"geo:GetMap*\"] is valid but [\"geo:GetMapTile\"] is not. Similarly, you cannot use [\"geo:SearchPlaceIndexFor*\"] - you must list each of the Place actions separately.

" }, "AllowResources":{ "shape":"ApiKeyRestrictionsAllowResourcesList", "documentation":"

A list of allowed resource ARNs that a API key bearer can perform actions on.

For more information about ARN format, see Amazon Resource Names (ARNs).

" }, "AllowReferers":{ "shape":"ApiKeyRestrictionsAllowReferersList", "documentation":"

An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.

Requirements:

" }, "AllowAndroidApps":{ "shape":"ApiKeyRestrictionsAllowAndroidAppsList", "documentation":"

An optional list of allowed Android applications for which requests must originate from. Requests using this API key from other sources will not be allowed.

" }, "AllowAppleApps":{ "shape":"ApiKeyRestrictionsAllowAppleAppsList", "documentation":"

An optional list of allowed Apple applications for which requests must originate from. Requests using this API key from other sources will not be allowed.

" } }, "documentation":"

API Restrictions on the allowed actions, resources, and referers for an API key resource.

" }, "ApiKeyRestrictionsAllowActionsList":{ "type":"list", "member":{"shape":"ApiKeyAction"}, "max":24, "min":1 }, "ApiKeyRestrictionsAllowAndroidAppsList":{ "type":"list", "member":{"shape":"AndroidApp"}, "max":5, "min":0 }, "ApiKeyRestrictionsAllowAppleAppsList":{ "type":"list", "member":{"shape":"AppleApp"}, "max":5, "min":0 }, "ApiKeyRestrictionsAllowReferersList":{ "type":"list", "member":{"shape":"RefererPattern"}, "max":5, "min":0 }, "ApiKeyRestrictionsAllowResourcesList":{ "type":"list", "member":{"shape":"GeoArnV2"}, "max":8, "min":1 }, "AppleApp":{ "type":"structure", "required":["BundleId"], "members":{ "BundleId":{ "shape":"AppleBundleId", "documentation":"

The unique identifier of the app across all Apple platforms (iOS, macOS, tvOS, watchOS, etc.)

" } }, "documentation":"

Unique identifying information for an Apple app (iOS, macOS, tvOS and watchOS). Consists of an Apple Bundle ID.

" }, "AppleBundleId":{ "type":"string", "max":155, "min":1, "pattern":"[A-Za-z0-9\\-]+(\\.[A-Za-z0-9\\-]+)+" }, "Arn":{ "type":"string", "max":1600, "min":0, "pattern":"arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?" }, "ArnList":{ "type":"list", "member":{"shape":"Arn"} }, "AssociateTrackerConsumerRequest":{ "type":"structure", "required":[ "TrackerName", "ConsumerArn" ], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name of the tracker resource to be associated with a geofence collection.

", "location":"uri", "locationName":"TrackerName" }, "ConsumerArn":{ "shape":"Arn", "documentation":"

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 Amazon Web Services.

" } } }, "AssociateTrackerConsumerResponse":{ "type":"structure", "members":{} }, "Base64EncodedGeobuf":{ "type":"blob", "max":700000, "min":0, "sensitive":true }, "BatchDeleteDevicePositionHistoryError":{ "type":"structure", "required":[ "DeviceId", "Error" ], "members":{ "DeviceId":{ "shape":"Id", "documentation":"

The ID of the device for this position.

" }, "Error":{"shape":"BatchItemError"} }, "documentation":"

Contains the tracker resource details.

" }, "BatchDeleteDevicePositionHistoryErrorList":{ "type":"list", "member":{"shape":"BatchDeleteDevicePositionHistoryError"} }, "BatchDeleteDevicePositionHistoryRequest":{ "type":"structure", "required":[ "TrackerName", "DeviceIds" ], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name of the tracker resource to delete the device position history from.

", "location":"uri", "locationName":"TrackerName" }, "DeviceIds":{ "shape":"BatchDeleteDevicePositionHistoryRequestDeviceIdsList", "documentation":"

Devices whose position history you want to delete.

" } } }, "BatchDeleteDevicePositionHistoryRequestDeviceIdsList":{ "type":"list", "member":{"shape":"Id"}, "max":100, "min":1 }, "BatchDeleteDevicePositionHistoryResponse":{ "type":"structure", "required":["Errors"], "members":{ "Errors":{ "shape":"BatchDeleteDevicePositionHistoryErrorList", "documentation":"

Contains error details for each device history that failed to delete.

" } } }, "BatchDeleteGeofenceError":{ "type":"structure", "required":[ "GeofenceId", "Error" ], "members":{ "GeofenceId":{ "shape":"Id", "documentation":"

The geofence associated with the error message.

" }, "Error":{ "shape":"BatchItemError", "documentation":"

Contains details associated to the batch error.

" } }, "documentation":"

Contains error details for each geofence that failed to delete from the geofence collection.

" }, "BatchDeleteGeofenceErrorList":{ "type":"list", "member":{"shape":"BatchDeleteGeofenceError"} }, "BatchDeleteGeofenceRequest":{ "type":"structure", "required":[ "CollectionName", "GeofenceIds" ], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The geofence collection storing the geofences to be deleted.

", "location":"uri", "locationName":"CollectionName" }, "GeofenceIds":{ "shape":"BatchDeleteGeofenceRequestGeofenceIdsList", "documentation":"

The batch of geofences to be deleted.

" } } }, "BatchDeleteGeofenceRequestGeofenceIdsList":{ "type":"list", "member":{"shape":"Id"}, "max":10, "min":1 }, "BatchDeleteGeofenceResponse":{ "type":"structure", "required":["Errors"], "members":{ "Errors":{ "shape":"BatchDeleteGeofenceErrorList", "documentation":"

Contains error details for each geofence that failed to delete.

" } } }, "BatchEvaluateGeofencesError":{ "type":"structure", "required":[ "DeviceId", "SampleTime", "Error" ], "members":{ "DeviceId":{ "shape":"Id", "documentation":"

The device associated with the position evaluation error.

" }, "SampleTime":{ "shape":"Timestamp", "documentation":"

Specifies a timestamp for when the error occurred in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

" }, "Error":{ "shape":"BatchItemError", "documentation":"

Contains details associated to the batch error.

" } }, "documentation":"

Contains error details for each device that failed to evaluate its position against the geofences in a given geofence collection.

" }, "BatchEvaluateGeofencesErrorList":{ "type":"list", "member":{"shape":"BatchEvaluateGeofencesError"} }, "BatchEvaluateGeofencesRequest":{ "type":"structure", "required":[ "CollectionName", "DevicePositionUpdates" ], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The geofence collection used in evaluating the position of devices against its geofences.

", "location":"uri", "locationName":"CollectionName" }, "DevicePositionUpdates":{ "shape":"BatchEvaluateGeofencesRequestDevicePositionUpdatesList", "documentation":"

Contains device details for each device to be evaluated against the given geofence collection.

" } } }, "BatchEvaluateGeofencesRequestDevicePositionUpdatesList":{ "type":"list", "member":{"shape":"DevicePositionUpdate"}, "max":10, "min":1 }, "BatchEvaluateGeofencesResponse":{ "type":"structure", "required":["Errors"], "members":{ "Errors":{ "shape":"BatchEvaluateGeofencesErrorList", "documentation":"

Contains error details for each device that failed to evaluate its position against the given geofence collection.

" } } }, "BatchGetDevicePositionError":{ "type":"structure", "required":[ "DeviceId", "Error" ], "members":{ "DeviceId":{ "shape":"Id", "documentation":"

The ID of the device that didn't return a position.

" }, "Error":{ "shape":"BatchItemError", "documentation":"

Contains details related to the error code.

" } }, "documentation":"

Contains error details for each device that didn't return a position.

" }, "BatchGetDevicePositionErrorList":{ "type":"list", "member":{"shape":"BatchGetDevicePositionError"} }, "BatchGetDevicePositionRequest":{ "type":"structure", "required":[ "TrackerName", "DeviceIds" ], "members":{ "TrackerName":{ "shape":"BatchGetDevicePositionRequestTrackerNameString", "documentation":"

The tracker resource retrieving the device position.

", "location":"uri", "locationName":"TrackerName" }, "DeviceIds":{ "shape":"BatchGetDevicePositionRequestDeviceIdsList", "documentation":"

Devices whose position you want to retrieve.

" } } }, "BatchGetDevicePositionRequestDeviceIdsList":{ "type":"list", "member":{"shape":"Id"}, "max":10, "min":1 }, "BatchGetDevicePositionRequestTrackerNameString":{ "type":"string", "min":1, "pattern":"[-._\\w]+" }, "BatchGetDevicePositionResponse":{ "type":"structure", "required":[ "Errors", "DevicePositions" ], "members":{ "Errors":{ "shape":"BatchGetDevicePositionErrorList", "documentation":"

Contains error details for each device that failed to send its position to the tracker resource.

" }, "DevicePositions":{ "shape":"DevicePositionList", "documentation":"

Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.

" } } }, "BatchItemError":{ "type":"structure", "members":{ "Code":{ "shape":"BatchItemErrorCode", "documentation":"

The error code associated with the batch request error.

" }, "Message":{ "shape":"String", "documentation":"

A message with the reason for the batch request error.

" } }, "documentation":"

Contains the batch request error details associated with the request.

" }, "BatchItemErrorCode":{ "type":"string", "enum":[ "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError" ] }, "BatchPutGeofenceError":{ "type":"structure", "required":[ "GeofenceId", "Error" ], "members":{ "GeofenceId":{ "shape":"Id", "documentation":"

The geofence associated with the error message.

" }, "Error":{ "shape":"BatchItemError", "documentation":"

Contains details associated to the batch error.

" } }, "documentation":"

Contains error details for each geofence that failed to be stored in a given geofence collection.

" }, "BatchPutGeofenceErrorList":{ "type":"list", "member":{"shape":"BatchPutGeofenceError"} }, "BatchPutGeofenceRequest":{ "type":"structure", "required":[ "CollectionName", "Entries" ], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The geofence collection storing the geofences.

", "location":"uri", "locationName":"CollectionName" }, "Entries":{ "shape":"BatchPutGeofenceRequestEntriesList", "documentation":"

The batch of geofences to be stored in a geofence collection.

" } } }, "BatchPutGeofenceRequestEntriesList":{ "type":"list", "member":{"shape":"BatchPutGeofenceRequestEntry"}, "max":10, "min":1 }, "BatchPutGeofenceRequestEntry":{ "type":"structure", "required":[ "GeofenceId", "Geometry" ], "members":{ "GeofenceId":{ "shape":"Id", "documentation":"

The identifier for the geofence to be stored in a given geofence collection.

" }, "Geometry":{ "shape":"GeofenceGeometry", "documentation":"

Contains the details to specify the position of the geofence. Can be a circle, a polygon, or a multipolygon. Polygon and MultiPolygon geometries can be defined using their respective parameters, or encoded in Geobuf format using the Geobuf parameter. Including multiple geometry types in the same request will return a validation error.

The geofence Polygon and MultiPolygon formats support a maximum of 1,000 total vertices. The Geobuf format supports a maximum of 100,000 vertices.

" }, "GeofenceProperties":{ "shape":"PropertyMap", "documentation":"

Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: \"key\" : \"value\"

" } }, "documentation":"

Contains geofence geometry details.

" }, "BatchPutGeofenceResponse":{ "type":"structure", "required":[ "Successes", "Errors" ], "members":{ "Successes":{ "shape":"BatchPutGeofenceSuccessList", "documentation":"

Contains each geofence that was successfully stored in a geofence collection.

" }, "Errors":{ "shape":"BatchPutGeofenceErrorList", "documentation":"

Contains additional error details for each geofence that failed to be stored in a geofence collection.

" } } }, "BatchPutGeofenceSuccess":{ "type":"structure", "required":[ "GeofenceId", "CreateTime", "UpdateTime" ], "members":{ "GeofenceId":{ "shape":"Id", "documentation":"

The geofence successfully stored in a geofence collection.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } }, "documentation":"

Contains a summary of each geofence that was successfully stored in a given geofence collection.

" }, "BatchPutGeofenceSuccessList":{ "type":"list", "member":{"shape":"BatchPutGeofenceSuccess"} }, "BatchUpdateDevicePositionError":{ "type":"structure", "required":[ "DeviceId", "SampleTime", "Error" ], "members":{ "DeviceId":{ "shape":"Id", "documentation":"

The device associated with the failed location update.

" }, "SampleTime":{ "shape":"Timestamp", "documentation":"

The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "Error":{ "shape":"BatchItemError", "documentation":"

Contains details related to the error code such as the error code and error message.

" } }, "documentation":"

Contains error details for each device that failed to update its position.

" }, "BatchUpdateDevicePositionErrorList":{ "type":"list", "member":{"shape":"BatchUpdateDevicePositionError"} }, "BatchUpdateDevicePositionRequest":{ "type":"structure", "required":[ "TrackerName", "Updates" ], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name of the tracker resource to update.

", "location":"uri", "locationName":"TrackerName" }, "Updates":{ "shape":"BatchUpdateDevicePositionRequestUpdatesList", "documentation":"

Contains the position update details for each device, up to 10 devices.

" } } }, "BatchUpdateDevicePositionRequestUpdatesList":{ "type":"list", "member":{"shape":"DevicePositionUpdate"}, "max":10, "min":1 }, "BatchUpdateDevicePositionResponse":{ "type":"structure", "required":["Errors"], "members":{ "Errors":{ "shape":"BatchUpdateDevicePositionErrorList", "documentation":"

Contains error details for each device that failed to update its position.

" } } }, "Blob":{"type":"blob"}, "Boolean":{ "type":"boolean", "box":true }, "BoundingBox":{ "type":"list", "member":{"shape":"Double"}, "max":4, "min":4, "sensitive":true }, "CalculateRouteCarModeOptions":{ "type":"structure", "members":{ "AvoidFerries":{ "shape":"SensitiveBoolean", "documentation":"

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

" }, "AvoidTolls":{ "shape":"SensitiveBoolean", "documentation":"

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

" } }, "documentation":"

Contains details about additional route preferences for requests that specify TravelMode as Car.

" }, "CalculateRouteMatrixRequest":{ "type":"structure", "required":[ "CalculatorName", "DeparturePositions", "DestinationPositions" ], "members":{ "CalculatorName":{ "shape":"ResourceName", "documentation":"

The name of the route calculator resource that you want to use to calculate the route matrix.

", "location":"uri", "locationName":"CalculatorName" }, "DeparturePositions":{ "shape":"CalculateRouteMatrixRequestDeparturePositionsList", "documentation":"

The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

Valid Values: [-180 to 180,-90 to 90]

" }, "DestinationPositions":{ "shape":"CalculateRouteMatrixRequestDestinationPositionsList", "documentation":"

The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

Valid Values: [-180 to 180,-90 to 90]

" }, "TravelMode":{ "shape":"TravelMode", "documentation":"

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The TravelMode you specify also determines how you specify route preferences:

Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

Default Value: Car

" }, "DepartureTime":{ "shape":"Timestamp", "documentation":"

Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

Setting a departure time in the past returns a 400 ValidationException error.

" }, "DepartNow":{ "shape":"SensitiveBoolean", "documentation":"

Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

Default Value: false

Valid Values: false | true

" }, "DistanceUnit":{ "shape":"DistanceUnit", "documentation":"

Set the unit system to specify the distance.

Default Value: Kilometers

" }, "CarModeOptions":{ "shape":"CalculateRouteCarModeOptions", "documentation":"

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

" }, "TruckModeOptions":{ "shape":"CalculateRouteTruckModeOptions", "documentation":"

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

" }, "Key":{ "shape":"ApiKey", "documentation":"

The optional API key to authorize the request.

", "location":"querystring", "locationName":"key" } } }, "CalculateRouteMatrixRequestDeparturePositionsList":{ "type":"list", "member":{"shape":"Position"}, "max":350, "min":1 }, "CalculateRouteMatrixRequestDestinationPositionsList":{ "type":"list", "member":{"shape":"Position"}, "max":350, "min":1 }, "CalculateRouteMatrixResponse":{ "type":"structure", "required":[ "RouteMatrix", "Summary" ], "members":{ "RouteMatrix":{ "shape":"RouteMatrix", "documentation":"

The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.

" }, "SnappedDeparturePositions":{ "shape":"CalculateRouteMatrixResponseSnappedDeparturePositionsList", "documentation":"

For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.

" }, "SnappedDestinationPositions":{ "shape":"CalculateRouteMatrixResponseSnappedDestinationPositionsList", "documentation":"

The list of destination positions for the route matrix used for calculation of the RouteMatrix.

" }, "Summary":{ "shape":"CalculateRouteMatrixSummary", "documentation":"

Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

" } }, "documentation":"

Returns the result of the route matrix calculation.

" }, "CalculateRouteMatrixResponseSnappedDeparturePositionsList":{ "type":"list", "member":{"shape":"Position"}, "max":350, "min":1 }, "CalculateRouteMatrixResponseSnappedDestinationPositionsList":{ "type":"list", "member":{"shape":"Position"}, "max":350, "min":1 }, "CalculateRouteMatrixSummary":{ "type":"structure", "required":[ "DataSource", "RouteCount", "ErrorCount", "DistanceUnit" ], "members":{ "DataSource":{ "shape":"String", "documentation":"

The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:

For more information about data providers, see Amazon Location Service data providers.

" }, "RouteCount":{ "shape":"CalculateRouteMatrixSummaryRouteCountInteger", "documentation":"

The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.

" }, "ErrorCount":{ "shape":"CalculateRouteMatrixSummaryErrorCountInteger", "documentation":"

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

" }, "DistanceUnit":{ "shape":"DistanceUnit", "documentation":"

The unit of measurement for route distances.

" } }, "documentation":"

A summary of the calculated route matrix.

" }, "CalculateRouteMatrixSummaryErrorCountInteger":{ "type":"integer", "box":true, "max":160000, "min":1 }, "CalculateRouteMatrixSummaryRouteCountInteger":{ "type":"integer", "box":true, "max":160000, "min":1 }, "CalculateRouteRequest":{ "type":"structure", "required":[ "CalculatorName", "DeparturePosition", "DestinationPosition" ], "members":{ "CalculatorName":{ "shape":"ResourceName", "documentation":"

The name of the route calculator resource that you want to use to calculate the route.

", "location":"uri", "locationName":"CalculatorName" }, "DeparturePosition":{ "shape":"Position", "documentation":"

The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

" }, "DestinationPosition":{ "shape":"Position", "documentation":"

The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

" }, "WaypointPositions":{ "shape":"CalculateRouteRequestWaypointPositionsList", "documentation":"

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

" }, "TravelMode":{ "shape":"TravelMode", "documentation":"

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, Walking, Bicycle or Motorcycle as options for the TravelMode.

Bicycle and Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide.

The TravelMode you specify also determines how you specify route preferences:

Default Value: Car

" }, "DepartureTime":{ "shape":"Timestamp", "documentation":"

Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

" }, "DepartNow":{ "shape":"SensitiveBoolean", "documentation":"

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

" }, "DistanceUnit":{ "shape":"DistanceUnit", "documentation":"

Set the unit system to specify the distance.

Default Value: Kilometers

" }, "IncludeLegGeometry":{ "shape":"SensitiveBoolean", "documentation":"

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

" }, "CarModeOptions":{ "shape":"CalculateRouteCarModeOptions", "documentation":"

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

" }, "TruckModeOptions":{ "shape":"CalculateRouteTruckModeOptions", "documentation":"

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

" }, "ArrivalTime":{ "shape":"Timestamp", "documentation":"

Specifies the desired time of arrival. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

ArrivalTime is not supported Esri.

" }, "OptimizeFor":{ "shape":"OptimizationMode", "documentation":"

Specifies the distance to optimize for when calculating a route.

" }, "Key":{ "shape":"ApiKey", "documentation":"

The optional API key to authorize the request.

", "location":"querystring", "locationName":"key" } } }, "CalculateRouteRequestWaypointPositionsList":{ "type":"list", "member":{"shape":"Position"}, "max":23, "min":0 }, "CalculateRouteResponse":{ "type":"structure", "required":[ "Legs", "Summary" ], "members":{ "Legs":{ "shape":"LegList", "documentation":"

Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

" }, "Summary":{ "shape":"CalculateRouteSummary", "documentation":"

Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

" } }, "documentation":"

Returns the result of the route calculation. Metadata includes legs and route summary.

" }, "CalculateRouteSummary":{ "type":"structure", "required":[ "RouteBBox", "DataSource", "Distance", "DurationSeconds", "DistanceUnit" ], "members":{ "RouteBBox":{ "shape":"BoundingBox", "documentation":"

Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].

The first 2 bbox parameters describe the lower southwest corner:

The next 2 bbox parameters describe the upper northeast corner:

" }, "DataSource":{ "shape":"String", "documentation":"

The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

For more information about data providers, see Amazon Location Service data providers.

" }, "Distance":{ "shape":"CalculateRouteSummaryDistanceDouble", "documentation":"

The total distance covered by the route. The sum of the distance travelled between every stop on the route.

If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.

" }, "DurationSeconds":{ "shape":"CalculateRouteSummaryDurationSecondsDouble", "documentation":"

The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

" }, "DistanceUnit":{ "shape":"DistanceUnit", "documentation":"

The unit of measurement for route distances.

" } }, "documentation":"

A summary of the calculated route.

" }, "CalculateRouteSummaryDistanceDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "CalculateRouteSummaryDurationSecondsDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "CalculateRouteTruckModeOptions":{ "type":"structure", "members":{ "AvoidFerries":{ "shape":"SensitiveBoolean", "documentation":"

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

" }, "AvoidTolls":{ "shape":"SensitiveBoolean", "documentation":"

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

" }, "Dimensions":{ "shape":"TruckDimensions", "documentation":"

Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.

" }, "Weight":{ "shape":"TruckWeight", "documentation":"

Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.

" } }, "documentation":"

Contains details about additional route preferences for requests that specify TravelMode as Truck.

" }, "CellSignals":{ "type":"structure", "required":["LteCellDetails"], "members":{ "LteCellDetails":{ "shape":"CellSignalsLteCellDetailsList", "documentation":"

Information about the Long-Term Evolution (LTE) network the device is connected to.

" } }, "documentation":"

The cellular network communication infrastructure that the device uses.

" }, "CellSignalsLteCellDetailsList":{ "type":"list", "member":{"shape":"LteCellDetails"}, "max":16, "min":1 }, "Circle":{ "type":"structure", "required":[ "Center", "Radius" ], "members":{ "Center":{ "shape":"Position", "documentation":"

A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude].

" }, "Radius":{ "shape":"SensitiveDouble", "documentation":"

The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).

" } }, "documentation":"

A circle on the earth, as defined by a center point and a radius.

", "sensitive":true }, "ConflictException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"

The request was unsuccessful because of a conflict.

", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "CountryCode3":{ "type":"string", "max":3, "min":3, "pattern":"[A-Z]{3}", "sensitive":true }, "CountryCode3OrEmpty":{ "type":"string", "max":3, "min":0, "pattern":"[A-Z]{3}$|^", "sensitive":true }, "CountryCodeList":{ "type":"list", "member":{"shape":"CountryCode3"}, "max":100, "min":1 }, "CreateGeofenceCollectionRequest":{ "type":"structure", "required":["CollectionName"], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

A custom name for the geofence collection.

Requirements:

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. If included, the only allowed value is RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"

This parameter is no longer used.

", "deprecated":true, "deprecatedMessage":"Deprecated. No longer allowed.", "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", "documentation":"

An optional description for the geofence collection.

" }, "Tags":{ "shape":"TagMap", "documentation":"

Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: \"key\" : \"value\"

Restrictions:

" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"

A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

" } } }, "CreateGeofenceCollectionResponse":{ "type":"structure", "required":[ "CollectionName", "CollectionArn", "CreateTime" ], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The name for the geofence collection.

" }, "CollectionArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

" } } }, "CreateKeyRequest":{ "type":"structure", "required":[ "KeyName", "Restrictions" ], "members":{ "KeyName":{ "shape":"ResourceName", "documentation":"

A custom name for the API key resource.

Requirements:

" }, "Restrictions":{ "shape":"ApiKeyRestrictions", "documentation":"

The API key restrictions for the API key resource.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

An optional description for the API key resource.

" }, "ExpireTime":{ "shape":"Timestamp", "documentation":"

The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

" }, "NoExpiry":{ "shape":"Boolean", "documentation":"

Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

" }, "Tags":{ "shape":"TagMap", "documentation":"

Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Format: \"key\" : \"value\"

Restrictions:

" } } }, "CreateKeyResponse":{ "type":"structure", "required":[ "Key", "KeyArn", "KeyName", "CreateTime" ], "members":{ "Key":{ "shape":"ApiKey", "documentation":"

The key value/string of an API key. This value is used when making API calls to authorize the call. For example, see GetMapGlyphs.

" }, "KeyArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.

" }, "KeyName":{ "shape":"ResourceName", "documentation":"

The name of the API key resource.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" } } }, "CreateMapRequest":{ "type":"structure", "required":[ "MapName", "Configuration" ], "members":{ "MapName":{ "shape":"ResourceName", "documentation":"

The name for the map resource.

Requirements:

" }, "Configuration":{ "shape":"MapConfiguration", "documentation":"

Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. If included, the only allowed value is RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", "documentation":"

An optional description for the map resource.

" }, "Tags":{ "shape":"TagMap", "documentation":"

Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: \"key\" : \"value\"

Restrictions:

" } } }, "CreateMapResponse":{ "type":"structure", "required":[ "MapName", "MapArn", "CreateTime" ], "members":{ "MapName":{ "shape":"ResourceName", "documentation":"

The name of the map resource.

" }, "MapArn":{ "shape":"GeoArn", "documentation":"

The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all Amazon Web Services.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" } } }, "CreatePlaceIndexRequest":{ "type":"structure", "required":[ "IndexName", "DataSource" ], "members":{ "IndexName":{ "shape":"ResourceName", "documentation":"

The name of the place index resource.

Requirements:

" }, "DataSource":{ "shape":"String", "documentation":"

Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

For additional information , see Data providers on the Amazon Location Service developer guide.

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. If included, the only allowed value is RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The optional description for the place index resource.

" }, "DataSourceConfiguration":{ "shape":"DataSourceConfiguration", "documentation":"

Specifies the data storage option requesting Places.

" }, "Tags":{ "shape":"TagMap", "documentation":"

Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.

Format: \"key\" : \"value\"

Restrictions:

" } } }, "CreatePlaceIndexResponse":{ "type":"structure", "required":[ "IndexName", "IndexArn", "CreateTime" ], "members":{ "IndexName":{ "shape":"ResourceName", "documentation":"

The name for the place index resource.

" }, "IndexArn":{ "shape":"GeoArn", "documentation":"

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" } } }, "CreateRouteCalculatorRequest":{ "type":"structure", "required":[ "CalculatorName", "DataSource" ], "members":{ "CalculatorName":{ "shape":"ResourceName", "documentation":"

The name of the route calculator resource.

Requirements:

" }, "DataSource":{ "shape":"String", "documentation":"

Specifies the data provider of traffic and road network data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

For additional information , see Data providers on the Amazon Location Service Developer Guide.

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. If included, the only allowed value is RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The optional description for the route calculator resource.

" }, "Tags":{ "shape":"TagMap", "documentation":"

Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: \"key\" : \"value\"

Restrictions:

" } } }, "CreateRouteCalculatorResponse":{ "type":"structure", "required":[ "CalculatorName", "CalculatorArn", "CreateTime" ], "members":{ "CalculatorName":{ "shape":"ResourceName", "documentation":"

The name of the route calculator resource.

" }, "CalculatorArn":{ "shape":"GeoArn", "documentation":"

The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all Amazon Web Services.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" } } }, "CreateTrackerRequest":{ "type":"structure", "required":["TrackerName"], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name for the tracker resource.

Requirements:

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. If included, the only allowed value is RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"

A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"

This parameter is no longer used.

", "deprecated":true, "deprecatedMessage":"Deprecated. No longer allowed.", "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", "documentation":"

An optional description for the tracker resource.

" }, "Tags":{ "shape":"TagMap", "documentation":"

Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: \"key\" : \"value\"

Restrictions:

" }, "PositionFiltering":{ "shape":"PositionFiltering", "documentation":"

Specifies the position filtering for the tracker resource.

Valid values:

This field is optional. If not specified, the default value is TimeBased.

" }, "EventBridgeEnabled":{ "shape":"Boolean", "documentation":"

Whether to enable position UPDATE events from this tracker to be sent to EventBridge.

You do not need enable this feature to get ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.

" }, "KmsKeyEnableGeospatialQueries":{ "shape":"Boolean", "documentation":"

Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

This parameter is only used if you are using a KMS customer managed key.

If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.

You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.

" } } }, "CreateTrackerResponse":{ "type":"structure", "required":[ "TrackerName", "TrackerArn", "CreateTime" ], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name of the tracker resource.

" }, "TrackerArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" } } }, "CustomLayer":{ "type":"string", "max":100, "min":1, "pattern":"[-._\\w]+" }, "CustomLayerList":{ "type":"list", "member":{"shape":"CustomLayer"}, "max":10, "min":0 }, "DataSourceConfiguration":{ "type":"structure", "members":{ "IntendedUse":{ "shape":"IntendedUse", "documentation":"

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

Valid values include:

Default value: SingleUse

" } }, "documentation":"

Specifies the data storage option chosen for requesting Places.

When using Amazon Location Places:

For more information, see the AWS Service Terms for Amazon Location Service.

" }, "DeleteGeofenceCollectionRequest":{ "type":"structure", "required":["CollectionName"], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The name of the geofence collection to be deleted.

", "location":"uri", "locationName":"CollectionName" } } }, "DeleteGeofenceCollectionResponse":{ "type":"structure", "members":{} }, "DeleteKeyRequest":{ "type":"structure", "required":["KeyName"], "members":{ "KeyName":{ "shape":"ResourceName", "documentation":"

The name of the API key to delete.

", "location":"uri", "locationName":"KeyName" }, "ForceDelete":{ "shape":"Boolean", "documentation":"

ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

", "location":"querystring", "locationName":"forceDelete" } } }, "DeleteKeyResponse":{ "type":"structure", "members":{} }, "DeleteMapRequest":{ "type":"structure", "required":["MapName"], "members":{ "MapName":{ "shape":"ResourceName", "documentation":"

The name of the map resource to be deleted.

", "location":"uri", "locationName":"MapName" } } }, "DeleteMapResponse":{ "type":"structure", "members":{} }, "DeletePlaceIndexRequest":{ "type":"structure", "required":["IndexName"], "members":{ "IndexName":{ "shape":"ResourceName", "documentation":"

The name of the place index resource to be deleted.

", "location":"uri", "locationName":"IndexName" } } }, "DeletePlaceIndexResponse":{ "type":"structure", "members":{} }, "DeleteRouteCalculatorRequest":{ "type":"structure", "required":["CalculatorName"], "members":{ "CalculatorName":{ "shape":"ResourceName", "documentation":"

The name of the route calculator resource to be deleted.

", "location":"uri", "locationName":"CalculatorName" } } }, "DeleteRouteCalculatorResponse":{ "type":"structure", "members":{} }, "DeleteTrackerRequest":{ "type":"structure", "required":["TrackerName"], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name of the tracker resource to be deleted.

", "location":"uri", "locationName":"TrackerName" } } }, "DeleteTrackerResponse":{ "type":"structure", "members":{} }, "DescribeGeofenceCollectionRequest":{ "type":"structure", "required":["CollectionName"], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The name of the geofence collection.

", "location":"uri", "locationName":"CollectionName" } } }, "DescribeGeofenceCollectionResponse":{ "type":"structure", "required":[ "CollectionName", "CollectionArn", "Description", "CreateTime", "UpdateTime" ], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The name of the geofence collection.

" }, "CollectionArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The optional description for the geofence collection.

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. Always returns RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"

No longer used. Always returns an empty string.

", "deprecated":true, "deprecatedMessage":"Deprecated. Unused.", "deprecatedSince":"2022-02-01" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"

A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource

" }, "Tags":{ "shape":"TagMap", "documentation":"

Displays the key, value pairs of tags associated with this resource.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "GeofenceCount":{ "shape":"DescribeGeofenceCollectionResponseGeofenceCountInteger", "documentation":"

The number of geofences in the geofence collection.

" } } }, "DescribeGeofenceCollectionResponseGeofenceCountInteger":{ "type":"integer", "box":true, "min":0 }, "DescribeKeyRequest":{ "type":"structure", "required":["KeyName"], "members":{ "KeyName":{ "shape":"ResourceName", "documentation":"

The name of the API key resource.

", "location":"uri", "locationName":"KeyName" } } }, "DescribeKeyResponse":{ "type":"structure", "required":[ "Key", "KeyArn", "KeyName", "Restrictions", "CreateTime", "ExpireTime", "UpdateTime" ], "members":{ "Key":{ "shape":"ApiKey", "documentation":"

The key value/string of an API key.

" }, "KeyArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.

" }, "KeyName":{ "shape":"ResourceName", "documentation":"

The name of the API key resource.

" }, "Restrictions":{"shape":"ApiKeyRestrictions"}, "CreateTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "ExpireTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The optional description for the API key resource.

" }, "Tags":{ "shape":"TagMap", "documentation":"

Tags associated with the API key resource.

" } } }, "DescribeMapRequest":{ "type":"structure", "required":["MapName"], "members":{ "MapName":{ "shape":"ResourceName", "documentation":"

The name of the map resource.

", "location":"uri", "locationName":"MapName" } } }, "DescribeMapResponse":{ "type":"structure", "required":[ "MapName", "MapArn", "DataSource", "Configuration", "Description", "CreateTime", "UpdateTime" ], "members":{ "MapName":{ "shape":"ResourceName", "documentation":"

The map style selected from an available provider.

" }, "MapArn":{ "shape":"GeoArn", "documentation":"

The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all Amazon Web Services.

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. Always returns RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "DataSource":{ "shape":"String", "documentation":"

Specifies the data provider for the associated map tiles.

" }, "Configuration":{ "shape":"MapConfiguration", "documentation":"

Specifies the map tile style selected from a partner data provider.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The optional description for the map resource.

" }, "Tags":{ "shape":"TagMap", "documentation":"

Tags associated with the map resource.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } } }, "DescribePlaceIndexRequest":{ "type":"structure", "required":["IndexName"], "members":{ "IndexName":{ "shape":"ResourceName", "documentation":"

The name of the place index resource.

", "location":"uri", "locationName":"IndexName" } } }, "DescribePlaceIndexResponse":{ "type":"structure", "required":[ "IndexName", "IndexArn", "Description", "CreateTime", "UpdateTime", "DataSource", "DataSourceConfiguration" ], "members":{ "IndexName":{ "shape":"ResourceName", "documentation":"

The name of the place index resource being described.

" }, "IndexArn":{ "shape":"GeoArn", "documentation":"

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. Always returns RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The optional description for the place index resource.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "DataSource":{ "shape":"String", "documentation":"

The data provider of geospatial data. Values can be one of the following:

For more information about data providers, see Amazon Location Service data providers.

" }, "DataSourceConfiguration":{ "shape":"DataSourceConfiguration", "documentation":"

The specified data storage option for requesting Places.

" }, "Tags":{ "shape":"TagMap", "documentation":"

Tags associated with place index resource.

" } } }, "DescribeRouteCalculatorRequest":{ "type":"structure", "required":["CalculatorName"], "members":{ "CalculatorName":{ "shape":"ResourceName", "documentation":"

The name of the route calculator resource.

", "location":"uri", "locationName":"CalculatorName" } } }, "DescribeRouteCalculatorResponse":{ "type":"structure", "required":[ "CalculatorName", "CalculatorArn", "Description", "CreateTime", "UpdateTime", "DataSource" ], "members":{ "CalculatorName":{ "shape":"ResourceName", "documentation":"

The name of the route calculator resource being described.

" }, "CalculatorArn":{ "shape":"GeoArn", "documentation":"

The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across Amazon Web Services.

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

Always returns RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The optional description of the route calculator resource.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "DataSource":{ "shape":"String", "documentation":"

The data provider of traffic and road network data. Indicates one of the available providers:

For more information about data providers, see Amazon Location Service data providers.

" }, "Tags":{ "shape":"TagMap", "documentation":"

Tags associated with route calculator resource.

" } } }, "DescribeTrackerRequest":{ "type":"structure", "required":["TrackerName"], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name of the tracker resource.

", "location":"uri", "locationName":"TrackerName" } } }, "DescribeTrackerResponse":{ "type":"structure", "required":[ "TrackerName", "TrackerArn", "Description", "CreateTime", "UpdateTime" ], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name of the tracker resource.

" }, "TrackerArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The optional description for the tracker resource.

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

Always returns RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"

No longer used. Always returns an empty string.

", "deprecated":true, "deprecatedMessage":"Deprecated. Unused.", "deprecatedSince":"2022-02-01" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags associated with the tracker resource.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"

A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource.

" }, "PositionFiltering":{ "shape":"PositionFiltering", "documentation":"

The position filtering method of the tracker resource.

" }, "EventBridgeEnabled":{ "shape":"Boolean", "documentation":"

Whether UPDATE events from this tracker in EventBridge are enabled. If set to true these events will be sent to EventBridge.

" }, "KmsKeyEnableGeospatialQueries":{ "shape":"Boolean", "documentation":"

Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

This parameter is only used if you are using a KMS customer managed key.

If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.

You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.

" } } }, "DevicePosition":{ "type":"structure", "required":[ "SampleTime", "ReceivedTime", "Position" ], "members":{ "DeviceId":{ "shape":"Id", "documentation":"

The device whose position you retrieved.

" }, "SampleTime":{ "shape":"Timestamp", "documentation":"

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "ReceivedTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "Position":{ "shape":"Position", "documentation":"

The last known device position.

" }, "Accuracy":{ "shape":"PositionalAccuracy", "documentation":"

The accuracy of the device position.

" }, "PositionProperties":{ "shape":"PositionPropertyMap", "documentation":"

The properties associated with the position.

" } }, "documentation":"

Contains the device position details.

" }, "DevicePositionList":{ "type":"list", "member":{"shape":"DevicePosition"} }, "DevicePositionUpdate":{ "type":"structure", "required":[ "DeviceId", "SampleTime", "Position" ], "members":{ "DeviceId":{ "shape":"Id", "documentation":"

The device associated to the position update.

" }, "SampleTime":{ "shape":"Timestamp", "documentation":"

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

" }, "Position":{ "shape":"Position", "documentation":"

The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].

" }, "Accuracy":{ "shape":"PositionalAccuracy", "documentation":"

The accuracy of the device position.

" }, "PositionProperties":{ "shape":"PositionPropertyMap", "documentation":"

Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.

Format: \"key\" : \"value\"

" } }, "documentation":"

Contains the position update details for a device.

" }, "DeviceState":{ "type":"structure", "required":[ "DeviceId", "SampleTime", "Position" ], "members":{ "DeviceId":{ "shape":"Id", "documentation":"

The device identifier.

" }, "SampleTime":{ "shape":"Timestamp", "documentation":"

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "Position":{ "shape":"Position", "documentation":"

The last known device position.

" }, "Accuracy":{"shape":"PositionalAccuracy"}, "Ipv4Address":{ "shape":"DeviceStateIpv4AddressString", "documentation":"

The device's Ipv4 address.

" }, "WiFiAccessPoints":{ "shape":"WiFiAccessPointList", "documentation":"

The Wi-Fi access points the device is using.

" }, "CellSignals":{ "shape":"CellSignals", "documentation":"

The cellular network infrastructure that the device is connected to.

" } }, "documentation":"

The device's position, IP address, and Wi-Fi access points.

" }, "DeviceStateIpv4AddressString":{ "type":"string", "pattern":"(?:(?:25[0-5]|(?:2[0-4]|1\\d|[0-9]|)\\d)\\.?\\b){4}" }, "DimensionUnit":{ "type":"string", "enum":[ "Meters", "Feet" ] }, "DisassociateTrackerConsumerRequest":{ "type":"structure", "required":[ "TrackerName", "ConsumerArn" ], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name of the tracker resource to be dissociated from the consumer.

", "location":"uri", "locationName":"TrackerName" }, "ConsumerArn":{ "shape":"Arn", "documentation":"

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 Amazon Web Services.

", "location":"uri", "locationName":"ConsumerArn" } } }, "DisassociateTrackerConsumerResponse":{ "type":"structure", "members":{} }, "DistanceUnit":{ "type":"string", "enum":[ "Kilometers", "Miles" ] }, "Double":{ "type":"double", "box":true }, "Earfcn":{ "type":"integer", "max":262143, "min":0 }, "EutranCellId":{ "type":"integer", "max":268435455, "min":0 }, "FilterPlaceCategoryList":{ "type":"list", "member":{"shape":"PlaceCategory"}, "max":5, "min":1 }, "ForecastGeofenceEventsDeviceState":{ "type":"structure", "required":["Position"], "members":{ "Position":{ "shape":"Position", "documentation":"

The device's position.

" }, "Speed":{ "shape":"ForecastGeofenceEventsDeviceStateSpeedDouble", "documentation":"

The device's speed.

" } }, "documentation":"

The device's position and speed.

" }, "ForecastGeofenceEventsDeviceStateSpeedDouble":{ "type":"double", "box":true, "min":0 }, "ForecastGeofenceEventsRequest":{ "type":"structure", "required":[ "CollectionName", "DeviceState" ], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The name of the geofence collection.

", "location":"uri", "locationName":"CollectionName" }, "DeviceState":{ "shape":"ForecastGeofenceEventsDeviceState", "documentation":"

Represents the device's state, including its current position and speed. When speed is omitted, this API performs a containment check. The containment check operation returns IDLE events for geofences where the device is currently inside of, but no other events.

" }, "TimeHorizonMinutes":{ "shape":"ForecastGeofenceEventsRequestTimeHorizonMinutesDouble", "documentation":"

The forward-looking time window for forecasting, specified in minutes. The API only returns events that are predicted to occur within this time horizon. When no value is specified, this API performs a containment check. The containment check operation returns IDLE events for geofences where the device is currently inside of, but no other events.

" }, "DistanceUnit":{ "shape":"DistanceUnit", "documentation":"

The distance unit used for the NearestDistance property returned in a forecasted event. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: Kilometers

" }, "SpeedUnit":{ "shape":"SpeedUnit", "documentation":"

The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: KilometersPerHour.

" }, "NextToken":{ "shape":"LargeToken", "documentation":"

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

" }, "MaxResults":{ "shape":"ForecastGeofenceEventsRequestMaxResultsInteger", "documentation":"

An optional limit for the number of resources returned in a single call.

Default value: 20

" } } }, "ForecastGeofenceEventsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":20, "min":1 }, "ForecastGeofenceEventsRequestTimeHorizonMinutesDouble":{ "type":"double", "box":true, "min":0 }, "ForecastGeofenceEventsResponse":{ "type":"structure", "required":[ "ForecastedEvents", "DistanceUnit", "SpeedUnit" ], "members":{ "ForecastedEvents":{ "shape":"ForecastedEventsList", "documentation":"

The list of forecasted events.

" }, "NextToken":{ "shape":"LargeToken", "documentation":"

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.

" }, "DistanceUnit":{ "shape":"DistanceUnit", "documentation":"

The distance unit for the forecasted events.

" }, "SpeedUnit":{ "shape":"SpeedUnit", "documentation":"

The speed unit for the forecasted events.

" } } }, "ForecastedEvent":{ "type":"structure", "required":[ "EventId", "GeofenceId", "IsDeviceInGeofence", "NearestDistance", "EventType" ], "members":{ "EventId":{ "shape":"Uuid", "documentation":"

The forecasted event identifier.

" }, "GeofenceId":{ "shape":"Id", "documentation":"

The geofence identifier pertaining to the forecasted event.

" }, "IsDeviceInGeofence":{ "shape":"Boolean", "documentation":"

Indicates if the device is located within the geofence.

" }, "NearestDistance":{ "shape":"NearestDistance", "documentation":"

The closest distance from the device's position to the geofence.

" }, "EventType":{ "shape":"ForecastedGeofenceEventType", "documentation":"

The event type, forecasting three states for which a device can be in relative to a geofence:

ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

IDLE: If a device is inside of a geofence, and the device is not moving.

" }, "ForecastedBreachTime":{ "shape":"Timestamp", "documentation":"

The forecasted time the device will breach the geofence in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

" }, "GeofenceProperties":{ "shape":"PropertyMap", "documentation":"

The geofence properties.

" } }, "documentation":"

A forecasted event represents a geofence event in relation to the requested device state, that may occur given the provided device state and time horizon.

" }, "ForecastedEventsList":{ "type":"list", "member":{"shape":"ForecastedEvent"} }, "ForecastedGeofenceEventType":{ "type":"string", "enum":[ "ENTER", "EXIT", "IDLE" ] }, "GeoArn":{ "type":"string", "max":1600, "min":0, "pattern":"arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))" }, "GeoArnV2":{ "type":"string", "max":1600, "min":0, "pattern":".*(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$)|(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):(geo-routes|geo-places|geo-maps)(:((\\*)|([a-z0-9]+([.-][a-z0-9]+)*)))::((provider[\\/][*-._\\w]+))$).*" }, "GeofenceGeometry":{ "type":"structure", "members":{ "Polygon":{ "shape":"GeofenceGeometryPolygonList", "documentation":"

A Polygon is a list of up to 250 linear rings which represent the shape of a geofence. This list must include 1 exterior ring (representing the outer perimeter of the geofence), and can optionally include up to 249 interior rings (representing polygonal spaces within the perimeter, which are excluded from the geofence area).

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 represented as an array of doubles of length 2: [longitude, latitude].

Each linear ring is represented as an array of arrays of doubles ([[longitude, latitude], [longitude, latitude], ...]). The vertices for the exterior ring must be listed in counter-clockwise sequence. Vertices for all interior rings must be listed in clockwise sequence.

The list of linear rings that describe the entire Polygon is represented as an array of arrays of arrays of doubles ([[[longitude, latitude], [longitude, latitude], ...], [[longitude, latitude], [longitude, latitude], ...], ...]). The exterior ring must be listed first, before any interior rings.

The following additional requirements and limitations apply to geometries defined using the Polygon parameter:

" }, "Circle":{ "shape":"Circle", "documentation":"

A circle on the earth, as defined by a center point and a radius.

" }, "Geobuf":{ "shape":"Base64EncodedGeobuf", "documentation":"

Geobuf is a compact binary encoding for geographic data that provides lossless compression of GeoJSON polygons. The Geobuf must be Base64-encoded.

This parameter can contain a Geobuf-encoded GeoJSON geometry object of type Polygon OR MultiPolygon. For more information and specific configuration requirements for these object types, see Polygon and MultiPolygon.

The following limitations apply specifically to geometries defined using the Geobuf parameter, and supercede the corresponding limitations of the Polygon and MultiPolygon parameters:

" }, "MultiPolygon":{ "shape":"GeofenceGeometryMultiPolygonList", "documentation":"

A MultiPolygon is a list of up to 250 Polygon elements which represent the shape of a geofence. The Polygon components of a MultiPolygon geometry can define separate geographical areas that are considered part of the same geofence, perimeters of larger exterior areas with smaller interior spaces that are excluded from the geofence, or some combination of these use cases to form complex geofence boundaries.

For more information and specific configuration requirements for the Polygon components that form a MultiPolygon, see Polygon.

The following additional requirements and limitations apply to geometries defined using the MultiPolygon parameter:

" } }, "documentation":"

Contains the geofence geometry details.

A geofence geometry can be a circle, a polygon, or a multipolygon. Polygon and MultiPolygon geometries can be defined using their respective parameters, or encoded in Geobuf format using the Geobuf parameter. Including multiple geometry types in the same request will return a validation error.

Amazon Location doesn't currently support polygons that cross the antimeridian.

" }, "GeofenceGeometryMultiPolygonList":{ "type":"list", "member":{"shape":"LinearRings"}, "max":250, "min":1 }, "GeofenceGeometryPolygonList":{ "type":"list", "member":{"shape":"LinearRing"}, "max":250, "min":1 }, "GetDevicePositionHistoryRequest":{ "type":"structure", "required":[ "TrackerName", "DeviceId" ], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The tracker resource receiving the request for the device position history.

", "location":"uri", "locationName":"TrackerName" }, "DeviceId":{ "shape":"Id", "documentation":"

The device whose position history you want to retrieve.

", "location":"uri", "locationName":"DeviceId" }, "NextToken":{ "shape":"Token", "documentation":"

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

" }, "StartTimeInclusive":{ "shape":"Timestamp", "documentation":"

Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.

Requirement:

" }, "EndTimeExclusive":{ "shape":"Timestamp", "documentation":"

Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.

Requirement:

" }, "MaxResults":{ "shape":"GetDevicePositionHistoryRequestMaxResultsInteger", "documentation":"

An optional limit for the number of device positions returned in a single call.

Default value: 100

" } } }, "GetDevicePositionHistoryRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "GetDevicePositionHistoryResponse":{ "type":"structure", "required":["DevicePositions"], "members":{ "DevicePositions":{ "shape":"DevicePositionList", "documentation":"

Contains the position history details for the requested device.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "GetDevicePositionRequest":{ "type":"structure", "required":[ "TrackerName", "DeviceId" ], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The tracker resource receiving the position update.

", "location":"uri", "locationName":"TrackerName" }, "DeviceId":{ "shape":"Id", "documentation":"

The device whose position you want to retrieve.

", "location":"uri", "locationName":"DeviceId" } } }, "GetDevicePositionResponse":{ "type":"structure", "required":[ "SampleTime", "ReceivedTime", "Position" ], "members":{ "DeviceId":{ "shape":"Id", "documentation":"

The device whose position you retrieved.

" }, "SampleTime":{ "shape":"Timestamp", "documentation":"

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "ReceivedTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the tracker resource received the device position. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "Position":{ "shape":"Position", "documentation":"

The last known device position.

" }, "Accuracy":{ "shape":"PositionalAccuracy", "documentation":"

The accuracy of the device position.

" }, "PositionProperties":{ "shape":"PositionPropertyMap", "documentation":"

The properties associated with the position.

" } } }, "GetGeofenceRequest":{ "type":"structure", "required":[ "CollectionName", "GeofenceId" ], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The geofence collection storing the target geofence.

", "location":"uri", "locationName":"CollectionName" }, "GeofenceId":{ "shape":"Id", "documentation":"

The geofence you're retrieving details for.

", "location":"uri", "locationName":"GeofenceId" } } }, "GetGeofenceResponse":{ "type":"structure", "required":[ "GeofenceId", "Geometry", "Status", "CreateTime", "UpdateTime" ], "members":{ "GeofenceId":{ "shape":"Id", "documentation":"

The geofence identifier.

" }, "Geometry":{ "shape":"GeofenceGeometry", "documentation":"

Contains the geofence geometry details describing the position of the geofence. Can be a circle, a polygon, or a multipolygon.

" }, "Status":{ "shape":"String", "documentation":"

Identifies the state of the geofence. A geofence will hold one of the following states:

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "GeofenceProperties":{ "shape":"PropertyMap", "documentation":"

User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: \"key\" : \"value\"

" } } }, "GetMapGlyphsRequest":{ "type":"structure", "required":[ "MapName", "FontStack", "FontUnicodeRange" ], "members":{ "MapName":{ "shape":"ResourceName", "documentation":"

The map resource associated with the glyph file.

", "location":"uri", "locationName":"MapName" }, "FontStack":{ "shape":"String", "documentation":"

A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode.

Valid font stacks for Esri styles:

Valid font stacks for HERE Technologies styles:

Valid font stacks for GrabMaps styles:

Valid font stacks for Open Data styles:

The fonts used by the Open Data map styles are combined fonts that use Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember.

", "location":"uri", "locationName":"FontStack" }, "FontUnicodeRange":{ "shape":"GetMapGlyphsRequestFontUnicodeRangeString", "documentation":"

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.

", "location":"uri", "locationName":"FontUnicodeRange" }, "Key":{ "shape":"ApiKey", "documentation":"

The optional API key to authorize the request.

", "location":"querystring", "locationName":"key" } } }, "GetMapGlyphsRequestFontUnicodeRangeString":{ "type":"string", "pattern":"[0-9]+-[0-9]+\\.pbf" }, "GetMapGlyphsResponse":{ "type":"structure", "members":{ "Blob":{ "shape":"Blob", "documentation":"

The glyph, as binary blob.

" }, "ContentType":{ "shape":"String", "documentation":"

The map glyph content type. For example, application/octet-stream.

", "location":"header", "locationName":"Content-Type" }, "CacheControl":{ "shape":"String", "documentation":"

The HTTP Cache-Control directive for the value.

", "location":"header", "locationName":"Cache-Control" } }, "payload":"Blob" }, "GetMapSpritesRequest":{ "type":"structure", "required":[ "MapName", "FileName" ], "members":{ "MapName":{ "shape":"ResourceName", "documentation":"

The map resource associated with the sprite file.

", "location":"uri", "locationName":"MapName" }, "FileName":{ "shape":"GetMapSpritesRequestFileNameString", "documentation":"

The name of the sprite file. Use the following file names for the sprite sheet:

For the JSON document containing image offsets. Use the following file names:

", "location":"uri", "locationName":"FileName" }, "Key":{ "shape":"ApiKey", "documentation":"

The optional API key to authorize the request.

", "location":"querystring", "locationName":"key" } } }, "GetMapSpritesRequestFileNameString":{ "type":"string", "pattern":"sprites(@2x)?\\.(png|json)" }, "GetMapSpritesResponse":{ "type":"structure", "members":{ "Blob":{ "shape":"Blob", "documentation":"

Contains the body of the sprite sheet or JSON offset file.

" }, "ContentType":{ "shape":"String", "documentation":"

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.

", "location":"header", "locationName":"Content-Type" }, "CacheControl":{ "shape":"String", "documentation":"

The HTTP Cache-Control directive for the value.

", "location":"header", "locationName":"Cache-Control" } }, "payload":"Blob" }, "GetMapStyleDescriptorRequest":{ "type":"structure", "required":["MapName"], "members":{ "MapName":{ "shape":"ResourceName", "documentation":"

The map resource to retrieve the style descriptor from.

", "location":"uri", "locationName":"MapName" }, "Key":{ "shape":"ApiKey", "documentation":"

The optional API key to authorize the request.

", "location":"querystring", "locationName":"key" } } }, "GetMapStyleDescriptorResponse":{ "type":"structure", "members":{ "Blob":{ "shape":"Blob", "documentation":"

Contains the body of the style descriptor.

" }, "ContentType":{ "shape":"String", "documentation":"

The style descriptor's content type. For example, application/json.

", "location":"header", "locationName":"Content-Type" }, "CacheControl":{ "shape":"String", "documentation":"

The HTTP Cache-Control directive for the value.

", "location":"header", "locationName":"Cache-Control" } }, "payload":"Blob" }, "GetMapTileRequest":{ "type":"structure", "required":[ "MapName", "Z", "X", "Y" ], "members":{ "MapName":{ "shape":"ResourceName", "documentation":"

The map resource to retrieve the map tiles from.

", "location":"uri", "locationName":"MapName" }, "Z":{ "shape":"GetMapTileRequestZString", "documentation":"

The zoom value for the map tile.

", "location":"uri", "locationName":"Z" }, "X":{ "shape":"GetMapTileRequestXString", "documentation":"

The X axis value for the map tile.

", "location":"uri", "locationName":"X" }, "Y":{ "shape":"GetMapTileRequestYString", "documentation":"

The Y axis value for the map tile.

", "location":"uri", "locationName":"Y" }, "Key":{ "shape":"ApiKey", "documentation":"

The optional API key to authorize the request.

", "location":"querystring", "locationName":"key" } } }, "GetMapTileRequestXString":{ "type":"string", "pattern":".*\\d+.*", "sensitive":true }, "GetMapTileRequestYString":{ "type":"string", "pattern":".*\\d+.*", "sensitive":true }, "GetMapTileRequestZString":{ "type":"string", "pattern":".*\\d+.*", "sensitive":true }, "GetMapTileResponse":{ "type":"structure", "members":{ "Blob":{ "shape":"Blob", "documentation":"

Contains Mapbox Vector Tile (MVT) data.

" }, "ContentType":{ "shape":"String", "documentation":"

The map tile's content type. For example, application/vnd.mapbox-vector-tile.

", "location":"header", "locationName":"Content-Type" }, "CacheControl":{ "shape":"String", "documentation":"

The HTTP Cache-Control directive for the value.

", "location":"header", "locationName":"Cache-Control" } }, "payload":"Blob" }, "GetPlaceRequest":{ "type":"structure", "required":[ "IndexName", "PlaceId" ], "members":{ "IndexName":{ "shape":"ResourceName", "documentation":"

The name of the place index resource that you want to use for the search.

", "location":"uri", "locationName":"IndexName" }, "PlaceId":{ "shape":"PlaceId", "documentation":"

The identifier of the place to find.

", "location":"uri", "locationName":"PlaceId" }, "Language":{ "shape":"LanguageTag", "documentation":"

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

", "location":"querystring", "locationName":"language" }, "Key":{ "shape":"ApiKey", "documentation":"

The optional API key to authorize the request.

", "location":"querystring", "locationName":"key" } } }, "GetPlaceResponse":{ "type":"structure", "required":["Place"], "members":{ "Place":{ "shape":"Place", "documentation":"

Details about the result, such as its address and position.

" } } }, "Id":{ "type":"string", "max":100, "min":1, "pattern":"[-._\\p{L}\\p{N}]+" }, "InferredState":{ "type":"structure", "required":["ProxyDetected"], "members":{ "Position":{ "shape":"Position", "documentation":"

The device position inferred by the provided position, IP address, cellular signals, and Wi-Fi- access points.

" }, "Accuracy":{ "shape":"PositionalAccuracy", "documentation":"

The level of certainty of the inferred position.

" }, "DeviationDistance":{ "shape":"Double", "documentation":"

The distance between the inferred position and the device's self-reported position.

" }, "ProxyDetected":{ "shape":"Boolean", "documentation":"

Indicates if a proxy was used.

" } }, "documentation":"

The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points.

" }, "Integer":{ "type":"integer", "box":true }, "IntendedUse":{ "type":"string", "enum":[ "SingleUse", "Storage" ] }, "InternalServerException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"

The request has failed to process because of an unknown server error, exception, or failure.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "KmsKeyId":{ "type":"string", "max":2048, "min":1 }, "LanguageTag":{ "type":"string", "max":35, "min":2 }, "LargeToken":{ "type":"string", "max":60000, "min":1 }, "Leg":{ "type":"structure", "required":[ "StartPosition", "EndPosition", "Distance", "DurationSeconds", "Steps" ], "members":{ "StartPosition":{ "shape":"Position", "documentation":"

The starting position of the leg. Follows the format [longitude,latitude].

If the StartPosition isn't located on a road, it's snapped to a nearby road.

" }, "EndPosition":{ "shape":"Position", "documentation":"

The terminating position of the leg. Follows the format [longitude,latitude].

If the EndPosition isn't located on a road, it's snapped to a nearby road.

" }, "Distance":{ "shape":"LegDistanceDouble", "documentation":"

The distance between the leg's StartPosition and EndPosition along a calculated route.

" }, "DurationSeconds":{ "shape":"LegDurationSecondsDouble", "documentation":"

The estimated travel time between the leg's StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.

" }, "Geometry":{ "shape":"LegGeometry", "documentation":"

Contains the calculated route's path as a linestring geometry.

" }, "Steps":{ "shape":"StepList", "documentation":"

Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.

" } }, "documentation":"

Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

" }, "LegDistanceDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "LegDurationSecondsDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "LegGeometry":{ "type":"structure", "members":{ "LineString":{ "shape":"LineString", "documentation":"

An ordered list of positions used to plot a route on a map.

The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.

" } }, "documentation":"

Contains the geometry details for each path between a pair of positions. Used in plotting a route leg on a map.

" }, "LegList":{ "type":"list", "member":{"shape":"Leg"} }, "LineString":{ "type":"list", "member":{"shape":"Position"}, "min":2 }, "LinearRing":{ "type":"list", "member":{"shape":"Position"}, "min":4 }, "LinearRings":{ "type":"list", "member":{"shape":"LinearRing"}, "min":1 }, "ListDevicePositionsRequest":{ "type":"structure", "required":["TrackerName"], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The tracker resource containing the requested devices.

", "location":"uri", "locationName":"TrackerName" }, "MaxResults":{ "shape":"ListDevicePositionsRequestMaxResultsInteger", "documentation":"

An optional limit for the number of entries returned in a single call.

Default value: 100

" }, "NextToken":{ "shape":"Token", "documentation":"

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

" }, "FilterGeometry":{ "shape":"TrackingFilterGeometry", "documentation":"

The geometry used to filter device positions.

" } } }, "ListDevicePositionsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListDevicePositionsResponse":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"ListDevicePositionsResponseEntryList", "documentation":"

Contains details about each device's last known position.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "ListDevicePositionsResponseEntry":{ "type":"structure", "required":[ "DeviceId", "SampleTime", "Position" ], "members":{ "DeviceId":{ "shape":"Id", "documentation":"

The ID of the device for this position.

" }, "SampleTime":{ "shape":"Timestamp", "documentation":"

The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "Position":{ "shape":"Position", "documentation":"

The last known device position. Empty if no positions currently stored.

" }, "Accuracy":{ "shape":"PositionalAccuracy", "documentation":"

The accuracy of the device position.

" }, "PositionProperties":{ "shape":"PositionPropertyMap", "documentation":"

The properties associated with the position.

" } }, "documentation":"

Contains the tracker resource details.

" }, "ListDevicePositionsResponseEntryList":{ "type":"list", "member":{"shape":"ListDevicePositionsResponseEntry"} }, "ListGeofenceCollectionsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListGeofenceCollectionsRequestMaxResultsInteger", "documentation":"

An optional limit for the number of resources returned in a single call.

Default value: 100

" }, "NextToken":{ "shape":"Token", "documentation":"

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

" } } }, "ListGeofenceCollectionsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListGeofenceCollectionsResponse":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"ListGeofenceCollectionsResponseEntryList", "documentation":"

Lists the geofence collections that exist in your Amazon Web Services account.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "ListGeofenceCollectionsResponseEntry":{ "type":"structure", "required":[ "CollectionName", "Description", "CreateTime", "UpdateTime" ], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The name of the geofence collection.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The description for the geofence collection

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. Always returns RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"

No longer used. Always returns an empty string.

", "deprecated":true, "deprecatedMessage":"Deprecated. Unused.", "deprecatedSince":"2022-02-01" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } }, "documentation":"

Contains the geofence collection details.

The returned geometry will always match the geometry format used when the geofence was created.

" }, "ListGeofenceCollectionsResponseEntryList":{ "type":"list", "member":{"shape":"ListGeofenceCollectionsResponseEntry"} }, "ListGeofenceResponseEntry":{ "type":"structure", "required":[ "GeofenceId", "Geometry", "Status", "CreateTime", "UpdateTime" ], "members":{ "GeofenceId":{ "shape":"Id", "documentation":"

The geofence identifier.

" }, "Geometry":{ "shape":"GeofenceGeometry", "documentation":"

Contains the geofence geometry details describing the position of the geofence. Can be a circle, a polygon, or a multipolygon.

" }, "Status":{ "shape":"String", "documentation":"

Identifies the state of the geofence. A geofence will hold one of the following states:

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "GeofenceProperties":{ "shape":"PropertyMap", "documentation":"

User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: \"key\" : \"value\"

" } }, "documentation":"

Contains a list of geofences stored in a given geofence collection.

The returned geometry will always match the geometry format used when the geofence was created.

" }, "ListGeofenceResponseEntryList":{ "type":"list", "member":{"shape":"ListGeofenceResponseEntry"} }, "ListGeofencesRequest":{ "type":"structure", "required":["CollectionName"], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The name of the geofence collection storing the list of geofences.

", "location":"uri", "locationName":"CollectionName" }, "NextToken":{ "shape":"LargeToken", "documentation":"

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

" }, "MaxResults":{ "shape":"ListGeofencesRequestMaxResultsInteger", "documentation":"

An optional limit for the number of geofences returned in a single call.

Default value: 100

" } } }, "ListGeofencesRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListGeofencesResponse":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"ListGeofenceResponseEntryList", "documentation":"

Contains a list of geofences stored in the geofence collection.

" }, "NextToken":{ "shape":"LargeToken", "documentation":"

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.

" } } }, "ListKeysRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListKeysRequestMaxResultsInteger", "documentation":"

An optional limit for the number of resources returned in a single call.

Default value: 100

" }, "NextToken":{ "shape":"Token", "documentation":"

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

" }, "Filter":{ "shape":"ApiKeyFilter", "documentation":"

Optionally filter the list to only Active or Expired API keys.

" } } }, "ListKeysRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListKeysResponse":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"ListKeysResponseEntryList", "documentation":"

Contains API key resources in your Amazon Web Services account. Details include API key name, allowed referers and timestamp for when the API key will expire.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "ListKeysResponseEntry":{ "type":"structure", "required":[ "KeyName", "ExpireTime", "Restrictions", "CreateTime", "UpdateTime" ], "members":{ "KeyName":{ "shape":"ResourceName", "documentation":"

The name of the API key resource.

" }, "ExpireTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the API key resource will expire, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The optional description for the API key resource.

" }, "Restrictions":{"shape":"ApiKeyRestrictions"}, "CreateTime":{ "shape":"Timestamp", "documentation":"

The timestamp of when the API key was created, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

The timestamp of when the API key was last updated, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" } }, "documentation":"

An API key resource listed in your Amazon Web Services account.

" }, "ListKeysResponseEntryList":{ "type":"list", "member":{"shape":"ListKeysResponseEntry"} }, "ListMapsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListMapsRequestMaxResultsInteger", "documentation":"

An optional limit for the number of resources returned in a single call.

Default value: 100

" }, "NextToken":{ "shape":"Token", "documentation":"

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

" } } }, "ListMapsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListMapsResponse":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"ListMapsResponseEntryList", "documentation":"

Contains a list of maps in your Amazon Web Services account

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "ListMapsResponseEntry":{ "type":"structure", "required":[ "MapName", "Description", "DataSource", "CreateTime", "UpdateTime" ], "members":{ "MapName":{ "shape":"ResourceName", "documentation":"

The name of the associated map resource.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The description for the map resource.

" }, "DataSource":{ "shape":"String", "documentation":"

Specifies the data provider for the associated map tiles.

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. Always returns RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } }, "documentation":"

Contains details of an existing map resource in your Amazon Web Services account.

" }, "ListMapsResponseEntryList":{ "type":"list", "member":{"shape":"ListMapsResponseEntry"} }, "ListPlaceIndexesRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListPlaceIndexesRequestMaxResultsInteger", "documentation":"

An optional limit for the maximum number of results returned in a single call.

Default value: 100

" }, "NextToken":{ "shape":"Token", "documentation":"

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

" } } }, "ListPlaceIndexesRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListPlaceIndexesResponse":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"ListPlaceIndexesResponseEntryList", "documentation":"

Lists the place index resources that exist in your Amazon Web Services account

" }, "NextToken":{ "shape":"Token", "documentation":"

A pagination token indicating that there are additional pages available. You can use the token in a new request to fetch the next page of results.

" } } }, "ListPlaceIndexesResponseEntry":{ "type":"structure", "required":[ "IndexName", "Description", "DataSource", "CreateTime", "UpdateTime" ], "members":{ "IndexName":{ "shape":"ResourceName", "documentation":"

The name of the place index resource.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The optional description for the place index resource.

" }, "DataSource":{ "shape":"String", "documentation":"

The data provider of geospatial data. Values can be one of the following:

For more information about data providers, see Amazon Location Service data providers.

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. Always returns RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } }, "documentation":"

A place index resource listed in your Amazon Web Services account.

" }, "ListPlaceIndexesResponseEntryList":{ "type":"list", "member":{"shape":"ListPlaceIndexesResponseEntry"} }, "ListRouteCalculatorsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListRouteCalculatorsRequestMaxResultsInteger", "documentation":"

An optional maximum number of results returned in a single call.

Default Value: 100

" }, "NextToken":{ "shape":"Token", "documentation":"

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

" } } }, "ListRouteCalculatorsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListRouteCalculatorsResponse":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"ListRouteCalculatorsResponseEntryList", "documentation":"

Lists the route calculator resources that exist in your Amazon Web Services account

" }, "NextToken":{ "shape":"Token", "documentation":"

A pagination token indicating there are additional pages available. You can use the token in a subsequent request to fetch the next set of results.

" } } }, "ListRouteCalculatorsResponseEntry":{ "type":"structure", "required":[ "CalculatorName", "Description", "DataSource", "CreateTime", "UpdateTime" ], "members":{ "CalculatorName":{ "shape":"ResourceName", "documentation":"

The name of the route calculator resource.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The optional description of the route calculator resource.

" }, "DataSource":{ "shape":"String", "documentation":"

The data provider of traffic and road network data. Indicates one of the available providers:

For more information about data providers, see Amazon Location Service data providers.

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

Always returns RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } }, "documentation":"

A route calculator resource listed in your Amazon Web Services account.

" }, "ListRouteCalculatorsResponseEntryList":{ "type":"list", "member":{"shape":"ListRouteCalculatorsResponseEntry"} }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

", "location":"uri", "locationName":"ResourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagMap", "documentation":"

Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: \"TagKey\" : \"TagValue\".

" } } }, "ListTrackerConsumersRequest":{ "type":"structure", "required":["TrackerName"], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The tracker resource whose associated geofence collections you want to list.

", "location":"uri", "locationName":"TrackerName" }, "MaxResults":{ "shape":"ListTrackerConsumersRequestMaxResultsInteger", "documentation":"

An optional limit for the number of resources returned in a single call.

Default value: 100

" }, "NextToken":{ "shape":"Token", "documentation":"

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

" } } }, "ListTrackerConsumersRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListTrackerConsumersResponse":{ "type":"structure", "required":["ConsumerArns"], "members":{ "ConsumerArns":{ "shape":"ArnList", "documentation":"

Contains the list of geofence collection ARNs associated to the tracker resource.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "ListTrackersRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListTrackersRequestMaxResultsInteger", "documentation":"

An optional limit for the number of resources returned in a single call.

Default value: 100

" }, "NextToken":{ "shape":"Token", "documentation":"

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

" } } }, "ListTrackersRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListTrackersResponse":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"ListTrackersResponseEntryList", "documentation":"

Contains tracker resources in your Amazon Web Services account. Details include tracker name, description and timestamps for when the tracker was created and last updated.

" }, "NextToken":{ "shape":"Token", "documentation":"

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.

" } } }, "ListTrackersResponseEntry":{ "type":"structure", "required":[ "TrackerName", "Description", "CreateTime", "UpdateTime" ], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name of the tracker resource.

" }, "Description":{ "shape":"ResourceDescription", "documentation":"

The description for the tracker resource.

" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

Always returns RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"

No longer used. Always returns an empty string.

", "deprecated":true, "deprecatedMessage":"Deprecated. Unused.", "deprecatedSince":"2022-02-01" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" } }, "documentation":"

Contains the tracker resource details.

" }, "ListTrackersResponseEntryList":{ "type":"list", "member":{"shape":"ListTrackersResponseEntry"} }, "LteCellDetails":{ "type":"structure", "required":[ "CellId", "Mcc", "Mnc" ], "members":{ "CellId":{ "shape":"EutranCellId", "documentation":"

The E-UTRAN Cell Identifier (ECI).

" }, "Mcc":{ "shape":"LteCellDetailsMccInteger", "documentation":"

The Mobile Country Code (MCC).

" }, "Mnc":{ "shape":"LteCellDetailsMncInteger", "documentation":"

The Mobile Network Code (MNC)

" }, "LocalId":{ "shape":"LteLocalId", "documentation":"

The LTE local identification information (local ID).

" }, "NetworkMeasurements":{ "shape":"LteCellDetailsNetworkMeasurementsList", "documentation":"

The network measurements.

" }, "TimingAdvance":{ "shape":"LteCellDetailsTimingAdvanceInteger", "documentation":"

Timing Advance (TA).

" }, "NrCapable":{ "shape":"Boolean", "documentation":"

Indicates whether the LTE object is capable of supporting NR (new radio).

" }, "Rsrp":{ "shape":"Rsrp", "documentation":"

Signal power of the reference signal received, measured in decibel-milliwatts (dBm).

" }, "Rsrq":{ "shape":"Rsrq", "documentation":"

Signal quality of the reference Signal received, measured in decibels (dB).

" }, "Tac":{ "shape":"LteCellDetailsTacInteger", "documentation":"

LTE Tracking Area Code (TAC).

" } }, "documentation":"

Details about the Long-Term Evolution (LTE) network.

" }, "LteCellDetailsMccInteger":{ "type":"integer", "box":true, "max":999, "min":200 }, "LteCellDetailsMncInteger":{ "type":"integer", "box":true, "max":999, "min":0 }, "LteCellDetailsNetworkMeasurementsList":{ "type":"list", "member":{"shape":"LteNetworkMeasurements"}, "max":32, "min":1 }, "LteCellDetailsTacInteger":{ "type":"integer", "box":true, "max":65535, "min":0 }, "LteCellDetailsTimingAdvanceInteger":{ "type":"integer", "box":true, "max":1282, "min":0 }, "LteLocalId":{ "type":"structure", "required":[ "Earfcn", "Pci" ], "members":{ "Earfcn":{ "shape":"Earfcn", "documentation":"

E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency channel number (EARFCN).

" }, "Pci":{ "shape":"Pci", "documentation":"

Physical Cell ID (PCI).

" } }, "documentation":"

LTE local identification information (local ID).

" }, "LteNetworkMeasurements":{ "type":"structure", "required":[ "Earfcn", "CellId", "Pci" ], "members":{ "Earfcn":{ "shape":"Earfcn", "documentation":"

E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency channel number (EARFCN).

" }, "CellId":{ "shape":"EutranCellId", "documentation":"

E-UTRAN Cell Identifier (ECI).

" }, "Pci":{ "shape":"Pci", "documentation":"

Physical Cell ID (PCI).

" }, "Rsrp":{ "shape":"Rsrp", "documentation":"

Signal power of the reference signal received, measured in dBm (decibel-milliwatts).

" }, "Rsrq":{ "shape":"Rsrq", "documentation":"

Signal quality of the reference Signal received, measured in decibels (dB).

" } }, "documentation":"

LTE network measurements.

" }, "MapConfiguration":{ "type":"structure", "required":["Style"], "members":{ "Style":{ "shape":"MapStyle", "documentation":"

Specifies the map style selected from an available data provider.

Valid Esri map styles:

Valid HERE Technologies map styles:

Valid GrabMaps map styles:

Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore) Region (ap-southeast-1). For more information, see GrabMaps countries and area covered.

Valid Open Data map styles:

" }, "PoliticalView":{ "shape":"CountryCode3", "documentation":"

Specifies the political view for the style. Leave unset to not use a political view, or, for styles that support specific political views, you can choose a view, such as IND for the Indian view.

Default is unset.

Not all map resources or styles support political view styles. See Political views for more information.

" }, "CustomLayers":{ "shape":"CustomLayerList", "documentation":"

Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI layer for the VectorEsriNavigation style. Default is unset.

Not all map resources or styles support custom layers. See Custom Layers for more information.

" } }, "documentation":"

Specifies the map tile style selected from an available provider.

" }, "MapConfigurationUpdate":{ "type":"structure", "members":{ "PoliticalView":{ "shape":"CountryCode3OrEmpty", "documentation":"

Specifies the political view for the style. Set to an empty string to not use a political view, or, for styles that support specific political views, you can choose a view, such as IND for the Indian view.

Not all map resources or styles support political view styles. See Political views for more information.

" }, "CustomLayers":{ "shape":"CustomLayerList", "documentation":"

Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI layer for the VectorEsriNavigation style. Default is unset.

Not all map resources or styles support custom layers. See Custom Layers for more information.

" } }, "documentation":"

Specifies the political view for the style.

" }, "MapStyle":{ "type":"string", "max":100, "min":1, "pattern":"[-._\\w]+" }, "NearestDistance":{ "type":"double", "min":0 }, "OptimizationMode":{ "type":"string", "enum":[ "FastestRoute", "ShortestRoute" ] }, "Pci":{ "type":"integer", "max":503, "min":0 }, "Place":{ "type":"structure", "required":["Geometry"], "members":{ "Label":{ "shape":"SensitiveString", "documentation":"

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.

" }, "Geometry":{"shape":"PlaceGeometry"}, "AddressNumber":{ "shape":"SensitiveString", "documentation":"

The numerical portion of an address, such as a building number.

" }, "Street":{ "shape":"SensitiveString", "documentation":"

The name for a street or a road to identify a location. For example, Main Street.

" }, "Neighborhood":{ "shape":"SensitiveString", "documentation":"

The name of a community district. For example, Downtown.

" }, "Municipality":{ "shape":"SensitiveString", "documentation":"

A name for a local area, such as a city or town name. For example, Toronto.

" }, "SubRegion":{ "shape":"SensitiveString", "documentation":"

A county, or an area that's part of a larger region. For example, Metro Vancouver.

" }, "Region":{ "shape":"SensitiveString", "documentation":"

A name for an area or geographical division, such as a province or state name. For example, British Columbia.

" }, "Country":{ "shape":"SensitiveString", "documentation":"

A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.

" }, "PostalCode":{ "shape":"SensitiveString", "documentation":"

A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

" }, "Interpolated":{ "shape":"SensitiveBoolean", "documentation":"

True if the result is interpolated from other known places.

False if the Place is a known place.

Not returned when the partner does not provide the information.

For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.

" }, "TimeZone":{ "shape":"TimeZone", "documentation":"

The time zone in which the Place is located. Returned only when using HERE or Grab as the selected partner.

" }, "UnitType":{ "shape":"SensitiveString", "documentation":"

For addresses with a UnitNumber, the type of unit. For example, Apartment.

Returned only for a place index that uses Esri as a data provider.

" }, "UnitNumber":{ "shape":"SensitiveString", "documentation":"

For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123.

Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for SearchPlaceIndexForPosition.

" }, "Categories":{ "shape":"PlaceCategoryList", "documentation":"

The Amazon Location categories that describe this Place.

For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service developer guide.

" }, "SupplementalCategories":{ "shape":"PlaceSupplementalCategoryList", "documentation":"

Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

" }, "SubMunicipality":{ "shape":"SensitiveString", "documentation":"

An area that's part of a larger municipality. For example, Blissville is a submunicipality in the Queen County in New York.

This property supported by Esri and OpenData. The Esri property is district, and the OpenData property is borough.

" } }, "documentation":"

Contains details about addresses or points of interest that match the search criteria.

Not all details are included with all responses. Some details may only be returned by specific data partners.

" }, "PlaceCategory":{ "type":"string", "max":35, "min":0, "sensitive":true }, "PlaceCategoryList":{ "type":"list", "member":{"shape":"PlaceCategory"}, "max":10, "min":1 }, "PlaceGeometry":{ "type":"structure", "members":{ "Point":{ "shape":"Position", "documentation":"

A single point geometry specifies a location for a Place using WGS 84 coordinates:

" } }, "documentation":"

Places uses a point geometry to specify a location or a Place.

" }, "PlaceId":{ "type":"string", "sensitive":true }, "PlaceIndexSearchResultLimit":{ "type":"integer", "box":true, "max":50, "min":1 }, "PlaceSupplementalCategory":{ "type":"string", "max":35, "min":0, "sensitive":true }, "PlaceSupplementalCategoryList":{ "type":"list", "member":{"shape":"PlaceSupplementalCategory"}, "max":10, "min":1 }, "Position":{ "type":"list", "member":{"shape":"Double"}, "max":2, "min":2, "sensitive":true }, "PositionFiltering":{ "type":"string", "enum":[ "TimeBased", "DistanceBased", "AccuracyBased" ] }, "PositionPropertyMap":{ "type":"map", "key":{"shape":"PositionPropertyMapKeyString"}, "value":{"shape":"PositionPropertyMapValueString"}, "max":4, "min":0, "sensitive":true }, "PositionPropertyMapKeyString":{ "type":"string", "max":20, "min":1 }, "PositionPropertyMapValueString":{ "type":"string", "max":150, "min":1 }, "PositionalAccuracy":{ "type":"structure", "required":["Horizontal"], "members":{ "Horizontal":{ "shape":"PositionalAccuracyHorizontalDouble", "documentation":"

Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.

" } }, "documentation":"

Defines the level of certainty of the position.

" }, "PositionalAccuracyHorizontalDouble":{ "type":"double", "box":true, "max":10000000, "min":0, "sensitive":true }, "PricingPlan":{ "type":"string", "enum":[ "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" ] }, "PropertyMap":{ "type":"map", "key":{"shape":"PropertyMapKeyString"}, "value":{"shape":"PropertyMapValueString"}, "max":3, "min":0, "sensitive":true }, "PropertyMapKeyString":{ "type":"string", "max":20, "min":1 }, "PropertyMapValueString":{ "type":"string", "max":40, "min":1 }, "PutGeofenceRequest":{ "type":"structure", "required":[ "CollectionName", "GeofenceId", "Geometry" ], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The geofence collection to store the geofence in.

", "location":"uri", "locationName":"CollectionName" }, "GeofenceId":{ "shape":"Id", "documentation":"

An identifier for the geofence. For example, ExampleGeofence-1.

", "location":"uri", "locationName":"GeofenceId" }, "Geometry":{ "shape":"GeofenceGeometry", "documentation":"

Contains the details to specify the position of the geofence. Can be a circle, a polygon, or a multipolygon. Polygon and MultiPolygon geometries can be defined using their respective parameters, or encoded in Geobuf format using the Geobuf parameter. Including multiple geometry types in the same request will return a validation error.

The geofence Polygon and MultiPolygon formats support a maximum of 1,000 total vertices. The Geobuf format supports a maximum of 100,000 vertices.

" }, "GeofenceProperties":{ "shape":"PropertyMap", "documentation":"

Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: \"key\" : \"value\"

" } } }, "PutGeofenceResponse":{ "type":"structure", "required":[ "GeofenceId", "CreateTime", "UpdateTime" ], "members":{ "GeofenceId":{ "shape":"Id", "documentation":"

The geofence identifier entered in the request.

" }, "CreateTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the geofence was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } } }, "RefererPattern":{ "type":"string", "max":253, "min":0, "pattern":"([\\w!$&()*+,./:;=?@\\x{60}-]|%([\\dA-Fa-f]{2}|[\\dA-Fa-f]?\\*))+", "sensitive":true }, "ResourceDescription":{ "type":"string", "max":1000, "min":0 }, "ResourceName":{ "type":"string", "max":100, "min":1, "pattern":"[-._\\w]+" }, "ResourceNotFoundException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"

The resource that you've entered was not found in your AWS account.

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "RouteMatrix":{ "type":"list", "member":{"shape":"RouteMatrixRow"} }, "RouteMatrixEntry":{ "type":"structure", "members":{ "Distance":{ "shape":"RouteMatrixEntryDistanceDouble", "documentation":"

The total distance of travel for the route.

" }, "DurationSeconds":{ "shape":"RouteMatrixEntryDurationSecondsDouble", "documentation":"

The expected duration of travel for the route.

" }, "Error":{ "shape":"RouteMatrixEntryError", "documentation":"

An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.

" } }, "documentation":"

The result for the calculated route of one DeparturePosition DestinationPosition pair.

" }, "RouteMatrixEntryDistanceDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "RouteMatrixEntryDurationSecondsDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "RouteMatrixEntryError":{ "type":"structure", "required":["Code"], "members":{ "Code":{ "shape":"RouteMatrixErrorCode", "documentation":"

The type of error which occurred for the route calculation.

" }, "Message":{ "shape":"String", "documentation":"

A message about the error that occurred for the route calculation.

" } }, "documentation":"

An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.

The error code can be one of the following:

" }, "RouteMatrixErrorCode":{ "type":"string", "enum":[ "RouteNotFound", "RouteTooLong", "PositionsNotFound", "DestinationPositionNotFound", "DeparturePositionNotFound", "OtherValidationError" ] }, "RouteMatrixRow":{ "type":"list", "member":{"shape":"RouteMatrixEntry"} }, "Rsrp":{ "type":"integer", "box":true, "max":-44, "min":-140 }, "Rsrq":{ "type":"float", "box":true, "max":-3, "min":-19.5 }, "SearchForPositionResult":{ "type":"structure", "required":[ "Place", "Distance" ], "members":{ "Place":{ "shape":"Place", "documentation":"

Details about the search result, such as its address and position.

" }, "Distance":{ "shape":"SearchForPositionResultDistanceDouble", "documentation":"

The distance in meters of a great-circle arc between the query position and the result.

A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

" }, "PlaceId":{ "shape":"PlaceId", "documentation":"

The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

For SearchPlaceIndexForPosition operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.

" } }, "documentation":"

Contains a search result from a position search query that is run on a place index resource.

" }, "SearchForPositionResultDistanceDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "SearchForPositionResultList":{ "type":"list", "member":{"shape":"SearchForPositionResult"} }, "SearchForSuggestionsResult":{ "type":"structure", "required":["Text"], "members":{ "Text":{ "shape":"SensitiveString", "documentation":"

The text of the place suggestion, typically formatted as an address string.

" }, "PlaceId":{ "shape":"PlaceId", "documentation":"

The unique identifier of the Place. You can use this with the GetPlace operation to find the place again later, or to get full information for the Place.

The GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions that generated the Place ID.

For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.

" }, "Categories":{ "shape":"PlaceCategoryList", "documentation":"

The Amazon Location categories that describe the Place.

For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service developer guide.

" }, "SupplementalCategories":{ "shape":"PlaceSupplementalCategoryList", "documentation":"

Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

" } }, "documentation":"

Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

" }, "SearchForSuggestionsResultList":{ "type":"list", "member":{"shape":"SearchForSuggestionsResult"} }, "SearchForTextResult":{ "type":"structure", "required":["Place"], "members":{ "Place":{ "shape":"Place", "documentation":"

Details about the search result, such as its address and position.

" }, "Distance":{ "shape":"SearchForTextResultDistanceDouble", "documentation":"

The distance in meters of a great-circle arc between the bias position specified and the result. Distance will be returned only if a bias position was specified in the query.

A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

" }, "Relevance":{ "shape":"SearchForTextResultRelevanceDouble", "documentation":"

The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.

Returned only when the partner selected is Esri or Grab.

" }, "PlaceId":{ "shape":"PlaceId", "documentation":"

The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

For SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.

" } }, "documentation":"

Contains a search result from a text search query that is run on a place index resource.

" }, "SearchForTextResultDistanceDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "SearchForTextResultList":{ "type":"list", "member":{"shape":"SearchForTextResult"} }, "SearchForTextResultRelevanceDouble":{ "type":"double", "box":true, "max":1, "min":0, "sensitive":true }, "SearchPlaceIndexForPositionRequest":{ "type":"structure", "required":[ "IndexName", "Position" ], "members":{ "IndexName":{ "shape":"ResourceName", "documentation":"

The name of the place index resource you want to use for the search.

", "location":"uri", "locationName":"IndexName" }, "Position":{ "shape":"Position", "documentation":"

Specifies the longitude and latitude of the position to query.

This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847.

" }, "MaxResults":{ "shape":"PlaceIndexSearchResultLimit", "documentation":"

An optional parameter. The maximum number of results returned per request.

Default value: 50

" }, "Language":{ "shape":"LanguageTag", "documentation":"

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

" }, "Key":{ "shape":"ApiKey", "documentation":"

The optional API key to authorize the request.

", "location":"querystring", "locationName":"key" } } }, "SearchPlaceIndexForPositionResponse":{ "type":"structure", "required":[ "Summary", "Results" ], "members":{ "Summary":{ "shape":"SearchPlaceIndexForPositionSummary", "documentation":"

Contains a summary of the request. Echoes the input values for Position, Language, MaxResults, and the DataSource of the place index.

" }, "Results":{ "shape":"SearchForPositionResultList", "documentation":"

Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.

" } } }, "SearchPlaceIndexForPositionSummary":{ "type":"structure", "required":[ "Position", "DataSource" ], "members":{ "Position":{ "shape":"Position", "documentation":"

The position specified in the request.

" }, "MaxResults":{ "shape":"PlaceIndexSearchResultLimit", "documentation":"

Contains the optional result count limit that is specified in the request.

Default value: 50

" }, "DataSource":{ "shape":"String", "documentation":"

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

For more information about data providers, see Amazon Location Service data providers.

" }, "Language":{ "shape":"LanguageTag", "documentation":"

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

" } }, "documentation":"

A summary of the request sent by using SearchPlaceIndexForPosition.

" }, "SearchPlaceIndexForSuggestionsRequest":{ "type":"structure", "required":[ "IndexName", "Text" ], "members":{ "IndexName":{ "shape":"ResourceName", "documentation":"

The name of the place index resource you want to use for the search.

", "location":"uri", "locationName":"IndexName" }, "Text":{ "shape":"SearchPlaceIndexForSuggestionsRequestTextString", "documentation":"

The free-form partial text to use to generate place suggestions. For example, eiffel tow.

" }, "BiasPosition":{ "shape":"Position", "documentation":"

An optional parameter that indicates a preference for place suggestions that are closer to a specified position.

If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

" }, "FilterBBox":{ "shape":"BoundingBox", "documentation":"

An optional parameter that limits the search results by returning only suggestions within a specified bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

" }, "FilterCountries":{ "shape":"CountryCodeList", "documentation":"

An optional parameter that limits the search results by returning only suggestions within the provided list of countries.

" }, "MaxResults":{ "shape":"SearchPlaceIndexForSuggestionsRequestMaxResultsInteger", "documentation":"

An optional parameter. The maximum number of results returned per request.

The default: 5

" }, "Language":{ "shape":"LanguageTag", "documentation":"

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for Athens, Gr to get suggestions with the language parameter set to en. The results found will most likely be returned as Athens, Greece.

If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα, Ελλάδα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

" }, "FilterCategories":{ "shape":"FilterPlaceCategoryList", "documentation":"

A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service developer guide.

" }, "Key":{ "shape":"ApiKey", "documentation":"

The optional API key to authorize the request.

", "location":"querystring", "locationName":"key" } } }, "SearchPlaceIndexForSuggestionsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":15, "min":1 }, "SearchPlaceIndexForSuggestionsRequestTextString":{ "type":"string", "max":200, "min":1, "sensitive":true }, "SearchPlaceIndexForSuggestionsResponse":{ "type":"structure", "required":[ "Summary", "Results" ], "members":{ "Summary":{ "shape":"SearchPlaceIndexForSuggestionsSummary", "documentation":"

Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index.

" }, "Results":{ "shape":"SearchForSuggestionsResultList", "documentation":"

A list of place suggestions that best match the search text.

" } } }, "SearchPlaceIndexForSuggestionsSummary":{ "type":"structure", "required":[ "Text", "DataSource" ], "members":{ "Text":{ "shape":"SensitiveString", "documentation":"

The free-form partial text input specified in the request.

" }, "BiasPosition":{ "shape":"Position", "documentation":"

Contains the coordinates for the optional bias position specified in the request.

This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

" }, "FilterBBox":{ "shape":"BoundingBox", "documentation":"

Contains the coordinates for the optional bounding box specified in the request.

" }, "FilterCountries":{ "shape":"CountryCodeList", "documentation":"

Contains the optional country filter specified in the request.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

Contains the optional result count limit specified in the request.

" }, "DataSource":{ "shape":"String", "documentation":"

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

For more information about data providers, see Amazon Location Service data providers.

" }, "Language":{ "shape":"LanguageTag", "documentation":"

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

" }, "FilterCategories":{ "shape":"FilterPlaceCategoryList", "documentation":"

The optional category filter specified in the request.

" } }, "documentation":"

A summary of the request sent by using SearchPlaceIndexForSuggestions.

" }, "SearchPlaceIndexForTextRequest":{ "type":"structure", "required":[ "IndexName", "Text" ], "members":{ "IndexName":{ "shape":"ResourceName", "documentation":"

The name of the place index resource you want to use for the search.

", "location":"uri", "locationName":"IndexName" }, "Text":{ "shape":"SearchPlaceIndexForTextRequestTextString", "documentation":"

The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.

" }, "BiasPosition":{ "shape":"Position", "documentation":"

An optional parameter that indicates a preference for places that are closer to a specified position.

If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

" }, "FilterBBox":{ "shape":"BoundingBox", "documentation":"

An optional parameter that limits the search results by returning only places that are within the provided bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

" }, "FilterCountries":{ "shape":"CountryCodeList", "documentation":"

An optional parameter that limits the search results by returning only places that are in a specified list of countries.

" }, "MaxResults":{ "shape":"PlaceIndexSearchResultLimit", "documentation":"

An optional parameter. The maximum number of results returned per request.

The default: 50

" }, "Language":{ "shape":"LanguageTag", "documentation":"

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

" }, "FilterCategories":{ "shape":"FilterPlaceCategoryList", "documentation":"

A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service developer guide.

" }, "Key":{ "shape":"ApiKey", "documentation":"

The optional API key to authorize the request.

", "location":"querystring", "locationName":"key" } } }, "SearchPlaceIndexForTextRequestTextString":{ "type":"string", "max":200, "min":1, "sensitive":true }, "SearchPlaceIndexForTextResponse":{ "type":"structure", "required":[ "Summary", "Results" ], "members":{ "Summary":{ "shape":"SearchPlaceIndexForTextSummary", "documentation":"

Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index and the bounding box, ResultBBox, which surrounds the search results.

" }, "Results":{ "shape":"SearchForTextResultList", "documentation":"

A list of Places matching the input text. Each result contains additional information about the specific point of interest.

Not all response properties are included with all responses. Some properties may only be returned by specific data partners.

" } } }, "SearchPlaceIndexForTextSummary":{ "type":"structure", "required":[ "Text", "DataSource" ], "members":{ "Text":{ "shape":"SensitiveString", "documentation":"

The search text specified in the request.

" }, "BiasPosition":{ "shape":"Position", "documentation":"

Contains the coordinates for the optional bias position specified in the request.

This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

" }, "FilterBBox":{ "shape":"BoundingBox", "documentation":"

Contains the coordinates for the optional bounding box specified in the request.

" }, "FilterCountries":{ "shape":"CountryCodeList", "documentation":"

Contains the optional country filter specified in the request.

" }, "MaxResults":{ "shape":"PlaceIndexSearchResultLimit", "documentation":"

Contains the optional result count limit specified in the request.

" }, "ResultBBox":{ "shape":"BoundingBox", "documentation":"

The bounding box that fully contains all search results.

If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

" }, "DataSource":{ "shape":"String", "documentation":"

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

For more information about data providers, see Amazon Location Service data providers.

" }, "Language":{ "shape":"LanguageTag", "documentation":"

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

" }, "FilterCategories":{ "shape":"FilterPlaceCategoryList", "documentation":"

The optional category filter specified in the request.

" } }, "documentation":"

A summary of the request sent by using SearchPlaceIndexForText.

" }, "SensitiveBoolean":{ "type":"boolean", "box":true, "sensitive":true }, "SensitiveDouble":{ "type":"double", "box":true, "sensitive":true }, "SensitiveInteger":{ "type":"integer", "box":true, "sensitive":true }, "SensitiveString":{ "type":"string", "sensitive":true }, "ServiceQuotaExceededException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"

A message with the reason for the service quota exceeded exception error.

", "locationName":"message" } }, "documentation":"

The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.

", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "Sha1CertificateFingerprint":{ "type":"string", "max":59, "min":59, "pattern":"([A-Fa-f0-9]{2}:){19}[A-Fa-f0-9]{2}" }, "SpeedUnit":{ "type":"string", "enum":[ "KilometersPerHour", "MilesPerHour" ] }, "Status":{ "type":"string", "enum":[ "Active", "Expired" ] }, "Step":{ "type":"structure", "required":[ "StartPosition", "EndPosition", "Distance", "DurationSeconds" ], "members":{ "StartPosition":{ "shape":"Position", "documentation":"

The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.

" }, "EndPosition":{ "shape":"Position", "documentation":"

The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.

" }, "Distance":{ "shape":"StepDistanceDouble", "documentation":"

The travel distance between the step's StartPosition and EndPosition.

" }, "DurationSeconds":{ "shape":"StepDurationSecondsDouble", "documentation":"

The estimated travel time, in seconds, from the step's StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.

" }, "GeometryOffset":{ "shape":"StepGeometryOffsetInteger", "documentation":"

Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0.

Included in the response for queries that set IncludeLegGeometry to True.

" } }, "documentation":"

Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg.

" }, "StepDistanceDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "StepDurationSecondsDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "StepGeometryOffsetInteger":{ "type":"integer", "box":true, "min":0 }, "StepList":{ "type":"list", "member":{"shape":"Step"} }, "String":{"type":"string"}, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)" }, "TagKeys":{ "type":"list", "member":{"shape":"String"}, "max":50, "min":1 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource whose tags you want to update.

", "location":"uri", "locationName":"ResourceArn" }, "Tags":{ "shape":"TagMap", "documentation":"

Applies one or more tags to specific resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.

Format: \"key\" : \"value\"

Restrictions:

" } } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)" }, "ThrottlingException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"

The request was denied because of request throttling.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "TimeZone":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"SensitiveString", "documentation":"

The name of the time zone, following the IANA time zone standard. For example, America/Los_Angeles.

" }, "Offset":{ "shape":"SensitiveInteger", "documentation":"

The time zone's offset, in seconds, from UTC.

" } }, "documentation":"

Information about a time zone. Includes the name of the time zone and the offset from UTC in seconds.

" }, "Timestamp":{ "type":"timestamp", "sensitive":true, "timestampFormat":"iso8601" }, "Token":{ "type":"string", "max":2000, "min":1 }, "TrackingFilterGeometry":{ "type":"structure", "members":{ "Polygon":{ "shape":"LinearRings", "documentation":"

The set of arrays which define the polygon. A polygon can have between 4 and 1000 vertices.

" } }, "documentation":"

The geomerty used to filter device positions.

" }, "TravelMode":{ "type":"string", "enum":[ "Car", "Truck", "Walking", "Bicycle", "Motorcycle" ] }, "TruckDimensions":{ "type":"structure", "members":{ "Length":{ "shape":"TruckDimensionsLengthDouble", "documentation":"

The length of the truck.

For routes calculated with a HERE resource, this value must be between 0 and 300 meters.

" }, "Height":{ "shape":"TruckDimensionsHeightDouble", "documentation":"

The height of the truck.

For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

" }, "Width":{ "shape":"TruckDimensionsWidthDouble", "documentation":"

The width of the truck.

For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

" }, "Unit":{ "shape":"DimensionUnit", "documentation":"

Specifies the unit of measurement for the truck dimensions.

Default Value: Meters

" } }, "documentation":"

Contains details about the truck dimensions in the unit of measurement that you specify. Used to filter out roads that can't support or allow the specified dimensions for requests that specify TravelMode as Truck.

" }, "TruckDimensionsHeightDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "TruckDimensionsLengthDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "TruckDimensionsWidthDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "TruckWeight":{ "type":"structure", "members":{ "Total":{ "shape":"TruckWeightTotalDouble", "documentation":"

The total weight of the truck.

" }, "Unit":{ "shape":"VehicleWeightUnit", "documentation":"

The unit of measurement to use for the truck weight.

Default Value: Kilograms

" } }, "documentation":"

Contains details about the truck's weight specifications. Used to avoid roads that can't support or allow the total weight for requests that specify TravelMode as Truck.

" }, "TruckWeightTotalDouble":{ "type":"double", "box":true, "min":0, "sensitive":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource from which you want to remove tags.

", "location":"uri", "locationName":"ResourceArn" }, "TagKeys":{ "shape":"TagKeys", "documentation":"

The list of tag keys to remove from the specified resource.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "UpdateGeofenceCollectionRequest":{ "type":"structure", "required":["CollectionName"], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The name of the geofence collection to update.

", "location":"uri", "locationName":"CollectionName" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. If included, the only allowed value is RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"

This parameter is no longer used.

", "deprecated":true, "deprecatedMessage":"Deprecated. No longer allowed.", "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", "documentation":"

Updates the description for the geofence collection.

" } } }, "UpdateGeofenceCollectionResponse":{ "type":"structure", "required":[ "CollectionName", "CollectionArn", "UpdateTime" ], "members":{ "CollectionName":{ "shape":"ResourceName", "documentation":"

The name of the updated geofence collection.

" }, "CollectionArn":{ "shape":"Arn", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } } }, "UpdateKeyRequest":{ "type":"structure", "required":["KeyName"], "members":{ "KeyName":{ "shape":"ResourceName", "documentation":"

The name of the API key resource to update.

", "location":"uri", "locationName":"KeyName" }, "Description":{ "shape":"ResourceDescription", "documentation":"

Updates the description for the API key resource.

" }, "ExpireTime":{ "shape":"Timestamp", "documentation":"

Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "NoExpiry":{ "shape":"Boolean", "documentation":"

Whether the API key should expire. Set to true to set the API key to have no expiration time.

" }, "ForceUpdate":{ "shape":"Boolean", "documentation":"

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

" }, "Restrictions":{ "shape":"ApiKeyRestrictions", "documentation":"

Updates the API key restrictions for the API key resource.

" } } }, "UpdateKeyResponse":{ "type":"structure", "required":[ "KeyArn", "KeyName", "UpdateTime" ], "members":{ "KeyArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.

" }, "KeyName":{ "shape":"ResourceName", "documentation":"

The name of the API key resource.

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } } }, "UpdateMapRequest":{ "type":"structure", "required":["MapName"], "members":{ "MapName":{ "shape":"ResourceName", "documentation":"

The name of the map resource to update.

", "location":"uri", "locationName":"MapName" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. If included, the only allowed value is RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", "documentation":"

Updates the description for the map resource.

" }, "ConfigurationUpdate":{ "shape":"MapConfigurationUpdate", "documentation":"

Updates the parts of the map configuration that can be updated, including the political view.

" } } }, "UpdateMapResponse":{ "type":"structure", "required":[ "MapName", "MapArn", "UpdateTime" ], "members":{ "MapName":{ "shape":"ResourceName", "documentation":"

The name of the updated map resource.

" }, "MapArn":{ "shape":"GeoArn", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } } }, "UpdatePlaceIndexRequest":{ "type":"structure", "required":["IndexName"], "members":{ "IndexName":{ "shape":"ResourceName", "documentation":"

The name of the place index resource to update.

", "location":"uri", "locationName":"IndexName" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. If included, the only allowed value is RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", "documentation":"

Updates the description for the place index resource.

" }, "DataSourceConfiguration":{ "shape":"DataSourceConfiguration", "documentation":"

Updates the data storage option for the place index resource.

" } } }, "UpdatePlaceIndexResponse":{ "type":"structure", "required":[ "IndexName", "IndexArn", "UpdateTime" ], "members":{ "IndexName":{ "shape":"ResourceName", "documentation":"

The name of the updated place index resource.

" }, "IndexArn":{ "shape":"GeoArn", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } } }, "UpdateRouteCalculatorRequest":{ "type":"structure", "required":["CalculatorName"], "members":{ "CalculatorName":{ "shape":"ResourceName", "documentation":"

The name of the route calculator resource to update.

", "location":"uri", "locationName":"CalculatorName" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. If included, the only allowed value is RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", "documentation":"

Updates the description for the route calculator resource.

" } } }, "UpdateRouteCalculatorResponse":{ "type":"structure", "required":[ "CalculatorName", "CalculatorArn", "UpdateTime" ], "members":{ "CalculatorName":{ "shape":"ResourceName", "documentation":"

The name of the updated route calculator resource.

" }, "CalculatorArn":{ "shape":"GeoArn", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } } }, "UpdateTrackerRequest":{ "type":"structure", "required":["TrackerName"], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name of the tracker resource to update.

", "location":"uri", "locationName":"TrackerName" }, "PricingPlan":{ "shape":"PricingPlan", "documentation":"

No longer used. If included, the only allowed value is RequestBasedUsage.

", "deprecated":true, "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"

This parameter is no longer used.

", "deprecated":true, "deprecatedMessage":"Deprecated. No longer allowed.", "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", "documentation":"

Updates the description for the tracker resource.

" }, "PositionFiltering":{ "shape":"PositionFiltering", "documentation":"

Updates the position filtering for the tracker resource.

Valid values:

" }, "EventBridgeEnabled":{ "shape":"Boolean", "documentation":"

Whether to enable position UPDATE events from this tracker to be sent to EventBridge.

You do not need enable this feature to get ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.

" }, "KmsKeyEnableGeospatialQueries":{ "shape":"Boolean", "documentation":"

Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

This parameter is only used if you are using a KMS customer managed key.

" } } }, "UpdateTrackerResponse":{ "type":"structure", "required":[ "TrackerName", "TrackerArn", "UpdateTime" ], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name of the updated tracker resource.

" }, "TrackerArn":{ "shape":"Arn", "documentation":"

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

" }, "UpdateTime":{ "shape":"Timestamp", "documentation":"

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

" } } }, "Uuid":{ "type":"string", "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" }, "ValidationException":{ "type":"structure", "required":[ "Message", "Reason", "FieldList" ], "members":{ "Message":{ "shape":"String", "locationName":"message" }, "Reason":{ "shape":"ValidationExceptionReason", "documentation":"

A message with the reason for the validation exception error.

", "locationName":"reason" }, "FieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"

The field where the invalid entry was detected.

", "locationName":"fieldList" } }, "documentation":"

The input failed to meet the constraints specified by the AWS service.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "Name", "Message" ], "members":{ "Name":{ "shape":"String", "documentation":"

The field name where the invalid entry was detected.

", "locationName":"name" }, "Message":{ "shape":"String", "documentation":"

A message with the reason for the validation exception error.

", "locationName":"message" } }, "documentation":"

The input failed to meet the constraints specified by the AWS service in a specified field.

" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "UnknownOperation", "Missing", "CannotParse", "FieldValidationFailed", "Other", "UnknownField" ] }, "VehicleWeightUnit":{ "type":"string", "enum":[ "Kilograms", "Pounds" ] }, "VerifyDevicePositionRequest":{ "type":"structure", "required":[ "TrackerName", "DeviceState" ], "members":{ "TrackerName":{ "shape":"ResourceName", "documentation":"

The name of the tracker resource to be associated with verification request.

", "location":"uri", "locationName":"TrackerName" }, "DeviceState":{ "shape":"DeviceState", "documentation":"

The device's state, including position, IP address, cell signals and Wi-Fi access points.

" }, "DistanceUnit":{ "shape":"DistanceUnit", "documentation":"

The distance unit for the verification request.

Default Value: Kilometers

" } } }, "VerifyDevicePositionResponse":{ "type":"structure", "required":[ "InferredState", "DeviceId", "SampleTime", "ReceivedTime", "DistanceUnit" ], "members":{ "InferredState":{ "shape":"InferredState", "documentation":"

The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points.

" }, "DeviceId":{ "shape":"Id", "documentation":"

The device identifier.

" }, "SampleTime":{ "shape":"Timestamp", "documentation":"

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "ReceivedTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

" }, "DistanceUnit":{ "shape":"DistanceUnit", "documentation":"

The distance unit for the verification response.

" } } }, "WiFiAccessPoint":{ "type":"structure", "required":[ "MacAddress", "Rss" ], "members":{ "MacAddress":{ "shape":"WiFiAccessPointMacAddressString", "documentation":"

Medium access control address (Mac).

" }, "Rss":{ "shape":"WiFiAccessPointRssInteger", "documentation":"

Received signal strength (dBm) of the WLAN measurement data.

" } }, "documentation":"

Wi-Fi access point.

" }, "WiFiAccessPointList":{ "type":"list", "member":{"shape":"WiFiAccessPoint"} }, "WiFiAccessPointMacAddressString":{ "type":"string", "max":17, "min":12, "pattern":"([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})" }, "WiFiAccessPointRssInteger":{ "type":"integer", "box":true, "max":0, "min":-128 } }, "documentation":"

\"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing\"

" }