5.0.0 • Published 5 years ago

@datafire/amazonaws_location v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/amazonaws_location

Client library for Amazon Location Service

Installation and Usage

npm install --save @datafire/amazonaws_location
let amazonaws_location = require('@datafire/amazonaws_location').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Suite of geospatial services including Maps, Places, Tracking, and Geofencing

Actions

CreateGeofenceCollection

amazonaws_location.CreateGeofenceCollection({
  "CollectionName": "",
  "PricingPlan": ""
}, context)

Input

  • input object
    • CollectionName required string: A custom name for the geofence collection. Requirements: Contain only alphanumeric characters (A–Z, a–z, 0-9), hyphens (-), and underscores (_). Must be a unique geofence collection name. No spaces allowed. For example, ExampleGeofenceCollection.
    • Description string: An optional description for the geofence collection.
    • PricingPlan required string (values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement): Specifies the pricing plan for your geofence collection. There's three pricing plan options: RequestBasedUsage — Selects the "Request-Based Usage" pricing plan. MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan. MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

Output

DeleteGeofenceCollection

amazonaws_location.DeleteGeofenceCollection({
  "CollectionName": ""
}, context)

Input

  • input object
    • CollectionName required string

Output

DescribeGeofenceCollection

amazonaws_location.DescribeGeofenceCollection({
  "CollectionName": ""
}, context)

Input

  • input object
    • CollectionName required string

Output

BatchDeleteGeofence

amazonaws_location.BatchDeleteGeofence({
  "CollectionName": "",
  "GeofenceIds": []
}, context)

Input

  • input object
    • CollectionName required string
    • GeofenceIds required array: The batch of geofences to be deleted.

Output

GetGeofence

amazonaws_location.GetGeofence({
  "CollectionName": "",
  "GeofenceId": ""
}, context)

Input

  • input object
    • CollectionName required string
    • GeofenceId required string

Output

PutGeofence

amazonaws_location.PutGeofence({
  "CollectionName": "",
  "GeofenceId": "",
  "Geometry": {}
}, context)

Input

  • input object
    • CollectionName required string
    • GeofenceId required string
    • Geometry required object: Contains the geofence geometry details. Limitation — Amazon Location does not currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian.

Output

ListGeofences

amazonaws_location.ListGeofences({
  "CollectionName": ""
}, context)

Input

  • input object
    • CollectionName required string
    • NextToken string
    • NextToken string: The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: null

Output

BatchEvaluateGeofences

amazonaws_location.BatchEvaluateGeofences({
  "CollectionName": "",
  "DevicePositionUpdates": []
}, context)

Input

  • input object
    • CollectionName required string
    • DevicePositionUpdates required array: Contains device details for each device to be evaluated against the given geofence collection.

Output

BatchPutGeofence

amazonaws_location.BatchPutGeofence({
  "CollectionName": "",
  "Entries": []
}, context)

Input

  • input object
    • CollectionName required string
    • Entries required array: The batch of geofences to be stored in a geofence collection.

Output

ListGeofenceCollections

amazonaws_location.ListGeofenceCollections({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults integer: An optional limit for the number of resources returned in a single call. Default value: 100
    • NextToken string: The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: null

Output

ListMaps

amazonaws_location.ListMaps({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults integer: An optional limit for the number of resources returned in a single call. Default value: 100
    • NextToken string: The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: null

Output

CreateMap

amazonaws_location.CreateMap({
  "Configuration": {},
  "MapName": "",
  "PricingPlan": ""
}, context)

Input

  • input object
    • Configuration required object: Specifies the map tile style selected from an available provider.
      • Style
    • Description string: An optional description for the map resource.
    • MapName required string: The name for the map resource. Requirements: Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), and underscores (_). Must be a unique map resource name. No spaces allowed. For example, ExampleMap.
    • PricingPlan required string (values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement): Specifies the pricing plan for your map resource. There's three pricing plan options: RequestBasedUsage — Selects the "Request-Based Usage" pricing plan. MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan. MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

Output

DeleteMap

amazonaws_location.DeleteMap({
  "MapName": ""
}, context)

Input

  • input object
    • MapName required string

Output

DescribeMap

amazonaws_location.DescribeMap({
  "MapName": ""
}, context)

Input

  • input object
    • MapName required string

Output

GetMapGlyphs

amazonaws_location.GetMapGlyphs({
  "FontStack": "",
  "FontUnicodeRange": "",
  "MapName": ""
}, context)

Input

  • input object
    • FontStack required string
    • FontUnicodeRange required string
    • MapName required string

Output

GetMapSprites

amazonaws_location.GetMapSprites({
  "FileName": "",
  "MapName": ""
}, context)

Input

  • input object
    • FileName required string
    • MapName required string

Output

GetMapStyleDescriptor

amazonaws_location.GetMapStyleDescriptor({
  "MapName": ""
}, context)

Input

  • input object
    • MapName required string

Output

GetMapTile

amazonaws_location.GetMapTile({
  "MapName": "",
  "X": "",
  "Y": "",
  "Z": ""
}, context)

Input

  • input object
    • MapName required string
    • X required string
    • Y required string
    • Z required string

Output

CreatePlaceIndex

amazonaws_location.CreatePlaceIndex({
  "DataSource": "",
  "IndexName": "",
  "PricingPlan": ""
}, context)

Input

  • input object
    • DataSource required string: Specifies the data provider of geospatial data.
    • DataSourceConfiguration object: Specifies the data storage option chosen for requesting Places. By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select the Storage option for the IntendedUse parameter when requesting Places in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
      • IntendedUse
    • Description string: The optional description for the Place index resource.
    • IndexName required string: The name of the Place index resource. Requirements: Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-) and underscores (_) ). Must be a unique Place index resource name. No spaces allowed. For example, ExamplePlaceIndex.
    • PricingPlan required string (values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement): Specifies the pricing plan for your Place index resource. There's three pricing plan options: RequestBasedUsage — Selects the "Request-Based Usage" pricing plan. MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan. MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

Output

DeletePlaceIndex

amazonaws_location.DeletePlaceIndex({
  "IndexName": ""
}, context)

Input

  • input object
    • IndexName required string

Output

DescribePlaceIndex

amazonaws_location.DescribePlaceIndex({
  "IndexName": ""
}, context)

Input

  • input object
    • IndexName required string

Output

SearchPlaceIndexForPosition

amazonaws_location.SearchPlaceIndexForPosition({
  "IndexName": "",
  "Position": []
}, context)

Input

  • input object
    • IndexName required string
    • MaxResults integer: An optional paramer. The maximum number of results returned per request. Default value: 50
    • Position required array: Specifies a coordinate for the query defined by a longitude, and latitude. The first position is the X coordinate, or longitude. The second position is the Y coordinate, or latitude. For example, position=xLongitude&position=yLatitude .

Output

SearchPlaceIndexForText

amazonaws_location.SearchPlaceIndexForText({
  "IndexName": "",
  "Text": ""
}, context)

Input

  • input object
    • IndexName required string
    • BiasPosition array: Searches for results closest to the given position. An optional parameter defined by longitude, and latitude. The first bias position is the X coordinate, or longitude. The second bias position is the Y coordinate, or latitude. For example, bias=xLongitude&bias=yLatitude.
    • FilterBBox array: Filters the results by returning only Places within the provided bounding box. An optional parameter. The first 2 bbox parameters describe the lower southwest corner: The first bbox position is the X coordinate or longitude of the lower southwest corner. The second bbox position is the Y coordinate or latitude of the lower southwest corner. For example, bbox=xLongitudeSW&bbox=yLatitudeSW. The next bbox parameters describe the upper northeast corner: The third bbox position is the X coordinate, or longitude of the upper northeast corner. The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner. For example, bbox=xLongitudeNE&bbox=yLatitudeNE
    • FilterCountries array: Limits the search to the given a list of countries/regions. An optional parameter. Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.
    • MaxResults integer: An optional parameter. The maximum number of results returned per request. The default: 50
    • Text required string: The address, name, city, or region to be used in the search. In free-form text format. For example, 123 Any Street.

Output

ListPlaceIndexes

amazonaws_location.ListPlaceIndexes({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults integer: An optional limit for the maximum number of results returned in a single call. Default value: 100
    • NextToken string: The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: null

Output

ListTrackers

amazonaws_location.ListTrackers({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults integer: An optional limit for the number of resources returned in a single call. Default value: 100
    • NextToken string: The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: null

Output

CreateTracker

amazonaws_location.CreateTracker({
  "PricingPlan": "",
  "TrackerName": ""
}, context)

Input

  • input object
    • Description string: An optional description for the tracker resource.
    • PricingPlan required string (values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement): Specifies the pricing plan for your tracker resource. There's three pricing plan options: RequestBasedUsage — Selects the "Request-Based Usage" pricing plan. MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan. MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
    • TrackerName required string: The name for the tracker resource. Requirements: Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-) and underscores (_). Must be a unique tracker resource name. No spaces allowed. For example, ExampleTracker.

Output

DeleteTracker

amazonaws_location.DeleteTracker({
  "TrackerName": ""
}, context)

Input

  • input object
    • TrackerName required string

Output

DescribeTracker

amazonaws_location.DescribeTracker({
  "TrackerName": ""
}, context)

Input

  • input object
    • TrackerName required string

Output

AssociateTrackerConsumer

amazonaws_location.AssociateTrackerConsumer({
  "TrackerName": "",
  "ConsumerArn": ""
}, context)

Input

  • input object
    • TrackerName required string
    • ConsumerArn required string: The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS. Format example: arn:partition:service:region:account-id:resource-type:resource-id

Output

DisassociateTrackerConsumer

amazonaws_location.DisassociateTrackerConsumer({
  "ConsumerArn": "",
  "TrackerName": ""
}, context)

Input

  • input object
    • ConsumerArn required string
    • TrackerName required string

Output

GetDevicePositionHistory

amazonaws_location.GetDevicePositionHistory({
  "DeviceId": "",
  "TrackerName": ""
}, context)

Input

  • input object
    • DeviceId required string
    • TrackerName required string
    • NextToken string
    • EndTimeExclusive string: Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. The given time for EndTimeExclusive must be after the time for StartTimeInclusive.
    • NextToken string: The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: null
    • StartTimeInclusive string: Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. The given time for EndTimeExclusive must be after the time for StartTimeInclusive.

Output

GetDevicePosition

amazonaws_location.GetDevicePosition({
  "DeviceId": "",
  "TrackerName": ""
}, context)

Input

  • input object
    • DeviceId required string
    • TrackerName required string

Output

BatchGetDevicePosition

amazonaws_location.BatchGetDevicePosition({
  "TrackerName": "",
  "DeviceIds": []
}, context)

Input

  • input object
    • TrackerName required string
    • DeviceIds required array: Devices whose position you want to retrieve. For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2

Output

ListTrackerConsumers

amazonaws_location.ListTrackerConsumers({
  "TrackerName": ""
}, context)

Input

  • input object
    • TrackerName required string
    • MaxResults string
    • NextToken string
    • MaxResults integer: An optional limit for the number of resources returned in a single call. Default value: 100
    • NextToken string: The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. Default value: null

Output

BatchUpdateDevicePosition

amazonaws_location.BatchUpdateDevicePosition({
  "TrackerName": "",
  "Updates": []
}, context)

Input

  • input object
    • TrackerName required string
    • Updates required array: Contains the position update details for each device.

Output

Definitions

AccessDeniedException

Arn

  • Arn string

ArnList

  • ArnList array

AssociateTrackerConsumerRequest

  • AssociateTrackerConsumerRequest object
    • ConsumerArn required

AssociateTrackerConsumerResponse

  • AssociateTrackerConsumerResponse object

BatchDeleteGeofenceError

  • BatchDeleteGeofenceError object: Contains error details for each geofence that failed to delete from the geofence collection.
    • Error required
      • Code
      • Message
    • GeofenceId required

BatchDeleteGeofenceErrorList

BatchDeleteGeofenceRequest

  • BatchDeleteGeofenceRequest object
    • GeofenceIds required

BatchDeleteGeofenceRequestGeofenceIdsList

  • BatchDeleteGeofenceRequestGeofenceIdsList array

BatchDeleteGeofenceResponse

BatchEvaluateGeofencesError

  • BatchEvaluateGeofencesError object: Contains error details for each device that failed to evaluate its position against the geofences in a given geofence collection.
    • DeviceId required
    • Error required
      • Code
      • Message
    • SampleTime required

BatchEvaluateGeofencesErrorList

BatchEvaluateGeofencesRequest

BatchEvaluateGeofencesRequestDevicePositionUpdatesList

BatchEvaluateGeofencesResponse

BatchGetDevicePositionError

  • BatchGetDevicePositionError object: Contains error details for each device that didn't return a position.
    • DeviceId required
    • Error required
      • Code
      • Message

BatchGetDevicePositionErrorList

BatchGetDevicePositionRequest

  • BatchGetDevicePositionRequest object
    • DeviceIds required

BatchGetDevicePositionRequestDeviceIdsList

  • BatchGetDevicePositionRequestDeviceIdsList array

BatchGetDevicePositionRequestTrackerNameString

  • BatchGetDevicePositionRequestTrackerNameString string

BatchGetDevicePositionResponse

BatchItemError

  • BatchItemError object: Contains the batch request error details associated with the request.
    • Code
    • Message

BatchItemErrorCode

  • BatchItemErrorCode string (values: AccessDeniedError, ConflictError, InternalServerError, ResourceNotFoundError, ThrottlingError, ValidationError)

BatchPutGeofenceError

  • BatchPutGeofenceError object: Contains error details for each geofence that failed to be stored in a given geofence collection.
    • Error required
      • Code
      • Message
    • GeofenceId required

BatchPutGeofenceErrorList

BatchPutGeofenceRequest

BatchPutGeofenceRequestEntriesList

BatchPutGeofenceRequestEntry

  • BatchPutGeofenceRequestEntry object: Contains geofence details.
    • GeofenceId required
    • Geometry required

BatchPutGeofenceResponse

BatchPutGeofenceSuccess

  • BatchPutGeofenceSuccess object: Contains a summary of each geofence that was successfully stored in a given geofence collection.
    • CreateTime required
    • GeofenceId required
    • UpdateTime required

BatchPutGeofenceSuccessList

BatchUpdateDevicePositionError

  • BatchUpdateDevicePositionError object: Contains error details for each device that failed to update its position.
    • DeviceId required
    • Error required
      • Code
      • Message
    • SampleTime required

BatchUpdateDevicePositionErrorList

BatchUpdateDevicePositionRequest

BatchUpdateDevicePositionRequestUpdatesList

BatchUpdateDevicePositionResponse

Blob

  • Blob string

BoundingBox

ConflictException

CountryCode

  • CountryCode string

CountryCodeList

CreateGeofenceCollectionRequest

  • CreateGeofenceCollectionRequest object
    • CollectionName required
    • Description
    • PricingPlan required

CreateGeofenceCollectionResponse

  • CreateGeofenceCollectionResponse object
    • CollectionArn required
    • CollectionName required
    • CreateTime required

CreateMapRequest

  • CreateMapRequest object
    • Configuration required
      • Style required
    • Description
    • MapName required
    • PricingPlan required

CreateMapResponse

  • CreateMapResponse object
    • CreateTime required
    • MapArn required
    • MapName required

CreatePlaceIndexRequest

  • CreatePlaceIndexRequest object
    • DataSource required
    • DataSourceConfiguration
      • IntendedUse
    • Description
    • IndexName required
    • PricingPlan required

CreatePlaceIndexResponse

  • CreatePlaceIndexResponse object
    • CreateTime required
    • IndexArn required
    • IndexName required

CreateTrackerRequest

  • CreateTrackerRequest object
    • Description
    • PricingPlan required
    • TrackerName required

CreateTrackerResponse

  • CreateTrackerResponse object
    • CreateTime required
    • TrackerArn required
    • TrackerName required

DataSourceConfiguration

  • DataSourceConfiguration object: Specifies the data storage option chosen for requesting Places. By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select the Storage option for the IntendedUse parameter when requesting Places in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
    • IntendedUse

DeleteGeofenceCollectionRequest

  • DeleteGeofenceCollectionRequest object

DeleteGeofenceCollectionResponse

  • DeleteGeofenceCollectionResponse object

DeleteMapRequest

  • DeleteMapRequest object

DeleteMapResponse

  • DeleteMapResponse object

DeletePlaceIndexRequest

  • DeletePlaceIndexRequest object

DeletePlaceIndexResponse

  • DeletePlaceIndexResponse object

DeleteTrackerRequest

  • DeleteTrackerRequest object

DeleteTrackerResponse

  • DeleteTrackerResponse object

DescribeGeofenceCollectionRequest

  • DescribeGeofenceCollectionRequest object

DescribeGeofenceCollectionResponse

  • DescribeGeofenceCollectionResponse object
    • CollectionArn required
    • CollectionName required
    • CreateTime required
    • Description required
    • UpdateTime required

DescribeMapRequest

  • DescribeMapRequest object

DescribeMapResponse

  • DescribeMapResponse object
    • Configuration required
      • Style required
    • CreateTime required
    • DataSource required
    • Description required
    • MapArn required
    • MapName required
    • UpdateTime required

DescribePlaceIndexRequest

  • DescribePlaceIndexRequest object

DescribePlaceIndexResponse

  • DescribePlaceIndexResponse object
    • CreateTime required
    • DataSource required
    • DataSourceConfiguration required
      • IntendedUse
    • Description required
    • IndexArn required
    • IndexName required
    • UpdateTime required

DescribeTrackerRequest

  • DescribeTrackerRequest object

DescribeTrackerResponse

  • DescribeTrackerResponse object
    • CreateTime required
    • Description required
    • TrackerArn required
    • TrackerName required
    • UpdateTime required

DevicePosition

  • DevicePosition object: Contains the device position details.
    • DeviceId
    • Position required
    • ReceivedTime required
    • SampleTime required

DevicePositionList

DevicePositionUpdate

  • DevicePositionUpdate object: Contains the position update details for a device.
    • DeviceId required
    • Position required
    • SampleTime required

DisassociateTrackerConsumerRequest

  • DisassociateTrackerConsumerRequest object

DisassociateTrackerConsumerResponse

  • DisassociateTrackerConsumerResponse object

Double

  • Double number

GeofenceGeometry

  • GeofenceGeometry object: Contains the geofence geometry details. Limitation — Amazon Location does not currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian.

GetDevicePositionHistoryRequest

  • GetDevicePositionHistoryRequest object
    • EndTimeExclusive
    • NextToken
    • StartTimeInclusive

GetDevicePositionHistoryResponse

  • GetDevicePositionHistoryResponse object

GetDevicePositionRequest

  • GetDevicePositionRequest object

GetDevicePositionResponse

  • GetDevicePositionResponse object
    • DeviceId
    • Position required
    • ReceivedTime required
    • SampleTime required

GetGeofenceRequest

  • GetGeofenceRequest object

GetGeofenceResponse

  • GetGeofenceResponse object
    • CreateTime required
    • GeofenceId required
    • Geometry required
    • Status required
    • UpdateTime required

GetMapGlyphsRequest

  • GetMapGlyphsRequest object

GetMapGlyphsRequestFontUnicodeRangeString

  • GetMapGlyphsRequestFontUnicodeRangeString string

GetMapGlyphsResponse

  • GetMapGlyphsResponse object
    • Blob

GetMapSpritesRequest

  • GetMapSpritesRequest object

GetMapSpritesRequestFileNameString

  • GetMapSpritesRequestFileNameString string

GetMapSpritesResponse

  • GetMapSpritesResponse object
    • Blob

GetMapStyleDescriptorRequest

  • GetMapStyleDescriptorRequest object

GetMapStyleDescriptorResponse

  • GetMapStyleDescriptorResponse object
    • Blob

GetMapTileRequest

  • GetMapTileRequest object

GetMapTileRequestXString

  • GetMapTileRequestXString string

GetMapTileRequestYString

  • GetMapTileRequestYString string

GetMapTileRequestZString

  • GetMapTileRequestZString string

GetMapTileResponse

  • GetMapTileResponse object
    • Blob

Id

  • Id string

IntendedUse

  • IntendedUse string (values: SingleUse, Storage)

InternalServerException

LinearRing

LinearRings

ListGeofenceCollectionsRequest

  • ListGeofenceCollectionsRequest object
    • MaxResults
    • NextToken

ListGeofenceCollectionsRequestMaxResultsInteger

  • ListGeofenceCollectionsRequestMaxResultsInteger integer

ListGeofenceCollectionsResponse

ListGeofenceCollectionsResponseEntry

  • ListGeofenceCollectionsResponseEntry object: Contains the geofence collection details.
    • CollectionName required
    • CreateTime required
    • Description required
    • UpdateTime required

ListGeofenceCollectionsResponseEntryList

ListGeofenceResponseEntry

  • ListGeofenceResponseEntry object: Contains a list of geofences stored in a given geofence collection.
    • CreateTime required
    • GeofenceId required
    • Geometry required
    • Status required
    • UpdateTime required

ListGeofenceResponseEntryList

ListGeofencesRequest

  • ListGeofencesRequest object
    • NextToken

ListGeofencesResponse

ListMapsRequest

  • ListMapsRequest object
    • MaxResults
    • NextToken

ListMapsRequestMaxResultsInteger

  • ListMapsRequestMaxResultsInteger integer

ListMapsResponse

ListMapsResponseEntry

  • ListMapsResponseEntry object: Contains details of an existing map resource in your AWS account.
    • CreateTime required
    • DataSource required
    • Description required
    • MapName required
    • UpdateTime required

ListMapsResponseEntryList

ListPlaceIndexesRequest

  • ListPlaceIndexesRequest object
    • MaxResults
    • NextToken

ListPlaceIndexesRequestMaxResultsInteger

  • ListPlaceIndexesRequestMaxResultsInteger integer

ListPlaceIndexesResponse

ListPlaceIndexesResponseEntry

  • ListPlaceIndexesResponseEntry object: A Place index resource listed in your AWS account.
    • CreateTime required
    • DataSource required
    • Description required
    • IndexName required
    • UpdateTime required

ListPlaceIndexesResponseEntryList

ListTrackerConsumersRequest

  • ListTrackerConsumersRequest object
    • MaxResults
    • NextToken

ListTrackerConsumersRequestMaxResultsInteger

  • ListTrackerConsumersRequestMaxResultsInteger integer

ListTrackerConsumersResponse

  • ListTrackerConsumersResponse object
    • ConsumerArns required
    • NextToken

ListTrackersRequest

  • ListTrackersRequest object
    • MaxResults
    • NextToken

ListTrackersRequestMaxResultsInteger

  • ListTrackersRequestMaxResultsInteger integer

ListTrackersResponse

ListTrackersResponseEntry

  • ListTrackersResponseEntry object: Contains the tracker resource details.
    • CreateTime required
    • Description required
    • TrackerName required
    • UpdateTime required

ListTrackersResponseEntryList

MapConfiguration

  • MapConfiguration object: Specifies the map tile style selected from an available provider.
    • Style required

MapStyle

  • MapStyle string

Place

  • Place object: Contains details about addresses or points of interest that match the search criteria.
    • AddressNumber
    • Country
    • Geometry required PlaceGeometry
    • Label
    • Municipality
    • Neighborhood
    • PostalCode
    • Region
    • Street
    • SubRegion

PlaceGeometry

  • PlaceGeometry object: Places uses a point geometry to specify a location or a Place.

PlaceIndexSearchResultLimit

  • PlaceIndexSearchResultLimit integer

Position

PricingPlan

  • PricingPlan string (values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement)

PutGeofenceRequest

  • PutGeofenceRequest object

PutGeofenceResponse

  • PutGeofenceResponse object
    • CreateTime required
    • GeofenceId required
    • UpdateTime required

ResourceDescription

  • ResourceDescription string

ResourceName

  • ResourceName string

ResourceNotFoundException

SearchForPositionResult

  • SearchForPositionResult object: Specifies a single point of interest, or Place as a result of a search query obtained from a dataset configured in the Place index Resource.
    • Place required
      • AddressNumber
      • Country
      • Geometry required PlaceGeometry
      • Label
      • Municipality
      • Neighborhood
      • PostalCode
      • Region
      • Street
      • SubRegion

SearchForPositionResultList

SearchForTextResult

  • SearchForTextResult object: Contains relevant Places returned by calling SearchPlaceIndexForText.
    • Place required
      • AddressNumber
      • Country
      • Geometry required PlaceGeometry
      • Label
      • Municipality
      • Neighborhood
      • PostalCode
      • Region
      • Street
      • SubRegion

SearchForTextResultList

SearchPlaceIndexForPositionRequest

  • SearchPlaceIndexForPositionRequest object
    • MaxResults
    • Position required

SearchPlaceIndexForPositionResponse

  • SearchPlaceIndexForPositionResponse object

SearchPlaceIndexForPositionSummary

  • SearchPlaceIndexForPositionSummary object: A summary of the reverse geocoding request sent using SearchPlaceIndexForPosition.
    • DataSource required
    • MaxResults
    • Position required

SearchPlaceIndexForTextRequest

  • SearchPlaceIndexForTextRequest object

SearchPlaceIndexForTextResponse

SearchPlaceIndexForTextSummary

  • SearchPlaceIndexForTextSummary object: A summary of the geocoding request sent using SearchPlaceIndexForText.

String

  • String string

SyntheticSearchPlaceIndexForTextRequestString

  • SyntheticSearchPlaceIndexForTextRequestString string

SyntheticSearchPlaceIndexForTextSummaryString

  • SyntheticSearchPlaceIndexForTextSummaryString string

ThrottlingException

Timestamp

  • Timestamp string

Token

  • Token string

ValidationException

datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

5 years ago