@aws-sdk/client-location 3.241.0 → 3.248.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/protocols/Aws_restJson1.js +12 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/protocols/Aws_restJson1.js +12 -0
- package/dist-types/Location.d.ts +76 -79
- package/dist-types/commands/AssociateTrackerConsumerCommand.d.ts +3 -3
- package/dist-types/commands/BatchDeleteGeofenceCommand.d.ts +2 -2
- package/dist-types/commands/BatchEvaluateGeofencesCommand.d.ts +10 -10
- package/dist-types/commands/BatchUpdateDevicePositionCommand.d.ts +1 -1
- package/dist-types/commands/CalculateRouteCommand.d.ts +9 -9
- package/dist-types/commands/CalculateRouteMatrixCommand.d.ts +11 -11
- package/dist-types/commands/CreateMapCommand.d.ts +3 -3
- package/dist-types/commands/CreatePlaceIndexCommand.d.ts +3 -3
- package/dist-types/commands/CreateRouteCalculatorCommand.d.ts +4 -4
- package/dist-types/commands/DeleteGeofenceCollectionCommand.d.ts +2 -2
- package/dist-types/commands/DeleteMapCommand.d.ts +1 -1
- package/dist-types/commands/DeletePlaceIndexCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRouteCalculatorCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateTrackerConsumerCommand.d.ts +2 -2
- package/dist-types/commands/GetDevicePositionHistoryCommand.d.ts +1 -1
- package/dist-types/commands/GetMapStyleDescriptorCommand.d.ts +1 -1
- package/dist-types/commands/GetMapTileCommand.d.ts +1 -1
- package/dist-types/commands/GetPlaceCommand.d.ts +8 -8
- package/dist-types/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +3 -3
- package/dist-types/commands/SearchPlaceIndexForTextCommand.d.ts +4 -4
- package/dist-types/commands/TagResourceCommand.d.ts +3 -6
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +586 -485
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +6 -1
- package/package.json +4 -4
|
@@ -146,7 +146,7 @@ export interface BatchDeleteDevicePositionHistoryRequest {
|
|
|
146
146
|
* <p>For example, for two devices:
|
|
147
147
|
* <code>“DeviceIds” : [DeviceId1,DeviceId2]</code>
|
|
148
148
|
* </p>
|
|
149
|
-
*
|
|
149
|
+
* </li>
|
|
150
150
|
* </ul>
|
|
151
151
|
*/
|
|
152
152
|
DeviceIds: string[] | undefined;
|
|
@@ -251,7 +251,7 @@ export interface DevicePositionUpdate {
|
|
|
251
251
|
* <p>Associates one of more properties with the position update. A property is a key-value
|
|
252
252
|
* pair stored with the position update and added to any geofence event the update may
|
|
253
253
|
* trigger.</p>
|
|
254
|
-
*
|
|
254
|
+
* <p>Format: <code>"key" : "value"</code>
|
|
255
255
|
* </p>
|
|
256
256
|
*/
|
|
257
257
|
PositionProperties?: Record<string, string>;
|
|
@@ -307,7 +307,7 @@ export interface BatchGetDevicePositionRequest {
|
|
|
307
307
|
* <p>For example, for two devices:
|
|
308
308
|
* <code>device-ids=DeviceId1&device-ids=DeviceId2</code>
|
|
309
309
|
* </p>
|
|
310
|
-
*
|
|
310
|
+
* </li>
|
|
311
311
|
* </ul>
|
|
312
312
|
*/
|
|
313
313
|
DeviceIds: string[] | undefined;
|
|
@@ -385,28 +385,28 @@ export interface Circle {
|
|
|
385
385
|
}
|
|
386
386
|
/**
|
|
387
387
|
* <p>Contains the geofence geometry details.</p>
|
|
388
|
-
*
|
|
388
|
+
* <p>A geofence geometry is made up of either a polygon or a circle. Can be either a
|
|
389
389
|
* polygon or a circle. Including both will return a validation error.</p>
|
|
390
|
-
*
|
|
390
|
+
* <note>
|
|
391
391
|
* <p>Amazon Location doesn't currently support polygons with holes, multipolygons, polygons
|
|
392
392
|
* that are wound clockwise, or that cross the antimeridian. </p>
|
|
393
|
-
*
|
|
393
|
+
* </note>
|
|
394
394
|
*/
|
|
395
395
|
export interface GeofenceGeometry {
|
|
396
396
|
/**
|
|
397
397
|
* <p>A polygon is a list of linear rings which are each made up of a list of
|
|
398
398
|
* vertices.</p>
|
|
399
|
-
*
|
|
399
|
+
* <p>Each vertex is a 2-dimensional point of the form: <code>[longitude, latitude]</code>.
|
|
400
400
|
* This is represented as an array of doubles of length 2 (so <code>[double,
|
|
401
401
|
* double]</code>).</p>
|
|
402
|
-
*
|
|
402
|
+
* <p>An array of 4 or more vertices, where the first and last vertex are the same (to form
|
|
403
403
|
* a closed boundary), is called a linear ring. The linear ring vertices must be listed in
|
|
404
404
|
* counter-clockwise order around the ring’s interior. The linear ring is represented as an
|
|
405
405
|
* array of vertices, or an array of arrays of doubles (<code>[[double, double], ...]</code>).</p>
|
|
406
|
-
*
|
|
406
|
+
* <p>A geofence consists of a single linear ring. To allow for future expansion, the
|
|
407
407
|
* Polygon parameter takes an array of linear rings, which is represented as an array of
|
|
408
408
|
* arrays of arrays of doubles (<code>[[[double, double], ...], ...]</code>).</p>
|
|
409
|
-
*
|
|
409
|
+
* <p>A linear ring for use in geofences can consist of between 4 and 1,000 vertices.</p>
|
|
410
410
|
*/
|
|
411
411
|
Polygon?: number[][][];
|
|
412
412
|
/**
|
|
@@ -425,10 +425,10 @@ export interface BatchPutGeofenceRequestEntry {
|
|
|
425
425
|
/**
|
|
426
426
|
* <p>Contains the details of the position of the geofence. Can be either a
|
|
427
427
|
* polygon or a circle. Including both will return a validation error.</p>
|
|
428
|
-
*
|
|
428
|
+
* <note>
|
|
429
429
|
* <p>Each <a href="https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html">
|
|
430
430
|
* geofence polygon</a> can have a maximum of 1,000 vertices.</p>
|
|
431
|
-
*
|
|
431
|
+
* </note>
|
|
432
432
|
*/
|
|
433
433
|
Geometry: GeofenceGeometry | undefined;
|
|
434
434
|
}
|
|
@@ -531,23 +531,23 @@ export interface BatchUpdateDevicePositionResponse {
|
|
|
531
531
|
export interface CalculateRouteCarModeOptions {
|
|
532
532
|
/**
|
|
533
533
|
* <p>Avoids ferries when calculating routes.</p>
|
|
534
|
-
*
|
|
534
|
+
* <p>Default Value: <code>false</code>
|
|
535
535
|
* </p>
|
|
536
|
-
*
|
|
536
|
+
* <p>Valid Values: <code>false</code> | <code>true</code>
|
|
537
537
|
* </p>
|
|
538
538
|
*/
|
|
539
539
|
AvoidFerries?: boolean;
|
|
540
540
|
/**
|
|
541
541
|
* <p>Avoids tolls when calculating routes.</p>
|
|
542
|
-
*
|
|
542
|
+
* <p>Default Value: <code>false</code>
|
|
543
543
|
* </p>
|
|
544
|
-
*
|
|
544
|
+
* <p>Valid Values: <code>false</code> | <code>true</code>
|
|
545
545
|
* </p>
|
|
546
546
|
*/
|
|
547
547
|
AvoidTolls?: boolean;
|
|
548
548
|
}
|
|
549
549
|
export declare type DistanceUnit = "Kilometers" | "Miles";
|
|
550
|
-
export declare type TravelMode = "Car" | "Truck" | "Walking";
|
|
550
|
+
export declare type TravelMode = "Bicycle" | "Car" | "Motorcycle" | "Truck" | "Walking";
|
|
551
551
|
export declare type DimensionUnit = "Feet" | "Meters";
|
|
552
552
|
/**
|
|
553
553
|
* <p>Contains details about the truck dimensions in the unit of measurement that you
|
|
@@ -557,49 +557,49 @@ export declare type DimensionUnit = "Feet" | "Meters";
|
|
|
557
557
|
export interface TruckDimensions {
|
|
558
558
|
/**
|
|
559
559
|
* <p>The length of the truck.</p>
|
|
560
|
-
*
|
|
560
|
+
* <ul>
|
|
561
561
|
* <li>
|
|
562
|
-
*
|
|
562
|
+
* <p>For example, <code>15.5</code>.</p>
|
|
563
563
|
* </li>
|
|
564
564
|
* </ul>
|
|
565
|
-
*
|
|
565
|
+
* <note>
|
|
566
566
|
* <p>
|
|
567
567
|
* For routes calculated with a HERE resource, this value must be between 0 and 300 meters.
|
|
568
568
|
* </p>
|
|
569
|
-
*
|
|
569
|
+
* </note>
|
|
570
570
|
*/
|
|
571
571
|
Length?: number;
|
|
572
572
|
/**
|
|
573
573
|
* <p>The height of the truck.</p>
|
|
574
|
-
*
|
|
574
|
+
* <ul>
|
|
575
575
|
* <li>
|
|
576
|
-
*
|
|
576
|
+
* <p>For example, <code>4.5</code>.</p>
|
|
577
577
|
* </li>
|
|
578
578
|
* </ul>
|
|
579
|
-
*
|
|
579
|
+
* <note>
|
|
580
580
|
* <p>
|
|
581
581
|
* For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
|
|
582
582
|
* </p>
|
|
583
|
-
*
|
|
583
|
+
* </note>
|
|
584
584
|
*/
|
|
585
585
|
Height?: number;
|
|
586
586
|
/**
|
|
587
587
|
* <p>The width of the truck.</p>
|
|
588
|
-
*
|
|
588
|
+
* <ul>
|
|
589
589
|
* <li>
|
|
590
|
-
*
|
|
590
|
+
* <p>For example, <code>4.5</code>.</p>
|
|
591
591
|
* </li>
|
|
592
592
|
* </ul>
|
|
593
|
-
*
|
|
593
|
+
* <note>
|
|
594
594
|
* <p>
|
|
595
595
|
* For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
|
|
596
596
|
* </p>
|
|
597
|
-
*
|
|
597
|
+
* </note>
|
|
598
598
|
*/
|
|
599
599
|
Width?: number;
|
|
600
600
|
/**
|
|
601
601
|
* <p> Specifies the unit of measurement for the truck dimensions.</p>
|
|
602
|
-
*
|
|
602
|
+
* <p>Default Value: <code>Meters</code>
|
|
603
603
|
* </p>
|
|
604
604
|
*/
|
|
605
605
|
Unit?: DimensionUnit | string;
|
|
@@ -613,16 +613,16 @@ export declare type VehicleWeightUnit = "Kilograms" | "Pounds";
|
|
|
613
613
|
export interface TruckWeight {
|
|
614
614
|
/**
|
|
615
615
|
* <p>The total weight of the truck. </p>
|
|
616
|
-
*
|
|
616
|
+
* <ul>
|
|
617
617
|
* <li>
|
|
618
|
-
*
|
|
618
|
+
* <p>For example, <code>3500</code>.</p>
|
|
619
619
|
* </li>
|
|
620
620
|
* </ul>
|
|
621
621
|
*/
|
|
622
622
|
Total?: number;
|
|
623
623
|
/**
|
|
624
624
|
* <p>The unit of measurement to use for the truck weight.</p>
|
|
625
|
-
*
|
|
625
|
+
* <p>Default Value: <code>Kilograms</code>
|
|
626
626
|
* </p>
|
|
627
627
|
*/
|
|
628
628
|
Unit?: VehicleWeightUnit | string;
|
|
@@ -634,17 +634,17 @@ export interface TruckWeight {
|
|
|
634
634
|
export interface CalculateRouteTruckModeOptions {
|
|
635
635
|
/**
|
|
636
636
|
* <p>Avoids ferries when calculating routes.</p>
|
|
637
|
-
*
|
|
637
|
+
* <p>Default Value: <code>false</code>
|
|
638
638
|
* </p>
|
|
639
|
-
*
|
|
639
|
+
* <p>Valid Values: <code>false</code> | <code>true</code>
|
|
640
640
|
* </p>
|
|
641
641
|
*/
|
|
642
642
|
AvoidFerries?: boolean;
|
|
643
643
|
/**
|
|
644
644
|
* <p>Avoids tolls when calculating routes.</p>
|
|
645
|
-
*
|
|
645
|
+
* <p>Default Value: <code>false</code>
|
|
646
646
|
* </p>
|
|
647
|
-
*
|
|
647
|
+
* <p>Valid Values: <code>false</code> | <code>true</code>
|
|
648
648
|
* </p>
|
|
649
649
|
*/
|
|
650
650
|
AvoidTolls?: boolean;
|
|
@@ -670,19 +670,19 @@ export interface CalculateRouteRequest {
|
|
|
670
670
|
* <p>The start position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84">World Geodetic
|
|
671
671
|
* System (WGS 84)</a> format:
|
|
672
672
|
* <code>[longitude, latitude]</code>.</p>
|
|
673
|
-
*
|
|
673
|
+
* <ul>
|
|
674
674
|
* <li>
|
|
675
|
-
*
|
|
675
|
+
* <p>For example, <code>[-123.115, 49.285]</code>
|
|
676
676
|
* </p>
|
|
677
677
|
* </li>
|
|
678
678
|
* </ul>
|
|
679
|
-
*
|
|
679
|
+
* <note>
|
|
680
680
|
* <p>If you specify a departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position
|
|
681
681
|
* to the nearest road</a>. If Esri is the provider for your route calculator,
|
|
682
682
|
* specifying a route that is longer than 400 km returns a <code>400
|
|
683
683
|
* RoutesValidationException</code> error.</p>
|
|
684
|
-
*
|
|
685
|
-
*
|
|
684
|
+
* </note>
|
|
685
|
+
* <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
|
|
686
686
|
* </p>
|
|
687
687
|
*/
|
|
688
688
|
DeparturePosition: number[] | undefined;
|
|
@@ -690,32 +690,32 @@ export interface CalculateRouteRequest {
|
|
|
690
690
|
* <p>The finish position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84">World Geodetic
|
|
691
691
|
* System (WGS 84)</a> format:
|
|
692
692
|
* <code>[longitude, latitude]</code>.</p>
|
|
693
|
-
*
|
|
693
|
+
* <ul>
|
|
694
694
|
* <li>
|
|
695
|
-
*
|
|
695
|
+
* <p> For example, <code>[-122.339, 47.615]</code>
|
|
696
696
|
* </p>
|
|
697
697
|
* </li>
|
|
698
698
|
* </ul>
|
|
699
|
-
*
|
|
699
|
+
* <note>
|
|
700
700
|
* <p>If you specify a destination that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position
|
|
701
701
|
* to the nearest road</a>. </p>
|
|
702
|
-
*
|
|
703
|
-
*
|
|
702
|
+
* </note>
|
|
703
|
+
* <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
|
|
704
704
|
* </p>
|
|
705
705
|
*/
|
|
706
706
|
DestinationPosition: number[] | undefined;
|
|
707
707
|
/**
|
|
708
708
|
* <p>Specifies an ordered list of up to 23 intermediate positions to include along a route
|
|
709
709
|
* between the departure position and destination position. </p>
|
|
710
|
-
*
|
|
710
|
+
* <ul>
|
|
711
711
|
* <li>
|
|
712
|
-
*
|
|
713
|
-
*
|
|
712
|
+
* <p>For example, from the <code>DeparturePosition</code>
|
|
713
|
+
* <code>[-123.115, 49.285]</code>, the route follows the order that the waypoint
|
|
714
714
|
* positions are given <code>[[-122.757, 49.0021],[-122.349, 47.620]]</code>
|
|
715
715
|
* </p>
|
|
716
716
|
* </li>
|
|
717
717
|
* </ul>
|
|
718
|
-
*
|
|
718
|
+
* <note>
|
|
719
719
|
* <p>If you specify a waypoint position that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position
|
|
720
720
|
* to the nearest road</a>. </p>
|
|
721
721
|
* <p>Specifying more than 23 waypoints returns a <code>400 ValidationException</code>
|
|
@@ -723,28 +723,38 @@ export interface CalculateRouteRequest {
|
|
|
723
723
|
* <p>If Esri is the provider for your route calculator, specifying a route that is
|
|
724
724
|
* longer than 400 km returns a <code>400 RoutesValidationException</code>
|
|
725
725
|
* error.</p>
|
|
726
|
-
*
|
|
727
|
-
*
|
|
726
|
+
* </note>
|
|
727
|
+
* <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
|
|
728
728
|
* </p>
|
|
729
729
|
*/
|
|
730
730
|
WaypointPositions?: number[][];
|
|
731
731
|
/**
|
|
732
732
|
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
|
|
733
733
|
* of travel and road compatibility. You can choose <code>Car</code>, <code>Truck</code>,
|
|
734
|
-
*
|
|
735
|
-
*
|
|
734
|
+
* <code>Walking</code>, <code>Bicycle</code> or <code>Motorcycle</code> as options for
|
|
735
|
+
* the <code>TravelMode</code>.</p>
|
|
736
|
+
* <note>
|
|
737
|
+
* <p>
|
|
738
|
+
* <code>Bicycle</code> and <code>Motorcycle</code> are only valid when using Grab as
|
|
739
|
+
* a data provider, and only within Southeast Asia.</p>
|
|
740
|
+
* <p>
|
|
741
|
+
* <code>Truck</code> is not available for Grab.</p>
|
|
742
|
+
* <p>For more details on the using Grab for routing, including areas of coverage, see
|
|
743
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
|
|
744
|
+
* </note>
|
|
745
|
+
* <p>The <code>TravelMode</code> you specify also determines how you specify route
|
|
736
746
|
* preferences: </p>
|
|
737
|
-
*
|
|
747
|
+
* <ul>
|
|
738
748
|
* <li>
|
|
739
|
-
*
|
|
749
|
+
* <p>If traveling by <code>Car</code> use the <code>CarModeOptions</code>
|
|
740
750
|
* parameter.</p>
|
|
741
751
|
* </li>
|
|
742
752
|
* <li>
|
|
743
|
-
*
|
|
753
|
+
* <p>If traveling by <code>Truck</code> use the <code>TruckModeOptions</code>
|
|
744
754
|
* parameter.</p>
|
|
745
755
|
* </li>
|
|
746
756
|
* </ul>
|
|
747
|
-
*
|
|
757
|
+
* <p>Default Value: <code>Car</code>
|
|
748
758
|
* </p>
|
|
749
759
|
*/
|
|
750
760
|
TravelMode?: TravelMode | string;
|
|
@@ -752,13 +762,13 @@ export interface CalculateRouteRequest {
|
|
|
752
762
|
* <p>Specifies the desired time of departure. Uses the given time to calculate the route.
|
|
753
763
|
* Otherwise, the best time of day to travel with the best traffic conditions is used to
|
|
754
764
|
* calculate the route.</p>
|
|
755
|
-
*
|
|
765
|
+
* <note>
|
|
756
766
|
* <p>Setting a departure time in the past returns a <code>400
|
|
757
767
|
* ValidationException</code> error.</p>
|
|
758
|
-
*
|
|
759
|
-
*
|
|
768
|
+
* </note>
|
|
769
|
+
* <ul>
|
|
760
770
|
* <li>
|
|
761
|
-
*
|
|
771
|
+
* <p>In <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO
|
|
762
772
|
* 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. For example,
|
|
763
773
|
* <code>2020–07-2T12:15:20.000Z+01:00</code>
|
|
764
774
|
* </p>
|
|
@@ -770,38 +780,38 @@ export interface CalculateRouteRequest {
|
|
|
770
780
|
* <p>Sets the time of departure as the current time. Uses the current time to calculate a
|
|
771
781
|
* route. Otherwise, the best time of day to travel with the best traffic conditions is
|
|
772
782
|
* used to calculate the route.</p>
|
|
773
|
-
*
|
|
783
|
+
* <p>Default Value: <code>false</code>
|
|
774
784
|
* </p>
|
|
775
|
-
*
|
|
785
|
+
* <p>Valid Values: <code>false</code> | <code>true</code>
|
|
776
786
|
* </p>
|
|
777
787
|
*/
|
|
778
788
|
DepartNow?: boolean;
|
|
779
789
|
/**
|
|
780
790
|
* <p>Set the unit system to specify the distance.</p>
|
|
781
|
-
*
|
|
791
|
+
* <p>Default Value: <code>Kilometers</code>
|
|
782
792
|
* </p>
|
|
783
793
|
*/
|
|
784
794
|
DistanceUnit?: DistanceUnit | string;
|
|
785
795
|
/**
|
|
786
796
|
* <p>Set to include the geometry details in the result for each path between a pair of
|
|
787
797
|
* positions.</p>
|
|
788
|
-
*
|
|
798
|
+
* <p>Default Value: <code>false</code>
|
|
789
799
|
* </p>
|
|
790
|
-
*
|
|
800
|
+
* <p>Valid Values: <code>false</code> | <code>true</code>
|
|
791
801
|
* </p>
|
|
792
802
|
*/
|
|
793
803
|
IncludeLegGeometry?: boolean;
|
|
794
804
|
/**
|
|
795
805
|
* <p>Specifies route preferences when traveling by <code>Car</code>, such as avoiding
|
|
796
806
|
* routes that use ferries or tolls.</p>
|
|
797
|
-
*
|
|
807
|
+
* <p>Requirements: <code>TravelMode</code> must be specified as <code>Car</code>.</p>
|
|
798
808
|
*/
|
|
799
809
|
CarModeOptions?: CalculateRouteCarModeOptions;
|
|
800
810
|
/**
|
|
801
811
|
* <p>Specifies route preferences when traveling by <code>Truck</code>, such as avoiding
|
|
802
812
|
* routes that use ferries or tolls, and truck specifications to consider when choosing an
|
|
803
813
|
* optimal road.</p>
|
|
804
|
-
*
|
|
814
|
+
* <p>Requirements: <code>TravelMode</code> must be specified as <code>Truck</code>.</p>
|
|
805
815
|
*/
|
|
806
816
|
TruckModeOptions?: CalculateRouteTruckModeOptions;
|
|
807
817
|
}
|
|
@@ -812,11 +822,11 @@ export interface CalculateRouteRequest {
|
|
|
812
822
|
export interface LegGeometry {
|
|
813
823
|
/**
|
|
814
824
|
* <p>An ordered list of positions used to plot a route on a map. </p>
|
|
815
|
-
*
|
|
825
|
+
* <p>The first position is closest to the start position for the leg, and the last position
|
|
816
826
|
* is the closest to the end position for the leg.</p>
|
|
817
|
-
*
|
|
827
|
+
* <ul>
|
|
818
828
|
* <li>
|
|
819
|
-
*
|
|
829
|
+
* <p>For example, <code>[[-123.117, 49.284],[-123.115, 49.285],[-123.115,
|
|
820
830
|
* 49.285]]</code>
|
|
821
831
|
* </p>
|
|
822
832
|
* </li>
|
|
@@ -854,7 +864,7 @@ export interface Step {
|
|
|
854
864
|
* <p>Represents the start position, or index, in a sequence of steps within the leg's line
|
|
855
865
|
* string geometry. For example, the index of the first step in a leg geometry is
|
|
856
866
|
* <code>0</code>. </p>
|
|
857
|
-
*
|
|
867
|
+
* <p>Included in the response for queries that set <code>IncludeLegGeometry</code> to
|
|
858
868
|
* <code>True</code>. </p>
|
|
859
869
|
*/
|
|
860
870
|
GeometryOffset?: number;
|
|
@@ -863,26 +873,26 @@ export interface Step {
|
|
|
863
873
|
* <p>Contains the calculated route's details for each path between a pair of positions. The
|
|
864
874
|
* number of legs returned corresponds to one fewer than the total number of positions in
|
|
865
875
|
* the request. </p>
|
|
866
|
-
*
|
|
876
|
+
* <p>For example, a route with a departure position and destination position returns one
|
|
867
877
|
* leg with the positions <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">snapped to a nearby
|
|
868
878
|
* road</a>:</p>
|
|
869
|
-
*
|
|
879
|
+
* <ul>
|
|
870
880
|
* <li>
|
|
871
|
-
*
|
|
881
|
+
* <p>The <code>StartPosition</code> is the departure position.</p>
|
|
872
882
|
* </li>
|
|
873
883
|
* <li>
|
|
874
|
-
*
|
|
884
|
+
* <p>The <code>EndPosition</code> is the destination position.</p>
|
|
875
885
|
* </li>
|
|
876
886
|
* </ul>
|
|
877
|
-
*
|
|
887
|
+
* <p>A route with a waypoint between the departure and destination position returns two
|
|
878
888
|
* legs with the positions snapped to a nearby road:</p>
|
|
879
|
-
*
|
|
889
|
+
* <ul>
|
|
880
890
|
* <li>
|
|
881
|
-
*
|
|
891
|
+
* <p>Leg 1: The <code>StartPosition</code> is the departure position . The
|
|
882
892
|
* <code>EndPosition</code> is the waypoint positon.</p>
|
|
883
893
|
* </li>
|
|
884
894
|
* <li>
|
|
885
|
-
*
|
|
895
|
+
* <p>Leg 2: The <code>StartPosition</code> is the waypoint position. The
|
|
886
896
|
* <code>EndPosition</code> is the destination position.</p>
|
|
887
897
|
* </li>
|
|
888
898
|
* </ul>
|
|
@@ -891,27 +901,27 @@ export interface Leg {
|
|
|
891
901
|
/**
|
|
892
902
|
* <p>The starting position of the leg. Follows the format
|
|
893
903
|
* <code>[longitude,latitude]</code>.</p>
|
|
894
|
-
*
|
|
904
|
+
* <note>
|
|
895
905
|
* <p>If the <code>StartPosition</code> isn't located on a road, it's <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">snapped to a
|
|
896
906
|
* nearby road</a>. </p>
|
|
897
|
-
*
|
|
907
|
+
* </note>
|
|
898
908
|
*/
|
|
899
909
|
StartPosition: number[] | undefined;
|
|
900
910
|
/**
|
|
901
911
|
* <p>The terminating position of the leg. Follows the format
|
|
902
912
|
* <code>[longitude,latitude]</code>.</p>
|
|
903
|
-
*
|
|
913
|
+
* <note>
|
|
904
914
|
* <p>If the <code>EndPosition</code> isn't located on a road, it's <a href="https://docs.aws.amazon.com/location/latest/developerguide/nap-to-nearby-road.html">snapped to a nearby
|
|
905
915
|
* road</a>. </p>
|
|
906
|
-
*
|
|
916
|
+
* </note>
|
|
907
917
|
*/
|
|
908
918
|
EndPosition: number[] | undefined;
|
|
909
919
|
/**
|
|
910
920
|
* <p>The distance between the leg's <code>StartPosition</code> and <code>EndPosition</code>
|
|
911
921
|
* along a calculated route. </p>
|
|
912
|
-
*
|
|
922
|
+
* <ul>
|
|
913
923
|
* <li>
|
|
914
|
-
*
|
|
924
|
+
* <p>The default measurement is <code>Kilometers</code> unless the request
|
|
915
925
|
* specifies a <code>DistanceUnit</code> of <code>Miles</code>.</p>
|
|
916
926
|
* </li>
|
|
917
927
|
* </ul>
|
|
@@ -941,25 +951,25 @@ export interface CalculateRouteSummary {
|
|
|
941
951
|
/**
|
|
942
952
|
* <p>Specifies a geographical box surrounding a route. Used to zoom into a route when
|
|
943
953
|
* displaying it in a map. For example, <code>[min x, min y, max x, max y]</code>.</p>
|
|
944
|
-
*
|
|
945
|
-
*
|
|
954
|
+
* <p>The first 2 <code>bbox</code> parameters describe the lower southwest corner: </p>
|
|
955
|
+
* <ul>
|
|
946
956
|
* <li>
|
|
947
|
-
*
|
|
957
|
+
* <p>The first <code>bbox</code> position is the X coordinate or longitude of the
|
|
948
958
|
* lower southwest corner. </p>
|
|
949
959
|
* </li>
|
|
950
960
|
* <li>
|
|
951
|
-
*
|
|
961
|
+
* <p>The second <code>bbox</code> position is the Y coordinate or latitude of the
|
|
952
962
|
* lower southwest corner. </p>
|
|
953
963
|
* </li>
|
|
954
964
|
* </ul>
|
|
955
|
-
*
|
|
956
|
-
*
|
|
965
|
+
* <p>The next 2 <code>bbox</code> parameters describe the upper northeast corner: </p>
|
|
966
|
+
* <ul>
|
|
957
967
|
* <li>
|
|
958
|
-
*
|
|
968
|
+
* <p>The third <code>bbox</code> position is the X coordinate, or longitude of the
|
|
959
969
|
* upper northeast corner. </p>
|
|
960
970
|
* </li>
|
|
961
971
|
* <li>
|
|
962
|
-
*
|
|
972
|
+
* <p>The fourth <code>bbox</code> position is the Y coordinate, or latitude of the
|
|
963
973
|
* upper northeast corner. </p>
|
|
964
974
|
* </li>
|
|
965
975
|
* </ul>
|
|
@@ -968,29 +978,34 @@ export interface CalculateRouteSummary {
|
|
|
968
978
|
/**
|
|
969
979
|
* <p>The data provider of traffic and road network data used to calculate the route.
|
|
970
980
|
* Indicates one of the available providers:</p>
|
|
971
|
-
*
|
|
981
|
+
* <ul>
|
|
972
982
|
* <li>
|
|
973
|
-
*
|
|
983
|
+
* <p>
|
|
974
984
|
* <code>Esri</code>
|
|
975
985
|
* </p>
|
|
976
986
|
* </li>
|
|
977
987
|
* <li>
|
|
978
|
-
*
|
|
988
|
+
* <p>
|
|
989
|
+
* <code>Grab</code>
|
|
990
|
+
* </p>
|
|
991
|
+
* </li>
|
|
992
|
+
* <li>
|
|
993
|
+
* <p>
|
|
979
994
|
* <code>Here</code>
|
|
980
995
|
* </p>
|
|
981
996
|
* </li>
|
|
982
997
|
* </ul>
|
|
983
|
-
*
|
|
998
|
+
* <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
|
|
984
999
|
*/
|
|
985
1000
|
DataSource: string | undefined;
|
|
986
1001
|
/**
|
|
987
1002
|
* <p>The total distance covered by the route. The sum of the distance travelled between
|
|
988
1003
|
* every stop on the route.</p>
|
|
989
|
-
*
|
|
1004
|
+
* <note>
|
|
990
1005
|
* <p>If Esri is the data source for the route calculator, the route distance can’t be
|
|
991
1006
|
* greater than 400 km. If the route exceeds 400 km, the response is a <code>400
|
|
992
1007
|
* RoutesValidationException</code> error.</p>
|
|
993
|
-
*
|
|
1008
|
+
* </note>
|
|
994
1009
|
*/
|
|
995
1010
|
Distance: number | undefined;
|
|
996
1011
|
/**
|
|
@@ -1015,26 +1030,26 @@ export interface CalculateRouteResponse {
|
|
|
1015
1030
|
* <code>DurationSeconds</code>, <code>Geometry</code>, and <code>Steps</code>. The
|
|
1016
1031
|
* number of legs returned corresponds to one fewer than the total number of positions in
|
|
1017
1032
|
* the request. </p>
|
|
1018
|
-
*
|
|
1033
|
+
* <p>For example, a route with a departure position and destination position returns one
|
|
1019
1034
|
* leg with the positions <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">snapped to a nearby
|
|
1020
1035
|
* road</a>:</p>
|
|
1021
|
-
*
|
|
1036
|
+
* <ul>
|
|
1022
1037
|
* <li>
|
|
1023
|
-
*
|
|
1038
|
+
* <p>The <code>StartPosition</code> is the departure position.</p>
|
|
1024
1039
|
* </li>
|
|
1025
1040
|
* <li>
|
|
1026
|
-
*
|
|
1041
|
+
* <p>The <code>EndPosition</code> is the destination position.</p>
|
|
1027
1042
|
* </li>
|
|
1028
1043
|
* </ul>
|
|
1029
|
-
*
|
|
1044
|
+
* <p>A route with a waypoint between the departure and destination position returns two
|
|
1030
1045
|
* legs with the positions snapped to a nearby road:</p>
|
|
1031
|
-
*
|
|
1046
|
+
* <ul>
|
|
1032
1047
|
* <li>
|
|
1033
|
-
*
|
|
1048
|
+
* <p>Leg 1: The <code>StartPosition</code> is the departure position . The
|
|
1034
1049
|
* <code>EndPosition</code> is the waypoint positon.</p>
|
|
1035
1050
|
* </li>
|
|
1036
1051
|
* <li>
|
|
1037
|
-
*
|
|
1052
|
+
* <p>Leg 2: The <code>StartPosition</code> is the waypoint position. The
|
|
1038
1053
|
* <code>EndPosition</code> is the destination position.</p>
|
|
1039
1054
|
* </li>
|
|
1040
1055
|
* </ul>
|
|
@@ -1058,18 +1073,18 @@ export interface CalculateRouteMatrixRequest {
|
|
|
1058
1073
|
* each of which is itself a 2-value array defined in <a href="https://earth-info.nga.mil/GandG/wgs84/index.html">WGS 84</a> format:
|
|
1059
1074
|
* <code>[longitude, latitude]</code>. For example, <code>[-123.115,
|
|
1060
1075
|
* 49.285]</code>.</p>
|
|
1061
|
-
*
|
|
1076
|
+
* <important>
|
|
1062
1077
|
* <p>Depending on the data provider selected in the route calculator resource there may
|
|
1063
1078
|
* be additional restrictions on the inputs you can choose. See <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits"> Position restrictions</a> in the <i>Amazon Location Service Developer
|
|
1064
1079
|
* Guide</i>.</p>
|
|
1065
|
-
*
|
|
1066
|
-
*
|
|
1080
|
+
* </important>
|
|
1081
|
+
* <note>
|
|
1067
1082
|
* <p>For route calculators that use Esri as the data provider, if you specify a
|
|
1068
1083
|
* departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html"> moves the
|
|
1069
1084
|
* position to the nearest road</a>. The snapped value is available in the
|
|
1070
1085
|
* result in <code>SnappedDeparturePositions</code>.</p>
|
|
1071
|
-
*
|
|
1072
|
-
*
|
|
1086
|
+
* </note>
|
|
1087
|
+
* <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
|
|
1073
1088
|
* </p>
|
|
1074
1089
|
*/
|
|
1075
1090
|
DeparturePositions: number[][] | undefined;
|
|
@@ -1079,37 +1094,45 @@ export interface CalculateRouteMatrixRequest {
|
|
|
1079
1094
|
* <code>[longitude, latitude]</code>. For example, <code>[-122.339,
|
|
1080
1095
|
* 47.615]</code>
|
|
1081
1096
|
* </p>
|
|
1082
|
-
*
|
|
1097
|
+
* <important>
|
|
1083
1098
|
* <p>Depending on the data provider selected in the route calculator resource there may
|
|
1084
1099
|
* be additional restrictions on the inputs you can choose. See <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits"> Position restrictions</a> in the <i>Amazon Location Service Developer
|
|
1085
1100
|
* Guide</i>.</p>
|
|
1086
|
-
*
|
|
1087
|
-
*
|
|
1101
|
+
* </important>
|
|
1102
|
+
* <note>
|
|
1088
1103
|
* <p>For route calculators that use Esri as the data provider, if you specify a
|
|
1089
1104
|
* destination that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html"> moves the
|
|
1090
1105
|
* position to the nearest road</a>. The snapped value is available in the
|
|
1091
1106
|
* result in <code>SnappedDestinationPositions</code>.</p>
|
|
1092
|
-
*
|
|
1093
|
-
*
|
|
1107
|
+
* </note>
|
|
1108
|
+
* <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
|
|
1094
1109
|
* </p>
|
|
1095
1110
|
*/
|
|
1096
1111
|
DestinationPositions: number[][] | undefined;
|
|
1097
1112
|
/**
|
|
1098
1113
|
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
|
|
1099
1114
|
* of travel and road compatibility.</p>
|
|
1100
|
-
*
|
|
1115
|
+
* <p>The <code>TravelMode</code> you specify also determines how you specify route
|
|
1101
1116
|
* preferences: </p>
|
|
1102
|
-
*
|
|
1117
|
+
* <ul>
|
|
1103
1118
|
* <li>
|
|
1104
|
-
*
|
|
1119
|
+
* <p>If traveling by <code>Car</code> use the <code>CarModeOptions</code>
|
|
1105
1120
|
* parameter.</p>
|
|
1106
1121
|
* </li>
|
|
1107
1122
|
* <li>
|
|
1108
|
-
*
|
|
1123
|
+
* <p>If traveling by <code>Truck</code> use the <code>TruckModeOptions</code>
|
|
1109
1124
|
* parameter.</p>
|
|
1110
1125
|
* </li>
|
|
1111
1126
|
* </ul>
|
|
1112
|
-
*
|
|
1127
|
+
* <note>
|
|
1128
|
+
* <p>
|
|
1129
|
+
* <code>Bicycle</code> or <code>Motorcycle</code> are only valid when using
|
|
1130
|
+
* <code>Grab</code> as a data provider, and only within Southeast Asia.</p>
|
|
1131
|
+
* <p>
|
|
1132
|
+
* <code>Truck</code> is not available for Grab.</p>
|
|
1133
|
+
* <p>For more information about using Grab as a data provider, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
|
|
1134
|
+
* </note>
|
|
1135
|
+
* <p>Default Value: <code>Car</code>
|
|
1113
1136
|
* </p>
|
|
1114
1137
|
*/
|
|
1115
1138
|
TravelMode?: TravelMode | string;
|
|
@@ -1118,13 +1141,13 @@ export interface CalculateRouteMatrixRequest {
|
|
|
1118
1141
|
* matrix. You can't set both <code>DepartureTime</code> and <code>DepartNow</code>. If
|
|
1119
1142
|
* neither is set, the best time of day to travel with the best traffic conditions is used
|
|
1120
1143
|
* to calculate the route matrix.</p>
|
|
1121
|
-
*
|
|
1144
|
+
* <note>
|
|
1122
1145
|
* <p>Setting a departure time in the past returns a <code>400
|
|
1123
1146
|
* ValidationException</code> error.</p>
|
|
1124
|
-
*
|
|
1125
|
-
*
|
|
1147
|
+
* </note>
|
|
1148
|
+
* <ul>
|
|
1126
1149
|
* <li>
|
|
1127
|
-
*
|
|
1150
|
+
* <p>In <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO
|
|
1128
1151
|
* 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. For example,
|
|
1129
1152
|
* <code>2020–07-2T12:15:20.000Z+01:00</code>
|
|
1130
1153
|
* </p>
|
|
@@ -1137,29 +1160,29 @@ export interface CalculateRouteMatrixRequest {
|
|
|
1137
1160
|
* route matrix. You can't set both <code>DepartureTime</code> and <code>DepartNow</code>.
|
|
1138
1161
|
* If neither is set, the best time of day to travel with the best traffic conditions is
|
|
1139
1162
|
* used to calculate the route matrix.</p>
|
|
1140
|
-
*
|
|
1163
|
+
* <p>Default Value: <code>false</code>
|
|
1141
1164
|
* </p>
|
|
1142
|
-
*
|
|
1165
|
+
* <p>Valid Values: <code>false</code> | <code>true</code>
|
|
1143
1166
|
* </p>
|
|
1144
1167
|
*/
|
|
1145
1168
|
DepartNow?: boolean;
|
|
1146
1169
|
/**
|
|
1147
1170
|
* <p>Set the unit system to specify the distance.</p>
|
|
1148
|
-
*
|
|
1171
|
+
* <p>Default Value: <code>Kilometers</code>
|
|
1149
1172
|
* </p>
|
|
1150
1173
|
*/
|
|
1151
1174
|
DistanceUnit?: DistanceUnit | string;
|
|
1152
1175
|
/**
|
|
1153
1176
|
* <p>Specifies route preferences when traveling by <code>Car</code>, such as avoiding
|
|
1154
1177
|
* routes that use ferries or tolls.</p>
|
|
1155
|
-
*
|
|
1178
|
+
* <p>Requirements: <code>TravelMode</code> must be specified as <code>Car</code>.</p>
|
|
1156
1179
|
*/
|
|
1157
1180
|
CarModeOptions?: CalculateRouteCarModeOptions;
|
|
1158
1181
|
/**
|
|
1159
1182
|
* <p>Specifies route preferences when traveling by <code>Truck</code>, such as avoiding
|
|
1160
1183
|
* routes that use ferries or tolls, and truck specifications to consider when choosing an
|
|
1161
1184
|
* optimal road.</p>
|
|
1162
|
-
*
|
|
1185
|
+
* <p>Requirements: <code>TravelMode</code> must be specified as <code>Truck</code>.</p>
|
|
1163
1186
|
*/
|
|
1164
1187
|
TruckModeOptions?: CalculateRouteTruckModeOptions;
|
|
1165
1188
|
}
|
|
@@ -1167,45 +1190,45 @@ export declare type RouteMatrixErrorCode = "DeparturePositionNotFound" | "Destin
|
|
|
1167
1190
|
/**
|
|
1168
1191
|
* <p>An error corresponding to the calculation of a route between the
|
|
1169
1192
|
* <code>DeparturePosition</code> and <code>DestinationPosition</code>.</p>
|
|
1170
|
-
*
|
|
1171
|
-
*
|
|
1193
|
+
* <p>The error code can be one of the following:</p>
|
|
1194
|
+
* <ul>
|
|
1172
1195
|
* <li>
|
|
1173
|
-
*
|
|
1196
|
+
* <p>
|
|
1174
1197
|
* <code>RouteNotFound</code> - Unable to find a valid route with the given
|
|
1175
1198
|
* parameters.</p>
|
|
1176
1199
|
* </li>
|
|
1177
1200
|
* </ul>
|
|
1178
|
-
*
|
|
1201
|
+
* <ul>
|
|
1179
1202
|
* <li>
|
|
1180
|
-
*
|
|
1203
|
+
* <p>
|
|
1181
1204
|
* <code>RouteTooLong</code> - Route calculation went beyond the maximum size of
|
|
1182
1205
|
* a route and was terminated before completion.</p>
|
|
1183
1206
|
* </li>
|
|
1184
1207
|
* </ul>
|
|
1185
|
-
*
|
|
1208
|
+
* <ul>
|
|
1186
1209
|
* <li>
|
|
1187
|
-
*
|
|
1210
|
+
* <p>
|
|
1188
1211
|
* <code>PositionsNotFound</code> - One or more of the input positions were not
|
|
1189
1212
|
* found on the route network.</p>
|
|
1190
1213
|
* </li>
|
|
1191
1214
|
* </ul>
|
|
1192
|
-
*
|
|
1215
|
+
* <ul>
|
|
1193
1216
|
* <li>
|
|
1194
|
-
*
|
|
1217
|
+
* <p>
|
|
1195
1218
|
* <code>DestinationPositionNotFound</code> - The destination position was not
|
|
1196
1219
|
* found on the route network.</p>
|
|
1197
1220
|
* </li>
|
|
1198
1221
|
* </ul>
|
|
1199
|
-
*
|
|
1222
|
+
* <ul>
|
|
1200
1223
|
* <li>
|
|
1201
|
-
*
|
|
1224
|
+
* <p>
|
|
1202
1225
|
* <code>DeparturePositionNotFound</code> - The departure position was not found
|
|
1203
1226
|
* on the route network.</p>
|
|
1204
1227
|
* </li>
|
|
1205
1228
|
* </ul>
|
|
1206
|
-
*
|
|
1229
|
+
* <ul>
|
|
1207
1230
|
* <li>
|
|
1208
|
-
*
|
|
1231
|
+
* <p>
|
|
1209
1232
|
* <code>OtherValidationError</code> - The given inputs were not valid or a route
|
|
1210
1233
|
* was not found. More information is given in the error
|
|
1211
1234
|
* <code>Message</code>
|
|
@@ -1249,19 +1272,24 @@ export interface CalculateRouteMatrixSummary {
|
|
|
1249
1272
|
/**
|
|
1250
1273
|
* <p>The data provider of traffic and road network data used to calculate the routes.
|
|
1251
1274
|
* Indicates one of the available providers:</p>
|
|
1252
|
-
*
|
|
1275
|
+
* <ul>
|
|
1253
1276
|
* <li>
|
|
1254
|
-
*
|
|
1277
|
+
* <p>
|
|
1255
1278
|
* <code>Esri</code>
|
|
1256
1279
|
* </p>
|
|
1257
1280
|
* </li>
|
|
1258
1281
|
* <li>
|
|
1259
|
-
*
|
|
1282
|
+
* <p>
|
|
1283
|
+
* <code>Grab</code>
|
|
1284
|
+
* </p>
|
|
1285
|
+
* </li>
|
|
1286
|
+
* <li>
|
|
1287
|
+
* <p>
|
|
1260
1288
|
* <code>Here</code>
|
|
1261
1289
|
* </p>
|
|
1262
1290
|
* </li>
|
|
1263
1291
|
* </ul>
|
|
1264
|
-
*
|
|
1292
|
+
* <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data
|
|
1265
1293
|
* providers</a>.</p>
|
|
1266
1294
|
*/
|
|
1267
1295
|
DataSource: string | undefined;
|
|
@@ -1316,17 +1344,17 @@ export declare type PricingPlan = "MobileAssetManagement" | "MobileAssetTracking
|
|
|
1316
1344
|
export interface CreateGeofenceCollectionRequest {
|
|
1317
1345
|
/**
|
|
1318
1346
|
* <p>A custom name for the geofence collection.</p>
|
|
1319
|
-
*
|
|
1320
|
-
*
|
|
1347
|
+
* <p>Requirements:</p>
|
|
1348
|
+
* <ul>
|
|
1321
1349
|
* <li>
|
|
1322
|
-
*
|
|
1350
|
+
* <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods
|
|
1323
1351
|
* (.), and underscores (_). </p>
|
|
1324
1352
|
* </li>
|
|
1325
1353
|
* <li>
|
|
1326
|
-
*
|
|
1354
|
+
* <p>Must be a unique geofence collection name.</p>
|
|
1327
1355
|
* </li>
|
|
1328
1356
|
* <li>
|
|
1329
|
-
*
|
|
1357
|
+
* <p>No spaces allowed. For example, <code>ExampleGeofenceCollection</code>.</p>
|
|
1330
1358
|
* </li>
|
|
1331
1359
|
* </ul>
|
|
1332
1360
|
*/
|
|
@@ -1351,28 +1379,28 @@ export interface CreateGeofenceCollectionRequest {
|
|
|
1351
1379
|
/**
|
|
1352
1380
|
* <p>Applies one or more tags to the geofence collection. A tag is a key-value pair helps
|
|
1353
1381
|
* manage, identify, search, and filter your resources by labelling them.</p>
|
|
1354
|
-
*
|
|
1382
|
+
* <p>Format: <code>"key" : "value"</code>
|
|
1355
1383
|
* </p>
|
|
1356
|
-
*
|
|
1357
|
-
*
|
|
1384
|
+
* <p>Restrictions:</p>
|
|
1385
|
+
* <ul>
|
|
1358
1386
|
* <li>
|
|
1359
|
-
*
|
|
1387
|
+
* <p>Maximum 50 tags per resource</p>
|
|
1360
1388
|
* </li>
|
|
1361
1389
|
* <li>
|
|
1362
|
-
*
|
|
1390
|
+
* <p>Each resource tag must be unique with a maximum of one value.</p>
|
|
1363
1391
|
* </li>
|
|
1364
1392
|
* <li>
|
|
1365
|
-
*
|
|
1393
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8</p>
|
|
1366
1394
|
* </li>
|
|
1367
1395
|
* <li>
|
|
1368
|
-
*
|
|
1396
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8</p>
|
|
1369
1397
|
* </li>
|
|
1370
1398
|
* <li>
|
|
1371
|
-
*
|
|
1399
|
+
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
|
|
1372
1400
|
* + - = . _ : / @. </p>
|
|
1373
1401
|
* </li>
|
|
1374
1402
|
* <li>
|
|
1375
|
-
*
|
|
1403
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
1376
1404
|
* </li>
|
|
1377
1405
|
* </ul>
|
|
1378
1406
|
*/
|
|
@@ -1391,9 +1419,9 @@ export interface CreateGeofenceCollectionResponse {
|
|
|
1391
1419
|
/**
|
|
1392
1420
|
* <p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you
|
|
1393
1421
|
* need to specify a resource across all AWS. </p>
|
|
1394
|
-
*
|
|
1422
|
+
* <ul>
|
|
1395
1423
|
* <li>
|
|
1396
|
-
*
|
|
1424
|
+
* <p>Format example:
|
|
1397
1425
|
* <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection</code>
|
|
1398
1426
|
* </p>
|
|
1399
1427
|
* </li>
|
|
@@ -1413,55 +1441,55 @@ export interface CreateGeofenceCollectionResponse {
|
|
|
1413
1441
|
export interface MapConfiguration {
|
|
1414
1442
|
/**
|
|
1415
1443
|
* <p>Specifies the map style selected from an available data provider.</p>
|
|
1416
|
-
*
|
|
1417
|
-
*
|
|
1444
|
+
* <p>Valid <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri map styles</a>:</p>
|
|
1445
|
+
* <ul>
|
|
1418
1446
|
* <li>
|
|
1419
|
-
*
|
|
1447
|
+
* <p>
|
|
1420
1448
|
* <code>VectorEsriDarkGrayCanvas</code> – The Esri Dark Gray Canvas map style. A
|
|
1421
1449
|
* vector basemap with a dark gray, neutral background with minimal colors, labels,
|
|
1422
1450
|
* and features that's designed to draw attention to your thematic content. </p>
|
|
1423
1451
|
* </li>
|
|
1424
1452
|
* <li>
|
|
1425
|
-
*
|
|
1453
|
+
* <p>
|
|
1426
1454
|
* <code>RasterEsriImagery</code> – The Esri Imagery map style. A raster basemap
|
|
1427
1455
|
* that provides one meter or better satellite and aerial imagery in many parts of
|
|
1428
1456
|
* the world and lower resolution satellite imagery worldwide. </p>
|
|
1429
1457
|
* </li>
|
|
1430
1458
|
* <li>
|
|
1431
|
-
*
|
|
1459
|
+
* <p>
|
|
1432
1460
|
* <code>VectorEsriLightGrayCanvas</code> – The Esri Light Gray Canvas map style,
|
|
1433
1461
|
* which provides a detailed vector basemap with a light gray, neutral background
|
|
1434
1462
|
* style with minimal colors, labels, and features that's designed to draw
|
|
1435
1463
|
* attention to your thematic content. </p>
|
|
1436
1464
|
* </li>
|
|
1437
1465
|
* <li>
|
|
1438
|
-
*
|
|
1466
|
+
* <p>
|
|
1439
1467
|
* <code>VectorEsriTopographic</code> – The Esri Light map style, which provides
|
|
1440
1468
|
* a detailed vector basemap with a classic Esri map style.</p>
|
|
1441
1469
|
* </li>
|
|
1442
1470
|
* <li>
|
|
1443
|
-
*
|
|
1471
|
+
* <p>
|
|
1444
1472
|
* <code>VectorEsriStreets</code> – The Esri World Streets map style, which
|
|
1445
1473
|
* provides a detailed vector basemap for the world symbolized with a classic Esri
|
|
1446
1474
|
* street map style. The vector tile layer is similar in content and style to the
|
|
1447
1475
|
* World Street Map raster map.</p>
|
|
1448
1476
|
* </li>
|
|
1449
1477
|
* <li>
|
|
1450
|
-
*
|
|
1478
|
+
* <p>
|
|
1451
1479
|
* <code>VectorEsriNavigation</code> – The Esri World Navigation map style, which
|
|
1452
1480
|
* provides a detailed basemap for the world symbolized with a custom navigation
|
|
1453
1481
|
* map style that's designed for use during the day in mobile devices.</p>
|
|
1454
1482
|
* </li>
|
|
1455
1483
|
* </ul>
|
|
1456
|
-
*
|
|
1484
|
+
* <p>Valid <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE
|
|
1457
1485
|
* Technologies map styles</a>:</p>
|
|
1458
|
-
*
|
|
1486
|
+
* <ul>
|
|
1459
1487
|
* <li>
|
|
1460
|
-
*
|
|
1488
|
+
* <p>
|
|
1461
1489
|
* <code>VectorHereContrast</code> – The HERE Contrast (Berlin) map style is a
|
|
1462
1490
|
* high contrast
|
|
1463
1491
|
* detailed base map of the world that blends 3D and 2D rendering.</p>
|
|
1464
|
-
*
|
|
1492
|
+
* <note>
|
|
1465
1493
|
* <p>The <code>VectorHereContrast</code> style has been renamed from
|
|
1466
1494
|
* <code>VectorHereBerlin</code>.
|
|
1467
1495
|
* <code>VectorHereBerlin</code> has been deprecated, but will continue to work in
|
|
@@ -1469,30 +1497,30 @@ export interface MapConfiguration {
|
|
|
1469
1497
|
* </note>
|
|
1470
1498
|
* </li>
|
|
1471
1499
|
* <li>
|
|
1472
|
-
*
|
|
1500
|
+
* <p>
|
|
1473
1501
|
* <code>VectorHereExplore</code> – A default HERE map style containing a
|
|
1474
1502
|
* neutral, global map and its features including roads, buildings, landmarks,
|
|
1475
1503
|
* and water features. It also now includes a fully designed map of Japan.</p>
|
|
1476
1504
|
* </li>
|
|
1477
1505
|
* <li>
|
|
1478
|
-
*
|
|
1506
|
+
* <p>
|
|
1479
1507
|
* <code>VectorHereExploreTruck</code> – A global map containing truck
|
|
1480
1508
|
* restrictions and attributes (e.g. width / height / HAZMAT) symbolized with
|
|
1481
1509
|
* highlighted segments and icons on top of HERE Explore to support use cases
|
|
1482
1510
|
* within transport and logistics.</p>
|
|
1483
1511
|
* </li>
|
|
1484
1512
|
* <li>
|
|
1485
|
-
*
|
|
1513
|
+
* <p>
|
|
1486
1514
|
* <code>RasterHereExploreSatellite</code> – A global map containing high
|
|
1487
1515
|
* resolution satellite imagery.</p>
|
|
1488
1516
|
* </li>
|
|
1489
1517
|
* <li>
|
|
1490
|
-
*
|
|
1518
|
+
* <p>
|
|
1491
1519
|
* <code>HybridHereExploreSatellite</code> – A global map displaying the road
|
|
1492
1520
|
* network, street names, and city labels over satellite imagery. This style
|
|
1493
1521
|
* will automatically retrieve both raster and vector tiles, and your charges
|
|
1494
1522
|
* will be based on total tiles retrieved.</p>
|
|
1495
|
-
*
|
|
1523
|
+
* <note>
|
|
1496
1524
|
* <p>Hybrid styles use both vector and raster tiles when rendering the
|
|
1497
1525
|
* map that you see. This means that more tiles are retrieved than when using
|
|
1498
1526
|
* either vector or raster tiles alone. Your charges will include all tiles
|
|
@@ -1500,16 +1528,37 @@ export interface MapConfiguration {
|
|
|
1500
1528
|
* </note>
|
|
1501
1529
|
* </li>
|
|
1502
1530
|
* </ul>
|
|
1503
|
-
*
|
|
1504
|
-
*
|
|
1531
|
+
* <p>Valid <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps map styles</a>:</p>
|
|
1532
|
+
* <ul>
|
|
1505
1533
|
* <li>
|
|
1506
|
-
*
|
|
1534
|
+
* <p>
|
|
1535
|
+
* <code>VectorGrabStandardLight</code> – The Grab Standard Light
|
|
1536
|
+
* map style provides a basemap with detailed land use coloring,
|
|
1537
|
+
* area names, roads, landmarks, and points of interest covering
|
|
1538
|
+
* Southeast Asia.</p>
|
|
1539
|
+
* </li>
|
|
1540
|
+
* <li>
|
|
1541
|
+
* <p>
|
|
1542
|
+
* <code>VectorGrabStandardDark</code> – The Grab Standard Dark
|
|
1543
|
+
* map style provides a dark variation of the standard basemap
|
|
1544
|
+
* covering Southeast Asia.</p>
|
|
1545
|
+
* </li>
|
|
1546
|
+
* </ul>
|
|
1547
|
+
* <note>
|
|
1548
|
+
* <p>Grab provides maps only for countries in Southeast Asia, and is only available
|
|
1549
|
+
* in the Asia Pacific (Singapore) Region (<code>ap-southeast-1</code>).
|
|
1550
|
+
* For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area">GrabMaps countries and area covered</a>.</p>
|
|
1551
|
+
* </note>
|
|
1552
|
+
* <p>Valid <a href="https://docs.aws.amazon.com/location/latest/developerguide/open-data.html">Open Data (Preview) map styles</a>:</p>
|
|
1553
|
+
* <ul>
|
|
1554
|
+
* <li>
|
|
1555
|
+
* <p>
|
|
1507
1556
|
* <code>VectorOpenDataStandardLight</code> – The Open Data Standard Light
|
|
1508
1557
|
* (preview) map style provides a detailed basemap for the world suitable for
|
|
1509
1558
|
* website and mobile application use. The map includes highways major roads,
|
|
1510
1559
|
* minor roads, railways, water features, cities, parks, landmarks, building
|
|
1511
1560
|
* footprints, and administrative boundaries.</p>
|
|
1512
|
-
*
|
|
1561
|
+
* <important>
|
|
1513
1562
|
* <p>Open Data maps is in preview. We may add, change, or remove
|
|
1514
1563
|
* features before announcing general availability. For more information, see
|
|
1515
1564
|
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/open-data.html#open-data-preview">Open Data is in preview release</a>.</p>
|
|
@@ -1522,8 +1571,8 @@ export interface MapConfiguration {
|
|
|
1522
1571
|
export interface CreateMapRequest {
|
|
1523
1572
|
/**
|
|
1524
1573
|
* <p>The name for the map resource.</p>
|
|
1525
|
-
*
|
|
1526
|
-
*
|
|
1574
|
+
* <p>Requirements:</p>
|
|
1575
|
+
* <ul>
|
|
1527
1576
|
* <li>
|
|
1528
1577
|
* <p>Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). </p>
|
|
1529
1578
|
* </li>
|
|
@@ -1531,7 +1580,7 @@ export interface CreateMapRequest {
|
|
|
1531
1580
|
* <p>Must be a unique map resource name. </p>
|
|
1532
1581
|
* </li>
|
|
1533
1582
|
* <li>
|
|
1534
|
-
*
|
|
1583
|
+
* <p>No spaces allowed. For example, <code>ExampleMap</code>.</p>
|
|
1535
1584
|
* </li>
|
|
1536
1585
|
* </ul>
|
|
1537
1586
|
*/
|
|
@@ -1591,9 +1640,9 @@ export interface CreateMapResponse {
|
|
|
1591
1640
|
/**
|
|
1592
1641
|
* <p>The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across
|
|
1593
1642
|
* all AWS.</p>
|
|
1594
|
-
*
|
|
1643
|
+
* <ul>
|
|
1595
1644
|
* <li>
|
|
1596
|
-
*
|
|
1645
|
+
* <p>Format example:
|
|
1597
1646
|
* <code>arn:aws:geo:region:account-id:map/ExampleMap</code>
|
|
1598
1647
|
* </p>
|
|
1599
1648
|
* </li>
|
|
@@ -1609,40 +1658,40 @@ export interface CreateMapResponse {
|
|
|
1609
1658
|
export declare type IntendedUse = "SingleUse" | "Storage";
|
|
1610
1659
|
/**
|
|
1611
1660
|
* <p>Specifies the data storage option chosen for requesting Places.</p>
|
|
1612
|
-
*
|
|
1661
|
+
* <important>
|
|
1613
1662
|
* <p>When using Amazon Location Places:</p>
|
|
1614
1663
|
* <ul>
|
|
1615
1664
|
* <li>
|
|
1616
|
-
*
|
|
1665
|
+
* <p>If using HERE Technologies as a data provider, you can't store results for
|
|
1617
1666
|
* locations in Japan by setting <code>IntendedUse</code> to
|
|
1618
1667
|
* <code>Storage</code>. parameter.</p>
|
|
1619
|
-
*
|
|
1668
|
+
* </li>
|
|
1620
1669
|
* <li>
|
|
1621
|
-
*
|
|
1670
|
+
* <p>Under the <code>MobileAssetTracking</code> or
|
|
1622
1671
|
* <code>MobilAssetManagement</code> pricing plan, you can't store results
|
|
1623
1672
|
* from your place index resources by setting <code>IntendedUse</code> to
|
|
1624
1673
|
* <code>Storage</code>. This returns a validation exception error.</p>
|
|
1625
|
-
*
|
|
1674
|
+
* </li>
|
|
1626
1675
|
* </ul>
|
|
1627
1676
|
* <p>For more information, see the <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a> for Amazon Location Service.</p>
|
|
1628
|
-
*
|
|
1677
|
+
* </important>
|
|
1629
1678
|
*/
|
|
1630
1679
|
export interface DataSourceConfiguration {
|
|
1631
1680
|
/**
|
|
1632
1681
|
* <p>Specifies how the results of an operation will be stored by the caller. </p>
|
|
1633
|
-
*
|
|
1634
|
-
*
|
|
1682
|
+
* <p>Valid values include:</p>
|
|
1683
|
+
* <ul>
|
|
1635
1684
|
* <li>
|
|
1636
|
-
*
|
|
1685
|
+
* <p>
|
|
1637
1686
|
* <code>SingleUse</code> specifies that the results won't be stored. </p>
|
|
1638
1687
|
* </li>
|
|
1639
1688
|
* <li>
|
|
1640
|
-
*
|
|
1689
|
+
* <p>
|
|
1641
1690
|
* <code>Storage</code> specifies that the result can be cached or stored in a
|
|
1642
1691
|
* database.</p>
|
|
1643
1692
|
* </li>
|
|
1644
1693
|
* </ul>
|
|
1645
|
-
*
|
|
1694
|
+
* <p>Default value: <code>SingleUse</code>
|
|
1646
1695
|
* </p>
|
|
1647
1696
|
*/
|
|
1648
1697
|
IntendedUse?: IntendedUse | string;
|
|
@@ -1650,46 +1699,51 @@ export interface DataSourceConfiguration {
|
|
|
1650
1699
|
export interface CreatePlaceIndexRequest {
|
|
1651
1700
|
/**
|
|
1652
1701
|
* <p>The name of the place index resource. </p>
|
|
1653
|
-
*
|
|
1654
|
-
*
|
|
1702
|
+
* <p>Requirements:</p>
|
|
1703
|
+
* <ul>
|
|
1655
1704
|
* <li>
|
|
1656
|
-
*
|
|
1705
|
+
* <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods
|
|
1657
1706
|
* (.), and underscores (_).</p>
|
|
1658
1707
|
* </li>
|
|
1659
1708
|
* <li>
|
|
1660
|
-
*
|
|
1709
|
+
* <p>Must be a unique place index resource name.</p>
|
|
1661
1710
|
* </li>
|
|
1662
1711
|
* <li>
|
|
1663
|
-
*
|
|
1712
|
+
* <p>No spaces allowed. For example, <code>ExamplePlaceIndex</code>.</p>
|
|
1664
1713
|
* </li>
|
|
1665
1714
|
* </ul>
|
|
1666
1715
|
*/
|
|
1667
1716
|
IndexName: string | undefined;
|
|
1668
1717
|
/**
|
|
1669
1718
|
* <p>Specifies the geospatial data provider for the new place index.</p>
|
|
1670
|
-
*
|
|
1719
|
+
* <note>
|
|
1671
1720
|
* <p>This field is case-sensitive. Enter the valid values as shown. For example,
|
|
1672
1721
|
* entering <code>HERE</code> returns an error.</p>
|
|
1673
|
-
*
|
|
1674
|
-
*
|
|
1675
|
-
*
|
|
1722
|
+
* </note>
|
|
1723
|
+
* <p>Valid values include:</p>
|
|
1724
|
+
* <ul>
|
|
1676
1725
|
* <li>
|
|
1677
|
-
*
|
|
1726
|
+
* <p>
|
|
1678
1727
|
* <code>Esri</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a>'s coverage in your region of interest, see <a href="https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm">Esri details on geocoding coverage</a>.</p>
|
|
1679
1728
|
* </li>
|
|
1680
1729
|
* <li>
|
|
1681
|
-
*
|
|
1730
|
+
* <p>
|
|
1731
|
+
* <code>Grab</code> – Grab provides place index functionality for Southeast
|
|
1732
|
+
* Asia. For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps</a>' coverage, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area">GrabMaps countries and areas covered</a>.</p>
|
|
1733
|
+
* </li>
|
|
1734
|
+
* <li>
|
|
1735
|
+
* <p>
|
|
1682
1736
|
* <code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE
|
|
1683
1737
|
* Technologies</a>' coverage in your region of interest, see <a href="https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html">HERE details on goecoding coverage</a>.</p>
|
|
1684
|
-
*
|
|
1685
|
-
*
|
|
1738
|
+
* <important>
|
|
1739
|
+
* <p>If you specify HERE Technologies (<code>Here</code>) as the data provider,
|
|
1686
1740
|
* you may not <a href="https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html">store results</a> for locations in Japan. For more information, see
|
|
1687
1741
|
* the <a href="https://aws.amazon.com/service-terms/">AWS Service
|
|
1688
1742
|
* Terms</a> for Amazon Location Service.</p>
|
|
1689
|
-
*
|
|
1743
|
+
* </important>
|
|
1690
1744
|
* </li>
|
|
1691
1745
|
* </ul>
|
|
1692
|
-
*
|
|
1746
|
+
* <p>For additional information , see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Data
|
|
1693
1747
|
* providers</a> on the <i>Amazon Location Service Developer Guide</i>.</p>
|
|
1694
1748
|
*/
|
|
1695
1749
|
DataSource: string | undefined;
|
|
@@ -1711,28 +1765,28 @@ export interface CreatePlaceIndexRequest {
|
|
|
1711
1765
|
/**
|
|
1712
1766
|
* <p>Applies one or more tags to the place index resource. A tag is a key-value pair that
|
|
1713
1767
|
* helps you manage, identify, search, and filter your resources.</p>
|
|
1714
|
-
*
|
|
1768
|
+
* <p>Format: <code>"key" : "value"</code>
|
|
1715
1769
|
* </p>
|
|
1716
|
-
*
|
|
1717
|
-
*
|
|
1770
|
+
* <p>Restrictions:</p>
|
|
1771
|
+
* <ul>
|
|
1718
1772
|
* <li>
|
|
1719
|
-
*
|
|
1773
|
+
* <p>Maximum 50 tags per resource.</p>
|
|
1720
1774
|
* </li>
|
|
1721
1775
|
* <li>
|
|
1722
|
-
*
|
|
1776
|
+
* <p>Each tag key must be unique and must have exactly one associated value.</p>
|
|
1723
1777
|
* </li>
|
|
1724
1778
|
* <li>
|
|
1725
|
-
*
|
|
1779
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
1726
1780
|
* </li>
|
|
1727
1781
|
* <li>
|
|
1728
|
-
*
|
|
1782
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
1729
1783
|
* </li>
|
|
1730
1784
|
* <li>
|
|
1731
|
-
*
|
|
1785
|
+
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
|
|
1732
1786
|
* + - = . _ : / @</p>
|
|
1733
1787
|
* </li>
|
|
1734
1788
|
* <li>
|
|
1735
|
-
*
|
|
1789
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
1736
1790
|
* </li>
|
|
1737
1791
|
* </ul>
|
|
1738
1792
|
*/
|
|
@@ -1746,9 +1800,9 @@ export interface CreatePlaceIndexResponse {
|
|
|
1746
1800
|
/**
|
|
1747
1801
|
* <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a
|
|
1748
1802
|
* resource across AWS. </p>
|
|
1749
|
-
*
|
|
1803
|
+
* <ul>
|
|
1750
1804
|
* <li>
|
|
1751
|
-
*
|
|
1805
|
+
* <p>Format example:
|
|
1752
1806
|
* <code>arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex</code>
|
|
1753
1807
|
* </p>
|
|
1754
1808
|
* </li>
|
|
@@ -1764,41 +1818,49 @@ export interface CreatePlaceIndexResponse {
|
|
|
1764
1818
|
export interface CreateRouteCalculatorRequest {
|
|
1765
1819
|
/**
|
|
1766
1820
|
* <p>The name of the route calculator resource. </p>
|
|
1767
|
-
*
|
|
1768
|
-
*
|
|
1821
|
+
* <p>Requirements:</p>
|
|
1822
|
+
* <ul>
|
|
1769
1823
|
* <li>
|
|
1770
|
-
*
|
|
1824
|
+
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.),
|
|
1771
1825
|
* and underscores (_).</p>
|
|
1772
1826
|
* </li>
|
|
1773
1827
|
* <li>
|
|
1774
|
-
*
|
|
1828
|
+
* <p>Must be a unique Route calculator resource name.</p>
|
|
1775
1829
|
* </li>
|
|
1776
1830
|
* <li>
|
|
1777
|
-
*
|
|
1831
|
+
* <p>No spaces allowed. For example, <code>ExampleRouteCalculator</code>.</p>
|
|
1778
1832
|
* </li>
|
|
1779
1833
|
* </ul>
|
|
1780
1834
|
*/
|
|
1781
1835
|
CalculatorName: string | undefined;
|
|
1782
1836
|
/**
|
|
1783
1837
|
* <p>Specifies the data provider of traffic and road network data.</p>
|
|
1784
|
-
*
|
|
1838
|
+
* <note>
|
|
1785
1839
|
* <p>This field is case-sensitive. Enter the valid values as shown. For example,
|
|
1786
|
-
* entering <code>HERE</code> returns an error
|
|
1787
|
-
*
|
|
1788
|
-
*
|
|
1789
|
-
*
|
|
1790
|
-
* <ul>
|
|
1840
|
+
* entering <code>HERE</code> returns an error.</p>
|
|
1841
|
+
* </note>
|
|
1842
|
+
* <p>Valid values include:</p>
|
|
1843
|
+
* <ul>
|
|
1791
1844
|
* <li>
|
|
1792
|
-
*
|
|
1845
|
+
* <p>
|
|
1793
1846
|
* <code>Esri</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a>'s coverage in your region of interest, see <a href="https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm">Esri details on street networks and traffic coverage</a>.</p>
|
|
1847
|
+
* <p>Route calculators that use Esri as a
|
|
1848
|
+
* data source only calculate routes that are shorter than 400 km.</p>
|
|
1794
1849
|
* </li>
|
|
1795
1850
|
* <li>
|
|
1796
|
-
*
|
|
1851
|
+
* <p>
|
|
1852
|
+
* <code>Grab</code> – Grab provides routing functionality for Southeast Asia.
|
|
1853
|
+
* For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps</a>' coverage,
|
|
1854
|
+
* see <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area">GrabMaps
|
|
1855
|
+
* countries and areas covered</a>.</p>
|
|
1856
|
+
* </li>
|
|
1857
|
+
* <li>
|
|
1858
|
+
* <p>
|
|
1797
1859
|
* <code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE
|
|
1798
1860
|
* Technologies</a>' coverage in your region of interest, see <a href="https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html">HERE car routing coverage</a> and <a href="https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html">HERE truck routing coverage</a>.</p>
|
|
1799
1861
|
* </li>
|
|
1800
1862
|
* </ul>
|
|
1801
|
-
*
|
|
1863
|
+
* <p>For additional information , see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Data
|
|
1802
1864
|
* providers</a> on the <i>Amazon Location Service Developer Guide</i>.</p>
|
|
1803
1865
|
*/
|
|
1804
1866
|
DataSource: string | undefined;
|
|
@@ -1816,34 +1878,34 @@ export interface CreateRouteCalculatorRequest {
|
|
|
1816
1878
|
/**
|
|
1817
1879
|
* <p>Applies one or more tags to the route calculator resource. A tag is a key-value pair
|
|
1818
1880
|
* helps manage, identify, search, and filter your resources by labelling them.</p>
|
|
1819
|
-
*
|
|
1881
|
+
* <ul>
|
|
1820
1882
|
* <li>
|
|
1821
|
-
*
|
|
1883
|
+
* <p>For example: { <code>"tag1" : "value1"</code>, <code>"tag2" :
|
|
1822
1884
|
* "value2"</code>}</p>
|
|
1823
1885
|
* </li>
|
|
1824
1886
|
* </ul>
|
|
1825
|
-
*
|
|
1887
|
+
* <p>Format: <code>"key" : "value"</code>
|
|
1826
1888
|
* </p>
|
|
1827
|
-
*
|
|
1828
|
-
*
|
|
1889
|
+
* <p>Restrictions:</p>
|
|
1890
|
+
* <ul>
|
|
1829
1891
|
* <li>
|
|
1830
|
-
*
|
|
1892
|
+
* <p>Maximum 50 tags per resource</p>
|
|
1831
1893
|
* </li>
|
|
1832
1894
|
* <li>
|
|
1833
|
-
*
|
|
1895
|
+
* <p>Each resource tag must be unique with a maximum of one value.</p>
|
|
1834
1896
|
* </li>
|
|
1835
1897
|
* <li>
|
|
1836
|
-
*
|
|
1898
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8</p>
|
|
1837
1899
|
* </li>
|
|
1838
1900
|
* <li>
|
|
1839
|
-
*
|
|
1901
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8</p>
|
|
1840
1902
|
* </li>
|
|
1841
1903
|
* <li>
|
|
1842
|
-
*
|
|
1904
|
+
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
|
|
1843
1905
|
* + - = . _ : / @. </p>
|
|
1844
1906
|
* </li>
|
|
1845
1907
|
* <li>
|
|
1846
|
-
*
|
|
1908
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
1847
1909
|
* </li>
|
|
1848
1910
|
* </ul>
|
|
1849
1911
|
*/
|
|
@@ -1852,9 +1914,9 @@ export interface CreateRouteCalculatorRequest {
|
|
|
1852
1914
|
export interface CreateRouteCalculatorResponse {
|
|
1853
1915
|
/**
|
|
1854
1916
|
* <p>The name of the route calculator resource. </p>
|
|
1855
|
-
*
|
|
1917
|
+
* <ul>
|
|
1856
1918
|
* <li>
|
|
1857
|
-
*
|
|
1919
|
+
* <p>For example, <code>ExampleRouteCalculator</code>.</p>
|
|
1858
1920
|
* </li>
|
|
1859
1921
|
* </ul>
|
|
1860
1922
|
*/
|
|
@@ -1862,9 +1924,9 @@ export interface CreateRouteCalculatorResponse {
|
|
|
1862
1924
|
/**
|
|
1863
1925
|
* <p>The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you
|
|
1864
1926
|
* specify a resource across all AWS.</p>
|
|
1865
|
-
*
|
|
1927
|
+
* <ul>
|
|
1866
1928
|
* <li>
|
|
1867
|
-
*
|
|
1929
|
+
* <p>Format example:
|
|
1868
1930
|
* <code>arn:aws:geo:region:account-id:route-calculator/ExampleCalculator</code>
|
|
1869
1931
|
* </p>
|
|
1870
1932
|
* </li>
|
|
@@ -1874,9 +1936,9 @@ export interface CreateRouteCalculatorResponse {
|
|
|
1874
1936
|
/**
|
|
1875
1937
|
* <p>The timestamp when the route calculator resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
1876
1938
|
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
1877
|
-
*
|
|
1939
|
+
* <ul>
|
|
1878
1940
|
* <li>
|
|
1879
|
-
*
|
|
1941
|
+
* <p>For example, <code>2020–07-2T12:15:20.000Z+01:00</code>
|
|
1880
1942
|
* </p>
|
|
1881
1943
|
* </li>
|
|
1882
1944
|
* </ul>
|
|
@@ -1896,7 +1958,7 @@ export interface CreateTrackerRequest {
|
|
|
1896
1958
|
* <p>Must be a unique tracker resource name.</p>
|
|
1897
1959
|
* </li>
|
|
1898
1960
|
* <li>
|
|
1899
|
-
*
|
|
1961
|
+
* <p>No spaces allowed. For example, <code>ExampleTracker</code>.</p>
|
|
1900
1962
|
* </li>
|
|
1901
1963
|
* </ul>
|
|
1902
1964
|
*/
|
|
@@ -1925,54 +1987,54 @@ export interface CreateTrackerRequest {
|
|
|
1925
1987
|
/**
|
|
1926
1988
|
* <p>Applies one or more tags to the tracker resource. A tag is a key-value pair helps
|
|
1927
1989
|
* manage, identify, search, and filter your resources by labelling them.</p>
|
|
1928
|
-
*
|
|
1990
|
+
* <p>Format: <code>"key" : "value"</code>
|
|
1929
1991
|
* </p>
|
|
1930
|
-
*
|
|
1931
|
-
*
|
|
1992
|
+
* <p>Restrictions:</p>
|
|
1993
|
+
* <ul>
|
|
1932
1994
|
* <li>
|
|
1933
|
-
*
|
|
1995
|
+
* <p>Maximum 50 tags per resource</p>
|
|
1934
1996
|
* </li>
|
|
1935
1997
|
* <li>
|
|
1936
|
-
*
|
|
1998
|
+
* <p>Each resource tag must be unique with a maximum of one value.</p>
|
|
1937
1999
|
* </li>
|
|
1938
2000
|
* <li>
|
|
1939
|
-
*
|
|
2001
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8</p>
|
|
1940
2002
|
* </li>
|
|
1941
2003
|
* <li>
|
|
1942
|
-
*
|
|
2004
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8</p>
|
|
1943
2005
|
* </li>
|
|
1944
2006
|
* <li>
|
|
1945
|
-
*
|
|
2007
|
+
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
|
|
1946
2008
|
* + - = . _ : / @. </p>
|
|
1947
2009
|
* </li>
|
|
1948
2010
|
* <li>
|
|
1949
|
-
*
|
|
2011
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
1950
2012
|
* </li>
|
|
1951
2013
|
* </ul>
|
|
1952
2014
|
*/
|
|
1953
2015
|
Tags?: Record<string, string>;
|
|
1954
2016
|
/**
|
|
1955
2017
|
* <p>Specifies the position filtering for the tracker resource.</p>
|
|
1956
|
-
*
|
|
1957
|
-
*
|
|
2018
|
+
* <p>Valid values:</p>
|
|
2019
|
+
* <ul>
|
|
1958
2020
|
* <li>
|
|
1959
|
-
*
|
|
1960
|
-
*
|
|
2021
|
+
* <p>
|
|
2022
|
+
* <code>TimeBased</code> - Location updates are evaluated against linked geofence collections,
|
|
1961
2023
|
* but not every location update is stored. If your update frequency is more often than 30 seconds,
|
|
1962
2024
|
* only one update per 30 seconds is stored for each unique device ID.
|
|
1963
2025
|
* </p>
|
|
1964
2026
|
* </li>
|
|
1965
2027
|
* <li>
|
|
1966
|
-
*
|
|
1967
|
-
*
|
|
2028
|
+
* <p>
|
|
2029
|
+
* <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are
|
|
1968
2030
|
* ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored.
|
|
1969
2031
|
* This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through.
|
|
1970
2032
|
* Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
|
|
1971
2033
|
* </p>
|
|
1972
2034
|
* </li>
|
|
1973
2035
|
* <li>
|
|
1974
|
-
*
|
|
1975
|
-
*
|
|
2036
|
+
* <p>
|
|
2037
|
+
* <code>AccuracyBased</code> - If the device has moved less than the measured accuracy,
|
|
1976
2038
|
* location updates are ignored. For example, if two consecutive updates from a device
|
|
1977
2039
|
* have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device
|
|
1978
2040
|
* has moved less than 15 m. Ignored location updates are neither evaluated against
|
|
@@ -1982,7 +2044,7 @@ export interface CreateTrackerRequest {
|
|
|
1982
2044
|
* </p>
|
|
1983
2045
|
* </li>
|
|
1984
2046
|
* </ul>
|
|
1985
|
-
*
|
|
2047
|
+
* <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>
|
|
1986
2048
|
*/
|
|
1987
2049
|
PositionFiltering?: PositionFiltering | string;
|
|
1988
2050
|
}
|
|
@@ -1994,9 +2056,9 @@ export interface CreateTrackerResponse {
|
|
|
1994
2056
|
/**
|
|
1995
2057
|
* <p>The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify
|
|
1996
2058
|
* a resource across all AWS.</p>
|
|
1997
|
-
*
|
|
2059
|
+
* <ul>
|
|
1998
2060
|
* <li>
|
|
1999
|
-
*
|
|
2061
|
+
* <p>Format example:
|
|
2000
2062
|
* <code>arn:aws:geo:region:account-id:tracker/ExampleTracker</code>
|
|
2001
2063
|
* </p>
|
|
2002
2064
|
* </li>
|
|
@@ -2063,9 +2125,9 @@ export interface DescribeGeofenceCollectionResponse {
|
|
|
2063
2125
|
/**
|
|
2064
2126
|
* <p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you
|
|
2065
2127
|
* need to specify a resource across all AWS. </p>
|
|
2066
|
-
*
|
|
2128
|
+
* <ul>
|
|
2067
2129
|
* <li>
|
|
2068
|
-
*
|
|
2130
|
+
* <p>Format example:
|
|
2069
2131
|
* <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection</code>
|
|
2070
2132
|
* </p>
|
|
2071
2133
|
* </li>
|
|
@@ -2123,9 +2185,9 @@ export interface DescribeMapResponse {
|
|
|
2123
2185
|
/**
|
|
2124
2186
|
* <p>The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across
|
|
2125
2187
|
* all AWS.</p>
|
|
2126
|
-
*
|
|
2188
|
+
* <ul>
|
|
2127
2189
|
* <li>
|
|
2128
|
-
*
|
|
2190
|
+
* <p>Format example:
|
|
2129
2191
|
* <code>arn:aws:geo:region:account-id:map/ExampleMap</code>
|
|
2130
2192
|
* </p>
|
|
2131
2193
|
* </li>
|
|
@@ -2179,9 +2241,9 @@ export interface DescribePlaceIndexResponse {
|
|
|
2179
2241
|
/**
|
|
2180
2242
|
* <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a
|
|
2181
2243
|
* resource across AWS. </p>
|
|
2182
|
-
*
|
|
2244
|
+
* <ul>
|
|
2183
2245
|
* <li>
|
|
2184
|
-
*
|
|
2246
|
+
* <p>Format example:
|
|
2185
2247
|
* <code>arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex</code>
|
|
2186
2248
|
* </p>
|
|
2187
2249
|
* </li>
|
|
@@ -2210,19 +2272,24 @@ export interface DescribePlaceIndexResponse {
|
|
|
2210
2272
|
UpdateTime: Date | undefined;
|
|
2211
2273
|
/**
|
|
2212
2274
|
* <p>The data provider of geospatial data. Values can be one of the following:</p>
|
|
2213
|
-
*
|
|
2275
|
+
* <ul>
|
|
2214
2276
|
* <li>
|
|
2215
|
-
*
|
|
2277
|
+
* <p>
|
|
2216
2278
|
* <code>Esri</code>
|
|
2217
2279
|
* </p>
|
|
2218
2280
|
* </li>
|
|
2219
2281
|
* <li>
|
|
2220
|
-
*
|
|
2282
|
+
* <p>
|
|
2283
|
+
* <code>Grab</code>
|
|
2284
|
+
* </p>
|
|
2285
|
+
* </li>
|
|
2286
|
+
* <li>
|
|
2287
|
+
* <p>
|
|
2221
2288
|
* <code>Here</code>
|
|
2222
2289
|
* </p>
|
|
2223
2290
|
* </li>
|
|
2224
2291
|
* </ul>
|
|
2225
|
-
*
|
|
2292
|
+
* <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
|
|
2226
2293
|
*/
|
|
2227
2294
|
DataSource: string | undefined;
|
|
2228
2295
|
/**
|
|
@@ -2248,9 +2315,9 @@ export interface DescribeRouteCalculatorResponse {
|
|
|
2248
2315
|
/**
|
|
2249
2316
|
* <p>The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you
|
|
2250
2317
|
* specify a resource across AWS.</p>
|
|
2251
|
-
*
|
|
2318
|
+
* <ul>
|
|
2252
2319
|
* <li>
|
|
2253
|
-
*
|
|
2320
|
+
* <p>Format example:
|
|
2254
2321
|
* <code>arn:aws:geo:region:account-id:route-calculator/ExampleCalculator</code>
|
|
2255
2322
|
* </p>
|
|
2256
2323
|
* </li>
|
|
@@ -2270,9 +2337,9 @@ export interface DescribeRouteCalculatorResponse {
|
|
|
2270
2337
|
/**
|
|
2271
2338
|
* <p>The timestamp when the route calculator resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
2272
2339
|
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
2273
|
-
*
|
|
2340
|
+
* <ul>
|
|
2274
2341
|
* <li>
|
|
2275
|
-
*
|
|
2342
|
+
* <p>For example, <code>2020–07-2T12:15:20.000Z+01:00</code>
|
|
2276
2343
|
* </p>
|
|
2277
2344
|
* </li>
|
|
2278
2345
|
* </ul>
|
|
@@ -2281,9 +2348,9 @@ export interface DescribeRouteCalculatorResponse {
|
|
|
2281
2348
|
/**
|
|
2282
2349
|
* <p>The timestamp when the route calculator resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
2283
2350
|
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
2284
|
-
*
|
|
2351
|
+
* <ul>
|
|
2285
2352
|
* <li>
|
|
2286
|
-
*
|
|
2353
|
+
* <p>For example, <code>2020–07-2T12:15:20.000Z+01:00</code>
|
|
2287
2354
|
* </p>
|
|
2288
2355
|
* </li>
|
|
2289
2356
|
* </ul>
|
|
@@ -2292,19 +2359,24 @@ export interface DescribeRouteCalculatorResponse {
|
|
|
2292
2359
|
/**
|
|
2293
2360
|
* <p>The data provider of traffic and road network data. Indicates one of the available
|
|
2294
2361
|
* providers:</p>
|
|
2295
|
-
*
|
|
2362
|
+
* <ul>
|
|
2296
2363
|
* <li>
|
|
2297
|
-
*
|
|
2364
|
+
* <p>
|
|
2298
2365
|
* <code>Esri</code>
|
|
2299
2366
|
* </p>
|
|
2300
2367
|
* </li>
|
|
2301
2368
|
* <li>
|
|
2302
|
-
*
|
|
2369
|
+
* <p>
|
|
2370
|
+
* <code>Grab</code>
|
|
2371
|
+
* </p>
|
|
2372
|
+
* </li>
|
|
2373
|
+
* <li>
|
|
2374
|
+
* <p>
|
|
2303
2375
|
* <code>Here</code>
|
|
2304
2376
|
* </p>
|
|
2305
2377
|
* </li>
|
|
2306
2378
|
* </ul>
|
|
2307
|
-
*
|
|
2379
|
+
* <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
|
|
2308
2380
|
*/
|
|
2309
2381
|
DataSource: string | undefined;
|
|
2310
2382
|
/**
|
|
@@ -2326,9 +2398,9 @@ export interface DescribeTrackerResponse {
|
|
|
2326
2398
|
/**
|
|
2327
2399
|
* <p>The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify
|
|
2328
2400
|
* a resource across all AWS.</p>
|
|
2329
|
-
*
|
|
2401
|
+
* <ul>
|
|
2330
2402
|
* <li>
|
|
2331
|
-
*
|
|
2403
|
+
* <p>Format example:
|
|
2332
2404
|
* <code>arn:aws:geo:region:account-id:tracker/ExampleTracker</code>
|
|
2333
2405
|
* </p>
|
|
2334
2406
|
* </li>
|
|
@@ -2382,9 +2454,9 @@ export interface DisassociateTrackerConsumerRequest {
|
|
|
2382
2454
|
/**
|
|
2383
2455
|
* <p>The Amazon Resource Name (ARN) for the geofence collection to be disassociated from
|
|
2384
2456
|
* the tracker resource. Used when you need to specify a resource across all AWS. </p>
|
|
2385
|
-
*
|
|
2457
|
+
* <ul>
|
|
2386
2458
|
* <li>
|
|
2387
|
-
*
|
|
2459
|
+
* <p>Format example:
|
|
2388
2460
|
* <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer</code>
|
|
2389
2461
|
* </p>
|
|
2390
2462
|
* </li>
|
|
@@ -2397,7 +2469,7 @@ export interface DisassociateTrackerConsumerResponse {
|
|
|
2397
2469
|
export interface ListTagsForResourceRequest {
|
|
2398
2470
|
/**
|
|
2399
2471
|
* <p>The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.</p>
|
|
2400
|
-
*
|
|
2472
|
+
* <ul>
|
|
2401
2473
|
* <li>
|
|
2402
2474
|
* <p>Format example: <code>arn:aws:geo:region:account-id:resourcetype/ExampleResource</code>
|
|
2403
2475
|
* </p>
|
|
@@ -2409,7 +2481,7 @@ export interface ListTagsForResourceRequest {
|
|
|
2409
2481
|
export interface ListTagsForResourceResponse {
|
|
2410
2482
|
/**
|
|
2411
2483
|
* <p>Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: <code>"TagKey" : "TagValue"</code>.</p>
|
|
2412
|
-
*
|
|
2484
|
+
* <ul>
|
|
2413
2485
|
* <li>
|
|
2414
2486
|
* <p>Format example: <code>{"tag1" : "value1", "tag2" : "value2"} </code>
|
|
2415
2487
|
* </p>
|
|
@@ -2421,7 +2493,7 @@ export interface ListTagsForResourceResponse {
|
|
|
2421
2493
|
export interface TagResourceRequest {
|
|
2422
2494
|
/**
|
|
2423
2495
|
* <p>The Amazon Resource Name (ARN) of the resource whose tags you want to update.</p>
|
|
2424
|
-
*
|
|
2496
|
+
* <ul>
|
|
2425
2497
|
* <li>
|
|
2426
2498
|
* <p>Format example: <code>arn:aws:geo:region:account-id:resourcetype/ExampleResource</code>
|
|
2427
2499
|
* </p>
|
|
@@ -2432,28 +2504,28 @@ export interface TagResourceRequest {
|
|
|
2432
2504
|
/**
|
|
2433
2505
|
* <p>Applies one or more tags to specific resource. A tag is a key-value pair that helps you
|
|
2434
2506
|
* manage, identify, search, and filter your resources.</p>
|
|
2435
|
-
*
|
|
2507
|
+
* <p>Format: <code>"key" : "value"</code>
|
|
2436
2508
|
* </p>
|
|
2437
|
-
*
|
|
2438
|
-
*
|
|
2509
|
+
* <p>Restrictions:</p>
|
|
2510
|
+
* <ul>
|
|
2439
2511
|
* <li>
|
|
2440
|
-
*
|
|
2512
|
+
* <p>Maximum 50 tags per resource.</p>
|
|
2441
2513
|
* </li>
|
|
2442
2514
|
* <li>
|
|
2443
|
-
*
|
|
2515
|
+
* <p>Each tag key must be unique and must have exactly one associated value.</p>
|
|
2444
2516
|
* </li>
|
|
2445
2517
|
* <li>
|
|
2446
|
-
*
|
|
2518
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
2447
2519
|
* </li>
|
|
2448
2520
|
* <li>
|
|
2449
|
-
*
|
|
2521
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
2450
2522
|
* </li>
|
|
2451
2523
|
* <li>
|
|
2452
|
-
*
|
|
2524
|
+
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + -
|
|
2453
2525
|
* = . _ : / @</p>
|
|
2454
2526
|
* </li>
|
|
2455
2527
|
* <li>
|
|
2456
|
-
*
|
|
2528
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
2457
2529
|
* </li>
|
|
2458
2530
|
* </ul>
|
|
2459
2531
|
*/
|
|
@@ -2464,7 +2536,7 @@ export interface TagResourceResponse {
|
|
|
2464
2536
|
export interface UntagResourceRequest {
|
|
2465
2537
|
/**
|
|
2466
2538
|
* <p>The Amazon Resource Name (ARN) of the resource from which you want to remove tags.</p>
|
|
2467
|
-
*
|
|
2539
|
+
* <ul>
|
|
2468
2540
|
* <li>
|
|
2469
2541
|
* <p>Format example: <code>arn:aws:geo:region:account-id:resourcetype/ExampleResource</code>
|
|
2470
2542
|
* </p>
|
|
@@ -2501,26 +2573,26 @@ export interface GetGeofenceResponse {
|
|
|
2501
2573
|
/**
|
|
2502
2574
|
* <p>Identifies the state of the geofence. A geofence will hold one of the following
|
|
2503
2575
|
* states:</p>
|
|
2504
|
-
*
|
|
2576
|
+
* <ul>
|
|
2505
2577
|
* <li>
|
|
2506
|
-
*
|
|
2578
|
+
* <p>
|
|
2507
2579
|
* <code>ACTIVE</code> — The geofence has been indexed by the system. </p>
|
|
2508
2580
|
* </li>
|
|
2509
2581
|
* <li>
|
|
2510
|
-
*
|
|
2582
|
+
* <p>
|
|
2511
2583
|
* <code>PENDING</code> — The geofence is being processed by the system.</p>
|
|
2512
2584
|
* </li>
|
|
2513
2585
|
* <li>
|
|
2514
|
-
*
|
|
2586
|
+
* <p>
|
|
2515
2587
|
* <code>FAILED</code> — The geofence failed to be indexed by the system.</p>
|
|
2516
2588
|
* </li>
|
|
2517
2589
|
* <li>
|
|
2518
|
-
*
|
|
2590
|
+
* <p>
|
|
2519
2591
|
* <code>DELETED</code> — The geofence has been deleted from the system
|
|
2520
2592
|
* index.</p>
|
|
2521
2593
|
* </li>
|
|
2522
2594
|
* <li>
|
|
2523
|
-
*
|
|
2595
|
+
* <p>
|
|
2524
2596
|
* <code>DELETING</code> — The geofence is being deleted from the system
|
|
2525
2597
|
* index.</p>
|
|
2526
2598
|
* </li>
|
|
@@ -2543,14 +2615,14 @@ export interface GetGeofenceResponse {
|
|
|
2543
2615
|
export interface ListGeofenceCollectionsRequest {
|
|
2544
2616
|
/**
|
|
2545
2617
|
* <p>An optional limit for the number of resources returned in a single call. </p>
|
|
2546
|
-
*
|
|
2618
|
+
* <p>Default value: <code>100</code>
|
|
2547
2619
|
* </p>
|
|
2548
2620
|
*/
|
|
2549
2621
|
MaxResults?: number;
|
|
2550
2622
|
/**
|
|
2551
2623
|
* <p>The pagination token specifying which page of results to return in the response. If no
|
|
2552
2624
|
* token is provided, the default page is the first page. </p>
|
|
2553
|
-
*
|
|
2625
|
+
* <p>Default value: <code>null</code>
|
|
2554
2626
|
* </p>
|
|
2555
2627
|
*/
|
|
2556
2628
|
NextToken?: string;
|
|
@@ -2611,13 +2683,13 @@ export interface ListGeofencesRequest {
|
|
|
2611
2683
|
/**
|
|
2612
2684
|
* <p>The pagination token specifying which page of results to return in the response. If no
|
|
2613
2685
|
* token is provided, the default page is the first page. </p>
|
|
2614
|
-
*
|
|
2686
|
+
* <p>Default value: <code>null</code>
|
|
2615
2687
|
* </p>
|
|
2616
2688
|
*/
|
|
2617
2689
|
NextToken?: string;
|
|
2618
2690
|
/**
|
|
2619
2691
|
* <p>An optional limit for the number of geofences returned in a single call. </p>
|
|
2620
|
-
*
|
|
2692
|
+
* <p>Default value: <code>100</code>
|
|
2621
2693
|
* </p>
|
|
2622
2694
|
*/
|
|
2623
2695
|
MaxResults?: number;
|
|
@@ -2637,26 +2709,26 @@ export interface ListGeofenceResponseEntry {
|
|
|
2637
2709
|
/**
|
|
2638
2710
|
* <p>Identifies the state of the geofence. A geofence will hold one of the following
|
|
2639
2711
|
* states:</p>
|
|
2640
|
-
*
|
|
2712
|
+
* <ul>
|
|
2641
2713
|
* <li>
|
|
2642
|
-
*
|
|
2714
|
+
* <p>
|
|
2643
2715
|
* <code>ACTIVE</code> — The geofence has been indexed by the system. </p>
|
|
2644
2716
|
* </li>
|
|
2645
2717
|
* <li>
|
|
2646
|
-
*
|
|
2718
|
+
* <p>
|
|
2647
2719
|
* <code>PENDING</code> — The geofence is being processed by the system.</p>
|
|
2648
2720
|
* </li>
|
|
2649
2721
|
* <li>
|
|
2650
|
-
*
|
|
2722
|
+
* <p>
|
|
2651
2723
|
* <code>FAILED</code> — The geofence failed to be indexed by the system.</p>
|
|
2652
2724
|
* </li>
|
|
2653
2725
|
* <li>
|
|
2654
|
-
*
|
|
2726
|
+
* <p>
|
|
2655
2727
|
* <code>DELETED</code> — The geofence has been deleted from the system
|
|
2656
2728
|
* index.</p>
|
|
2657
2729
|
* </li>
|
|
2658
2730
|
* <li>
|
|
2659
|
-
*
|
|
2731
|
+
* <p>
|
|
2660
2732
|
* <code>DELETING</code> — The geofence is being deleted from the system
|
|
2661
2733
|
* index.</p>
|
|
2662
2734
|
* </li>
|
|
@@ -2699,10 +2771,10 @@ export interface PutGeofenceRequest {
|
|
|
2699
2771
|
/**
|
|
2700
2772
|
* <p>Contains the details to specify the position of the geofence. Can be either a
|
|
2701
2773
|
* polygon or a circle. Including both will return a validation error.</p>
|
|
2702
|
-
*
|
|
2774
|
+
* <note>
|
|
2703
2775
|
* <p>Each <a href="https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html">
|
|
2704
2776
|
* geofence polygon</a> can have a maximum of 1,000 vertices.</p>
|
|
2705
|
-
*
|
|
2777
|
+
* </note>
|
|
2706
2778
|
*/
|
|
2707
2779
|
Geometry: GeofenceGeometry | undefined;
|
|
2708
2780
|
}
|
|
@@ -2755,9 +2827,9 @@ export interface UpdateGeofenceCollectionResponse {
|
|
|
2755
2827
|
/**
|
|
2756
2828
|
* <p>The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a
|
|
2757
2829
|
* resource across AWS.</p>
|
|
2758
|
-
*
|
|
2830
|
+
* <ul>
|
|
2759
2831
|
* <li>
|
|
2760
|
-
*
|
|
2832
|
+
* <p>Format example:
|
|
2761
2833
|
* <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection</code>
|
|
2762
2834
|
* </p>
|
|
2763
2835
|
* </li>
|
|
@@ -2829,12 +2901,12 @@ export interface GetDevicePositionHistoryRequest {
|
|
|
2829
2901
|
* <p>Specify the start time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
2830
2902
|
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be 24 hours
|
|
2831
2903
|
* prior to the time that the request is made.</p>
|
|
2832
|
-
*
|
|
2904
|
+
* <p>Requirement:</p>
|
|
2833
2905
|
* <ul>
|
|
2834
2906
|
* <li>
|
|
2835
2907
|
* <p>The time specified for <code>StartTimeInclusive</code> must be before
|
|
2836
2908
|
* <code>EndTimeExclusive</code>.</p>
|
|
2837
|
-
*
|
|
2909
|
+
* </li>
|
|
2838
2910
|
* </ul>
|
|
2839
2911
|
*/
|
|
2840
2912
|
StartTimeInclusive?: Date;
|
|
@@ -2842,18 +2914,18 @@ export interface GetDevicePositionHistoryRequest {
|
|
|
2842
2914
|
* <p>Specify the end time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
2843
2915
|
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be the time
|
|
2844
2916
|
* that the request is made.</p>
|
|
2845
|
-
*
|
|
2917
|
+
* <p>Requirement:</p>
|
|
2846
2918
|
* <ul>
|
|
2847
2919
|
* <li>
|
|
2848
2920
|
* <p>The time specified for <code>EndTimeExclusive</code> must be after the time for
|
|
2849
2921
|
* <code>StartTimeInclusive</code>.</p>
|
|
2850
|
-
*
|
|
2922
|
+
* </li>
|
|
2851
2923
|
* </ul>
|
|
2852
2924
|
*/
|
|
2853
2925
|
EndTimeExclusive?: Date;
|
|
2854
2926
|
/**
|
|
2855
2927
|
* <p>An optional limit for the number of device positions returned in a single call.</p>
|
|
2856
|
-
*
|
|
2928
|
+
* <p>Default value: <code>100</code>
|
|
2857
2929
|
* </p>
|
|
2858
2930
|
*/
|
|
2859
2931
|
MaxResults?: number;
|
|
@@ -2877,45 +2949,45 @@ export interface GetMapGlyphsRequest {
|
|
|
2877
2949
|
/**
|
|
2878
2950
|
* <p>A comma-separated list of fonts to load glyphs from in order of preference. For
|
|
2879
2951
|
* example, <code>Noto Sans Regular, Arial Unicode</code>.</p>
|
|
2880
|
-
*
|
|
2881
|
-
*
|
|
2952
|
+
* <p>Valid fonts stacks for <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a> styles: </p>
|
|
2953
|
+
* <ul>
|
|
2882
2954
|
* <li>
|
|
2883
|
-
*
|
|
2955
|
+
* <p>VectorEsriDarkGrayCanvas – <code>Ubuntu Medium Italic</code> | <code>Ubuntu
|
|
2884
2956
|
* Medium</code> | <code>Ubuntu Italic</code> | <code>Ubuntu Regular</code> |
|
|
2885
2957
|
* <code>Ubuntu Bold</code>
|
|
2886
2958
|
* </p>
|
|
2887
2959
|
* </li>
|
|
2888
2960
|
* <li>
|
|
2889
|
-
*
|
|
2961
|
+
* <p>VectorEsriLightGrayCanvas – <code>Ubuntu Italic</code> | <code>Ubuntu
|
|
2890
2962
|
* Regular</code> | <code>Ubuntu Light</code> | <code>Ubuntu Bold</code>
|
|
2891
2963
|
* </p>
|
|
2892
2964
|
* </li>
|
|
2893
2965
|
* <li>
|
|
2894
|
-
*
|
|
2966
|
+
* <p>VectorEsriTopographic – <code>Noto Sans Italic</code> | <code>Noto Sans
|
|
2895
2967
|
* Regular</code> | <code>Noto Sans Bold</code> | <code>Noto Serif
|
|
2896
2968
|
* Regular</code> | <code>Roboto Condensed Light Italic</code>
|
|
2897
2969
|
* </p>
|
|
2898
2970
|
* </li>
|
|
2899
2971
|
* <li>
|
|
2900
|
-
*
|
|
2972
|
+
* <p>VectorEsriStreets – <code>Arial Regular</code> | <code>Arial Italic</code> |
|
|
2901
2973
|
* <code>Arial Bold</code>
|
|
2902
2974
|
* </p>
|
|
2903
2975
|
* </li>
|
|
2904
2976
|
* <li>
|
|
2905
|
-
*
|
|
2977
|
+
* <p>VectorEsriNavigation – <code>Arial Regular</code> | <code>Arial Italic</code>
|
|
2906
2978
|
* | <code>Arial Bold</code>
|
|
2907
2979
|
* </p>
|
|
2908
2980
|
* </li>
|
|
2909
2981
|
* </ul>
|
|
2910
|
-
*
|
|
2911
|
-
*
|
|
2982
|
+
* <p>Valid font stacks for <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE Technologies</a> styles:</p>
|
|
2983
|
+
* <ul>
|
|
2912
2984
|
* <li>
|
|
2913
|
-
*
|
|
2985
|
+
* <p>VectorHereContrast – <code>Fira
|
|
2914
2986
|
* GO Regular</code> | <code>Fira GO Bold</code>
|
|
2915
2987
|
* </p>
|
|
2916
2988
|
* </li>
|
|
2917
2989
|
* <li>
|
|
2918
|
-
*
|
|
2990
|
+
* <p>VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite –
|
|
2919
2991
|
* <code>Fira GO Italic</code> | <code>Fira GO Map</code> |
|
|
2920
2992
|
* <code>Fira GO Map Bold</code> | <code>Noto Sans CJK JP Bold</code> |
|
|
2921
2993
|
* <code>Noto Sans CJK JP Light</code> |
|
|
@@ -2923,10 +2995,20 @@ export interface GetMapGlyphsRequest {
|
|
|
2923
2995
|
* </p>
|
|
2924
2996
|
* </li>
|
|
2925
2997
|
* </ul>
|
|
2926
|
-
*
|
|
2927
|
-
*
|
|
2998
|
+
* <p>Valid font stacks for <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps</a> styles:</p>
|
|
2999
|
+
* <ul>
|
|
3000
|
+
* <li>
|
|
3001
|
+
* <p>VectorGrabStandardLight, VectorGrabStandardDark –
|
|
3002
|
+
* <code>Noto Sans Regular</code> |
|
|
3003
|
+
* <code>Noto Sans Medium</code> |
|
|
3004
|
+
* <code>Noto Sans Bold</code>
|
|
3005
|
+
* </p>
|
|
3006
|
+
* </li>
|
|
3007
|
+
* </ul>
|
|
3008
|
+
* <p>Valid font stacks for <a href="https://docs.aws.amazon.com/location/latest/developerguide/open-data.html">Open Data (Preview)</a> styles:</p>
|
|
3009
|
+
* <ul>
|
|
2928
3010
|
* <li>
|
|
2929
|
-
*
|
|
3011
|
+
* <p>VectorOpenDataStandardLight –
|
|
2930
3012
|
* <code>Amazon Ember Regular,Noto Sans Regular</code> |
|
|
2931
3013
|
* <code>Amazon Ember Bold,Noto Sans Bold</code> |
|
|
2932
3014
|
* <code>Amazon Ember Medium,Noto Sans Medium</code> |
|
|
@@ -2936,11 +3018,11 @@ export interface GetMapGlyphsRequest {
|
|
|
2936
3018
|
* </p>
|
|
2937
3019
|
* </li>
|
|
2938
3020
|
* </ul>
|
|
2939
|
-
*
|
|
3021
|
+
* <note>
|
|
2940
3022
|
* <p>The fonts used by <code>VectorOpenDataStandardLight</code> are combined fonts
|
|
2941
3023
|
* that use <code>Amazon Ember</code> for most glyphs but <code>Noto Sans</code>
|
|
2942
3024
|
* for glyphs unsupported by <code>Amazon Ember</code>.</p>
|
|
2943
|
-
*
|
|
3025
|
+
* </note>
|
|
2944
3026
|
*/
|
|
2945
3027
|
FontStack: string | undefined;
|
|
2946
3028
|
/**
|
|
@@ -2967,7 +3049,7 @@ export interface GetMapSpritesRequest {
|
|
|
2967
3049
|
MapName: string | undefined;
|
|
2968
3050
|
/**
|
|
2969
3051
|
* <p>The name of the sprite file. Use the following file names for the sprite sheet:</p>
|
|
2970
|
-
*
|
|
3052
|
+
* <ul>
|
|
2971
3053
|
* <li>
|
|
2972
3054
|
* <p>
|
|
2973
3055
|
* <code>sprites.png</code>
|
|
@@ -2978,8 +3060,8 @@ export interface GetMapSpritesRequest {
|
|
|
2978
3060
|
* <code>sprites@2x.png</code> for high pixel density displays</p>
|
|
2979
3061
|
* </li>
|
|
2980
3062
|
* </ul>
|
|
2981
|
-
*
|
|
2982
|
-
*
|
|
3063
|
+
* <p>For the JSON document containing image offsets. Use the following file names:</p>
|
|
3064
|
+
* <ul>
|
|
2983
3065
|
* <li>
|
|
2984
3066
|
* <p>
|
|
2985
3067
|
* <code>sprites.json</code>
|
|
@@ -3063,17 +3145,17 @@ export interface GetPlaceRequest {
|
|
|
3063
3145
|
/**
|
|
3064
3146
|
* <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
|
|
3065
3147
|
* <code>en</code> for English.</p>
|
|
3066
|
-
*
|
|
3148
|
+
* <p>This setting affects the languages used in the results, but not the results
|
|
3067
3149
|
* themselves. If no language is specified, or not supported for a particular result, the
|
|
3068
3150
|
* partner automatically chooses a language for the result.</p>
|
|
3069
|
-
*
|
|
3151
|
+
* <p>For an example, we'll use the Greek language. You search for a location around Athens,
|
|
3070
3152
|
* Greece, with the <code>language</code> parameter set to <code>en</code>. The
|
|
3071
3153
|
* <code>city</code> in the results will most likely be returned as
|
|
3072
3154
|
* <code>Athens</code>.</p>
|
|
3073
|
-
*
|
|
3155
|
+
* <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the
|
|
3074
3156
|
* <code>city</code> in the results will more likely be returned as
|
|
3075
3157
|
* <code>Αθήνα</code>.</p>
|
|
3076
|
-
*
|
|
3158
|
+
* <p>If the data provider does not have a value for Greek, the result will be in a language
|
|
3077
3159
|
* that the provider does support.</p>
|
|
3078
3160
|
*/
|
|
3079
3161
|
Language?: string;
|
|
@@ -3085,13 +3167,13 @@ export interface PlaceGeometry {
|
|
|
3085
3167
|
/**
|
|
3086
3168
|
* <p>A single point geometry specifies a location for a Place using <a href="https://gisgeography.com/wgs84-world-geodetic-system/">WGS 84</a>
|
|
3087
3169
|
* coordinates:</p>
|
|
3088
|
-
*
|
|
3170
|
+
* <ul>
|
|
3089
3171
|
* <li>
|
|
3090
|
-
*
|
|
3172
|
+
* <p>
|
|
3091
3173
|
* <i>x</i> — Specifies the x coordinate or longitude. </p>
|
|
3092
3174
|
* </li>
|
|
3093
3175
|
* <li>
|
|
3094
|
-
*
|
|
3176
|
+
* <p>
|
|
3095
3177
|
* <i>y</i> — Specifies the y coordinate or latitude. </p>
|
|
3096
3178
|
* </li>
|
|
3097
3179
|
* </ul>
|
|
@@ -3117,7 +3199,7 @@ export interface TimeZone {
|
|
|
3117
3199
|
/**
|
|
3118
3200
|
* <p>Contains details about addresses or points of interest that match the search
|
|
3119
3201
|
* criteria.</p>
|
|
3120
|
-
*
|
|
3202
|
+
* <p>Not all details are included with all responses. Some details may only be returned by
|
|
3121
3203
|
* specific data partners.</p>
|
|
3122
3204
|
*/
|
|
3123
3205
|
export interface Place {
|
|
@@ -3149,7 +3231,7 @@ export interface Place {
|
|
|
3149
3231
|
*/
|
|
3150
3232
|
Municipality?: string;
|
|
3151
3233
|
/**
|
|
3152
|
-
* <p>A
|
|
3234
|
+
* <p>A county, or an area that's part of a larger region. For example, <code>Metro
|
|
3153
3235
|
* Vancouver</code>.</p>
|
|
3154
3236
|
*/
|
|
3155
3237
|
SubRegion?: string;
|
|
@@ -3171,10 +3253,10 @@ export interface Place {
|
|
|
3171
3253
|
/**
|
|
3172
3254
|
* <p>
|
|
3173
3255
|
* <code>True</code> if the result is interpolated from other known places.</p>
|
|
3174
|
-
*
|
|
3256
|
+
* <p>
|
|
3175
3257
|
* <code>False</code> if the Place is a known place.</p>
|
|
3176
|
-
*
|
|
3177
|
-
*
|
|
3258
|
+
* <p>Not returned when the partner does not provide the information.</p>
|
|
3259
|
+
* <p>For example, returns <code>False</code> for an address location that is found in the
|
|
3178
3260
|
* partner data, but returns <code>True</code> if an address does not exist in the partner
|
|
3179
3261
|
* data and its location is calculated by interpolating between other known addresses.
|
|
3180
3262
|
* </p>
|
|
@@ -3193,10 +3275,10 @@ export interface Place {
|
|
|
3193
3275
|
/**
|
|
3194
3276
|
* <p>For addresses with multiple units, the unit identifier. Can include numbers and
|
|
3195
3277
|
* letters, for example <code>3B</code> or <code>Unit 123</code>.</p>
|
|
3196
|
-
*
|
|
3278
|
+
* <note>
|
|
3197
3279
|
* <p>Returned only for a place index that uses Esri as a data provider. Is not returned
|
|
3198
3280
|
* for <code>SearchPlaceIndexForPosition</code>.</p>
|
|
3199
|
-
*
|
|
3281
|
+
* </note>
|
|
3200
3282
|
*/
|
|
3201
3283
|
UnitNumber?: string;
|
|
3202
3284
|
}
|
|
@@ -3213,7 +3295,7 @@ export interface ListDevicePositionsRequest {
|
|
|
3213
3295
|
TrackerName: string | undefined;
|
|
3214
3296
|
/**
|
|
3215
3297
|
* <p>An optional limit for the number of entries returned in a single call.</p>
|
|
3216
|
-
*
|
|
3298
|
+
* <p>Default value: <code>100</code>
|
|
3217
3299
|
* </p>
|
|
3218
3300
|
*/
|
|
3219
3301
|
MaxResults?: number;
|
|
@@ -3266,14 +3348,14 @@ export interface ListDevicePositionsResponse {
|
|
|
3266
3348
|
export interface ListMapsRequest {
|
|
3267
3349
|
/**
|
|
3268
3350
|
* <p>An optional limit for the number of resources returned in a single call. </p>
|
|
3269
|
-
*
|
|
3351
|
+
* <p>Default value: <code>100</code>
|
|
3270
3352
|
* </p>
|
|
3271
3353
|
*/
|
|
3272
3354
|
MaxResults?: number;
|
|
3273
3355
|
/**
|
|
3274
3356
|
* <p>The pagination token specifying which page of results to return in the response. If no
|
|
3275
3357
|
* token is provided, the default page is the first page.</p>
|
|
3276
|
-
*
|
|
3358
|
+
* <p>Default value: <code>null</code>
|
|
3277
3359
|
* </p>
|
|
3278
3360
|
*/
|
|
3279
3361
|
NextToken?: string;
|
|
@@ -3324,14 +3406,14 @@ export interface ListMapsResponse {
|
|
|
3324
3406
|
export interface ListPlaceIndexesRequest {
|
|
3325
3407
|
/**
|
|
3326
3408
|
* <p>An optional limit for the maximum number of results returned in a single call.</p>
|
|
3327
|
-
*
|
|
3409
|
+
* <p>Default value: <code>100</code>
|
|
3328
3410
|
* </p>
|
|
3329
3411
|
*/
|
|
3330
3412
|
MaxResults?: number;
|
|
3331
3413
|
/**
|
|
3332
3414
|
* <p>The pagination token specifying which page of results to return in the response. If no
|
|
3333
3415
|
* token is provided, the default page is the first page.</p>
|
|
3334
|
-
*
|
|
3416
|
+
* <p>Default value: <code>null</code>
|
|
3335
3417
|
* </p>
|
|
3336
3418
|
*/
|
|
3337
3419
|
NextToken?: string;
|
|
@@ -3350,19 +3432,24 @@ export interface ListPlaceIndexesResponseEntry {
|
|
|
3350
3432
|
Description: string | undefined;
|
|
3351
3433
|
/**
|
|
3352
3434
|
* <p>The data provider of geospatial data. Values can be one of the following:</p>
|
|
3353
|
-
*
|
|
3435
|
+
* <ul>
|
|
3354
3436
|
* <li>
|
|
3355
|
-
*
|
|
3437
|
+
* <p>
|
|
3356
3438
|
* <code>Esri</code>
|
|
3357
3439
|
* </p>
|
|
3358
3440
|
* </li>
|
|
3359
3441
|
* <li>
|
|
3360
|
-
*
|
|
3442
|
+
* <p>
|
|
3443
|
+
* <code>Grab</code>
|
|
3444
|
+
* </p>
|
|
3445
|
+
* </li>
|
|
3446
|
+
* <li>
|
|
3447
|
+
* <p>
|
|
3361
3448
|
* <code>Here</code>
|
|
3362
3449
|
* </p>
|
|
3363
3450
|
* </li>
|
|
3364
3451
|
* </ul>
|
|
3365
|
-
*
|
|
3452
|
+
* <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
|
|
3366
3453
|
*/
|
|
3367
3454
|
DataSource: string | undefined;
|
|
3368
3455
|
/**
|
|
@@ -3396,14 +3483,14 @@ export interface ListPlaceIndexesResponse {
|
|
|
3396
3483
|
export interface ListRouteCalculatorsRequest {
|
|
3397
3484
|
/**
|
|
3398
3485
|
* <p>An optional maximum number of results returned in a single call.</p>
|
|
3399
|
-
*
|
|
3486
|
+
* <p>Default Value: <code>100</code>
|
|
3400
3487
|
* </p>
|
|
3401
3488
|
*/
|
|
3402
3489
|
MaxResults?: number;
|
|
3403
3490
|
/**
|
|
3404
3491
|
* <p>The pagination token specifying which page of results to return in the response. If no
|
|
3405
3492
|
* token is provided, the default page is the first page.</p>
|
|
3406
|
-
*
|
|
3493
|
+
* <p>Default Value: <code>null</code>
|
|
3407
3494
|
* </p>
|
|
3408
3495
|
*/
|
|
3409
3496
|
NextToken?: string;
|
|
@@ -3423,19 +3510,24 @@ export interface ListRouteCalculatorsResponseEntry {
|
|
|
3423
3510
|
/**
|
|
3424
3511
|
* <p>The data provider of traffic and road network data. Indicates one of the available
|
|
3425
3512
|
* providers:</p>
|
|
3426
|
-
*
|
|
3513
|
+
* <ul>
|
|
3427
3514
|
* <li>
|
|
3428
|
-
*
|
|
3515
|
+
* <p>
|
|
3429
3516
|
* <code>Esri</code>
|
|
3430
3517
|
* </p>
|
|
3431
3518
|
* </li>
|
|
3432
3519
|
* <li>
|
|
3433
|
-
*
|
|
3520
|
+
* <p>
|
|
3521
|
+
* <code>Grab</code>
|
|
3522
|
+
* </p>
|
|
3523
|
+
* </li>
|
|
3524
|
+
* <li>
|
|
3525
|
+
* <p>
|
|
3434
3526
|
* <code>Here</code>
|
|
3435
3527
|
* </p>
|
|
3436
3528
|
* </li>
|
|
3437
3529
|
* </ul>
|
|
3438
|
-
*
|
|
3530
|
+
* <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
|
|
3439
3531
|
*/
|
|
3440
3532
|
DataSource: string | undefined;
|
|
3441
3533
|
/**
|
|
@@ -3447,9 +3539,9 @@ export interface ListRouteCalculatorsResponseEntry {
|
|
|
3447
3539
|
/**
|
|
3448
3540
|
* <p>The timestamp when the route calculator resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
3449
3541
|
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
3450
|
-
*
|
|
3542
|
+
* <ul>
|
|
3451
3543
|
* <li>
|
|
3452
|
-
*
|
|
3544
|
+
* <p>For example, <code>2020–07-2T12:15:20.000Z+01:00</code>
|
|
3453
3545
|
* </p>
|
|
3454
3546
|
* </li>
|
|
3455
3547
|
* </ul>
|
|
@@ -3458,9 +3550,9 @@ export interface ListRouteCalculatorsResponseEntry {
|
|
|
3458
3550
|
/**
|
|
3459
3551
|
* <p>The timestamp when the route calculator resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
3460
3552
|
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
3461
|
-
*
|
|
3553
|
+
* <ul>
|
|
3462
3554
|
* <li>
|
|
3463
|
-
*
|
|
3555
|
+
* <p>For example, <code>2020–07-2T12:15:20.000Z+01:00</code>
|
|
3464
3556
|
* </p>
|
|
3465
3557
|
* </li>
|
|
3466
3558
|
* </ul>
|
|
@@ -3485,7 +3577,7 @@ export interface ListTrackerConsumersRequest {
|
|
|
3485
3577
|
TrackerName: string | undefined;
|
|
3486
3578
|
/**
|
|
3487
3579
|
* <p>An optional limit for the number of resources returned in a single call. </p>
|
|
3488
|
-
*
|
|
3580
|
+
* <p>Default value: <code>100</code>
|
|
3489
3581
|
* </p>
|
|
3490
3582
|
*/
|
|
3491
3583
|
MaxResults?: number;
|
|
@@ -3511,14 +3603,14 @@ export interface ListTrackerConsumersResponse {
|
|
|
3511
3603
|
export interface ListTrackersRequest {
|
|
3512
3604
|
/**
|
|
3513
3605
|
* <p>An optional limit for the number of resources returned in a single call. </p>
|
|
3514
|
-
*
|
|
3606
|
+
* <p>Default value: <code>100</code>
|
|
3515
3607
|
* </p>
|
|
3516
3608
|
*/
|
|
3517
3609
|
MaxResults?: number;
|
|
3518
3610
|
/**
|
|
3519
3611
|
* <p>The pagination token specifying which page of results to return in the response. If no
|
|
3520
3612
|
* token is provided, the default page is the first page. </p>
|
|
3521
|
-
*
|
|
3613
|
+
* <p>Default value: <code>null</code>
|
|
3522
3614
|
* </p>
|
|
3523
3615
|
*/
|
|
3524
3616
|
NextToken?: string;
|
|
@@ -3595,7 +3687,7 @@ export interface UpdateMapResponse {
|
|
|
3595
3687
|
/**
|
|
3596
3688
|
* <p>The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource
|
|
3597
3689
|
* across AWS.</p>
|
|
3598
|
-
*
|
|
3690
|
+
* <ul>
|
|
3599
3691
|
* <li>
|
|
3600
3692
|
* <p>Format example: <code>arn:aws:geo:region:account-id:map/ExampleMap</code>
|
|
3601
3693
|
* </p>
|
|
@@ -3616,33 +3708,33 @@ export interface SearchPlaceIndexForPositionRequest {
|
|
|
3616
3708
|
IndexName: string | undefined;
|
|
3617
3709
|
/**
|
|
3618
3710
|
* <p>Specifies the longitude and latitude of the position to query.</p>
|
|
3619
|
-
*
|
|
3711
|
+
* <p> This parameter must contain a pair of numbers. The first number represents the X
|
|
3620
3712
|
* coordinate, or longitude; the second number represents the Y coordinate, or
|
|
3621
3713
|
* latitude.</p>
|
|
3622
|
-
*
|
|
3714
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents a position with longitude
|
|
3623
3715
|
* <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
|
|
3624
3716
|
*/
|
|
3625
3717
|
Position: number[] | undefined;
|
|
3626
3718
|
/**
|
|
3627
3719
|
* <p>An optional parameter. The maximum number of results returned per request.</p>
|
|
3628
|
-
*
|
|
3720
|
+
* <p>Default value: <code>50</code>
|
|
3629
3721
|
* </p>
|
|
3630
3722
|
*/
|
|
3631
3723
|
MaxResults?: number;
|
|
3632
3724
|
/**
|
|
3633
3725
|
* <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
|
|
3634
3726
|
* <code>en</code> for English.</p>
|
|
3635
|
-
*
|
|
3727
|
+
* <p>This setting affects the languages used in the results, but not the results
|
|
3636
3728
|
* themselves. If no language is specified, or not supported for a particular result, the
|
|
3637
3729
|
* partner automatically chooses a language for the result.</p>
|
|
3638
|
-
*
|
|
3730
|
+
* <p>For an example, we'll use the Greek language. You search for a location around Athens,
|
|
3639
3731
|
* Greece, with the <code>language</code> parameter set to <code>en</code>. The
|
|
3640
3732
|
* <code>city</code> in the results will most likely be returned as
|
|
3641
3733
|
* <code>Athens</code>.</p>
|
|
3642
|
-
*
|
|
3734
|
+
* <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the
|
|
3643
3735
|
* <code>city</code> in the results will more likely be returned as
|
|
3644
3736
|
* <code>Αθήνα</code>.</p>
|
|
3645
|
-
*
|
|
3737
|
+
* <p>If the data provider does not have a value for Greek, the result will be in a language
|
|
3646
3738
|
* that the provider does support.</p>
|
|
3647
3739
|
*/
|
|
3648
3740
|
Language?: string;
|
|
@@ -3659,19 +3751,19 @@ export interface SearchForPositionResult {
|
|
|
3659
3751
|
/**
|
|
3660
3752
|
* <p>The distance in meters of a great-circle arc between the query position and the
|
|
3661
3753
|
* result.</p>
|
|
3662
|
-
*
|
|
3754
|
+
* <note>
|
|
3663
3755
|
* <p>A great-circle arc is the shortest path on a sphere, in this case the Earth. This
|
|
3664
3756
|
* returns the shortest distance between two locations.</p>
|
|
3665
|
-
*
|
|
3757
|
+
* </note>
|
|
3666
3758
|
*/
|
|
3667
3759
|
Distance: number | undefined;
|
|
3668
3760
|
/**
|
|
3669
3761
|
* <p>The unique identifier of the place. You can use this with the <code>GetPlace</code>
|
|
3670
3762
|
* operation to find the place again later.</p>
|
|
3671
|
-
*
|
|
3763
|
+
* <note>
|
|
3672
3764
|
* <p>For <code>SearchPlaceIndexForPosition</code> operations, the <code>PlaceId</code>
|
|
3673
|
-
* is returned only by place indexes that use HERE as a data provider.</p>
|
|
3674
|
-
*
|
|
3765
|
+
* is returned only by place indexes that use HERE or Grab as a data provider.</p>
|
|
3766
|
+
* </note>
|
|
3675
3767
|
*/
|
|
3676
3768
|
PlaceId?: string;
|
|
3677
3769
|
}
|
|
@@ -3686,22 +3778,25 @@ export interface SearchPlaceIndexForPositionSummary {
|
|
|
3686
3778
|
Position: number[] | undefined;
|
|
3687
3779
|
/**
|
|
3688
3780
|
* <p>Contains the optional result count limit that is specified in the request.</p>
|
|
3689
|
-
*
|
|
3781
|
+
* <p>Default value: <code>50</code>
|
|
3690
3782
|
* </p>
|
|
3691
3783
|
*/
|
|
3692
3784
|
MaxResults?: number;
|
|
3693
3785
|
/**
|
|
3694
3786
|
* <p>The geospatial data provider attached to the place index resource specified in the
|
|
3695
3787
|
* request. Values can be one of the following:</p>
|
|
3696
|
-
*
|
|
3788
|
+
* <ul>
|
|
3697
3789
|
* <li>
|
|
3698
|
-
*
|
|
3790
|
+
* <p>Esri</p>
|
|
3699
3791
|
* </li>
|
|
3700
3792
|
* <li>
|
|
3701
|
-
*
|
|
3793
|
+
* <p>Grab</p>
|
|
3794
|
+
* </li>
|
|
3795
|
+
* <li>
|
|
3796
|
+
* <p>Here</p>
|
|
3702
3797
|
* </li>
|
|
3703
3798
|
* </ul>
|
|
3704
|
-
*
|
|
3799
|
+
* <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
|
|
3705
3800
|
*/
|
|
3706
3801
|
DataSource: string | undefined;
|
|
3707
3802
|
/**
|
|
@@ -3737,43 +3832,43 @@ export interface SearchPlaceIndexForSuggestionsRequest {
|
|
|
3737
3832
|
/**
|
|
3738
3833
|
* <p>An optional parameter that indicates a preference for place suggestions that are
|
|
3739
3834
|
* closer to a specified position.</p>
|
|
3740
|
-
*
|
|
3835
|
+
* <p> If provided, this parameter must contain a pair of numbers. The first number
|
|
3741
3836
|
* represents the X coordinate, or longitude; the second number represents the Y
|
|
3742
3837
|
* coordinate, or latitude.</p>
|
|
3743
|
-
*
|
|
3838
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude
|
|
3744
3839
|
* <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
|
|
3745
|
-
*
|
|
3840
|
+
* <note>
|
|
3746
3841
|
* <p>
|
|
3747
3842
|
* <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive.
|
|
3748
3843
|
* Specifying both options results in an error. </p>
|
|
3749
|
-
*
|
|
3844
|
+
* </note>
|
|
3750
3845
|
*/
|
|
3751
3846
|
BiasPosition?: number[];
|
|
3752
3847
|
/**
|
|
3753
3848
|
* <p>An optional parameter that limits the search results by returning only suggestions
|
|
3754
3849
|
* within a specified bounding box.</p>
|
|
3755
|
-
*
|
|
3850
|
+
* <p> If provided, this parameter must contain a total of four consecutive numbers in two
|
|
3756
3851
|
* pairs. The first pair of numbers represents the X and Y coordinates (longitude and
|
|
3757
3852
|
* latitude, respectively) of the southwest corner of the bounding box; the second pair of
|
|
3758
3853
|
* numbers represents the X and Y coordinates (longitude and latitude, respectively) of the
|
|
3759
3854
|
* northeast corner of the bounding box.</p>
|
|
3760
|
-
*
|
|
3855
|
+
* <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents a
|
|
3761
3856
|
* bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude
|
|
3762
3857
|
* <code>-37.4835</code>, and the northeast corner has longitude <code>-12.0684</code>
|
|
3763
3858
|
* and latitude <code>-36.9542</code>.</p>
|
|
3764
|
-
*
|
|
3859
|
+
* <note>
|
|
3765
3860
|
* <p>
|
|
3766
3861
|
* <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive.
|
|
3767
3862
|
* Specifying both options results in an error. </p>
|
|
3768
|
-
*
|
|
3863
|
+
* </note>
|
|
3769
3864
|
*/
|
|
3770
3865
|
FilterBBox?: number[];
|
|
3771
3866
|
/**
|
|
3772
3867
|
* <p>An optional parameter that limits the search results by returning only suggestions
|
|
3773
3868
|
* within the provided list of countries.</p>
|
|
3774
|
-
*
|
|
3869
|
+
* <ul>
|
|
3775
3870
|
* <li>
|
|
3776
|
-
*
|
|
3871
|
+
* <p>Use the <a href="https://www.iso.org/iso-3166-country-codes.html">ISO
|
|
3777
3872
|
* 3166</a> 3-digit country code. For example, Australia uses three
|
|
3778
3873
|
* upper-case characters: <code>AUS</code>.</p>
|
|
3779
3874
|
* </li>
|
|
@@ -3782,22 +3877,22 @@ export interface SearchPlaceIndexForSuggestionsRequest {
|
|
|
3782
3877
|
FilterCountries?: string[];
|
|
3783
3878
|
/**
|
|
3784
3879
|
* <p>An optional parameter. The maximum number of results returned per request. </p>
|
|
3785
|
-
*
|
|
3880
|
+
* <p>The default: <code>5</code>
|
|
3786
3881
|
* </p>
|
|
3787
3882
|
*/
|
|
3788
3883
|
MaxResults?: number;
|
|
3789
3884
|
/**
|
|
3790
3885
|
* <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
|
|
3791
3886
|
* <code>en</code> for English.</p>
|
|
3792
|
-
*
|
|
3887
|
+
* <p>This setting affects the languages used in the results. If no language is specified,
|
|
3793
3888
|
* or not supported for a particular result, the partner automatically chooses a language
|
|
3794
3889
|
* for the result.</p>
|
|
3795
|
-
*
|
|
3890
|
+
* <p>For an example, we'll use the Greek language. You search for <code>Athens, Gr</code>
|
|
3796
3891
|
* to get suggestions with the <code>language</code> parameter set to <code>en</code>. The
|
|
3797
3892
|
* results found will most likely be returned as <code>Athens, Greece</code>.</p>
|
|
3798
|
-
*
|
|
3893
|
+
* <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the
|
|
3799
3894
|
* result found will more likely be returned as <code>Αθήνα, Ελλάδα</code>.</p>
|
|
3800
|
-
*
|
|
3895
|
+
* <p>If the data provider does not have a value for Greek, the result will be in a language
|
|
3801
3896
|
* that the provider does support.</p>
|
|
3802
3897
|
*/
|
|
3803
3898
|
Language?: string;
|
|
@@ -3814,11 +3909,11 @@ export interface SearchForSuggestionsResult {
|
|
|
3814
3909
|
/**
|
|
3815
3910
|
* <p>The unique identifier of the place. You can use this with the <code>GetPlace</code>
|
|
3816
3911
|
* operation to find the place again later.</p>
|
|
3817
|
-
*
|
|
3912
|
+
* <note>
|
|
3818
3913
|
* <p>For <code>SearchPlaceIndexForSuggestions</code> operations, the
|
|
3819
|
-
* <code>PlaceId</code> is returned by place indexes that use
|
|
3820
|
-
* providers.</p>
|
|
3821
|
-
*
|
|
3914
|
+
* <code>PlaceId</code> is returned by place indexes that use Esri, Grab, or HERE
|
|
3915
|
+
* as data providers.</p>
|
|
3916
|
+
* </note>
|
|
3822
3917
|
*/
|
|
3823
3918
|
PlaceId?: string;
|
|
3824
3919
|
}
|
|
@@ -3834,10 +3929,10 @@ export interface SearchPlaceIndexForSuggestionsSummary {
|
|
|
3834
3929
|
/**
|
|
3835
3930
|
* <p>Contains the coordinates for the optional bias position specified in the
|
|
3836
3931
|
* request.</p>
|
|
3837
|
-
*
|
|
3932
|
+
* <p>This parameter contains a pair of numbers. The first number represents the X
|
|
3838
3933
|
* coordinate, or longitude; the second number represents the Y coordinate, or
|
|
3839
3934
|
* latitude.</p>
|
|
3840
|
-
*
|
|
3935
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude
|
|
3841
3936
|
* <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
|
|
3842
3937
|
*/
|
|
3843
3938
|
BiasPosition?: number[];
|
|
@@ -3857,15 +3952,18 @@ export interface SearchPlaceIndexForSuggestionsSummary {
|
|
|
3857
3952
|
/**
|
|
3858
3953
|
* <p>The geospatial data provider attached to the place index resource specified in the
|
|
3859
3954
|
* request. Values can be one of the following:</p>
|
|
3860
|
-
*
|
|
3955
|
+
* <ul>
|
|
3956
|
+
* <li>
|
|
3957
|
+
* <p>Esri</p>
|
|
3958
|
+
* </li>
|
|
3861
3959
|
* <li>
|
|
3862
|
-
*
|
|
3960
|
+
* <p>Grab</p>
|
|
3863
3961
|
* </li>
|
|
3864
3962
|
* <li>
|
|
3865
|
-
*
|
|
3963
|
+
* <p>Here</p>
|
|
3866
3964
|
* </li>
|
|
3867
3965
|
* </ul>
|
|
3868
|
-
*
|
|
3966
|
+
* <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
|
|
3869
3967
|
*/
|
|
3870
3968
|
DataSource: string | undefined;
|
|
3871
3969
|
/**
|
|
@@ -3901,43 +3999,43 @@ export interface SearchPlaceIndexForTextRequest {
|
|
|
3901
3999
|
/**
|
|
3902
4000
|
* <p>An optional parameter that indicates a preference for places that are closer to a
|
|
3903
4001
|
* specified position.</p>
|
|
3904
|
-
*
|
|
4002
|
+
* <p> If provided, this parameter must contain a pair of numbers. The first number
|
|
3905
4003
|
* represents the X coordinate, or longitude; the second number represents the Y
|
|
3906
4004
|
* coordinate, or latitude.</p>
|
|
3907
|
-
*
|
|
4005
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude
|
|
3908
4006
|
* <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
|
|
3909
|
-
*
|
|
4007
|
+
* <note>
|
|
3910
4008
|
* <p>
|
|
3911
4009
|
* <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive.
|
|
3912
4010
|
* Specifying both options results in an error. </p>
|
|
3913
|
-
*
|
|
4011
|
+
* </note>
|
|
3914
4012
|
*/
|
|
3915
4013
|
BiasPosition?: number[];
|
|
3916
4014
|
/**
|
|
3917
4015
|
* <p>An optional parameter that limits the search results by returning only places that are
|
|
3918
4016
|
* within the provided bounding box.</p>
|
|
3919
|
-
*
|
|
4017
|
+
* <p> If provided, this parameter must contain a total of four consecutive numbers in two
|
|
3920
4018
|
* pairs. The first pair of numbers represents the X and Y coordinates (longitude and
|
|
3921
4019
|
* latitude, respectively) of the southwest corner of the bounding box; the second pair of
|
|
3922
4020
|
* numbers represents the X and Y coordinates (longitude and latitude, respectively) of the
|
|
3923
4021
|
* northeast corner of the bounding box.</p>
|
|
3924
|
-
*
|
|
4022
|
+
* <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents a
|
|
3925
4023
|
* bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude
|
|
3926
4024
|
* <code>-37.4835</code>, and the northeast corner has longitude <code>-12.0684</code>
|
|
3927
4025
|
* and latitude <code>-36.9542</code>.</p>
|
|
3928
|
-
*
|
|
4026
|
+
* <note>
|
|
3929
4027
|
* <p>
|
|
3930
4028
|
* <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive.
|
|
3931
4029
|
* Specifying both options results in an error. </p>
|
|
3932
|
-
*
|
|
4030
|
+
* </note>
|
|
3933
4031
|
*/
|
|
3934
4032
|
FilterBBox?: number[];
|
|
3935
4033
|
/**
|
|
3936
4034
|
* <p>An optional parameter that limits the search results by returning only places that are
|
|
3937
4035
|
* in a specified list of countries.</p>
|
|
3938
|
-
*
|
|
4036
|
+
* <ul>
|
|
3939
4037
|
* <li>
|
|
3940
|
-
*
|
|
4038
|
+
* <p>Valid values include <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a>
|
|
3941
4039
|
* 3-digit country codes. For example, Australia uses three upper-case characters:
|
|
3942
4040
|
* <code>AUS</code>.</p>
|
|
3943
4041
|
* </li>
|
|
@@ -3946,22 +4044,22 @@ export interface SearchPlaceIndexForTextRequest {
|
|
|
3946
4044
|
FilterCountries?: string[];
|
|
3947
4045
|
/**
|
|
3948
4046
|
* <p>An optional parameter. The maximum number of results returned per request. </p>
|
|
3949
|
-
*
|
|
4047
|
+
* <p>The default: <code>50</code>
|
|
3950
4048
|
* </p>
|
|
3951
4049
|
*/
|
|
3952
4050
|
MaxResults?: number;
|
|
3953
4051
|
/**
|
|
3954
4052
|
* <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
|
|
3955
4053
|
* <code>en</code> for English.</p>
|
|
3956
|
-
*
|
|
4054
|
+
* <p>This setting affects the languages used in the results, but not the results
|
|
3957
4055
|
* themselves. If no language is specified, or not supported for a particular result, the
|
|
3958
4056
|
* partner automatically chooses a language for the result.</p>
|
|
3959
|
-
*
|
|
4057
|
+
* <p>For an example, we'll use the Greek language. You search for <code>Athens,
|
|
3960
4058
|
* Greece</code>, with the <code>language</code> parameter set to <code>en</code>. The
|
|
3961
4059
|
* result found will most likely be returned as <code>Athens</code>.</p>
|
|
3962
|
-
*
|
|
4060
|
+
* <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the
|
|
3963
4061
|
* result found will more likely be returned as <code>Αθήνα</code>.</p>
|
|
3964
|
-
*
|
|
4062
|
+
* <p>If the data provider does not have a value for Greek, the result will be in a language
|
|
3965
4063
|
* that the provider does support.</p>
|
|
3966
4064
|
*/
|
|
3967
4065
|
Language?: string;
|
|
@@ -3979,26 +4077,26 @@ export interface SearchForTextResult {
|
|
|
3979
4077
|
* <p>The distance in meters of a great-circle arc between the bias position specified and
|
|
3980
4078
|
* the result. <code>Distance</code> will be returned only if a bias position was specified
|
|
3981
4079
|
* in the query.</p>
|
|
3982
|
-
*
|
|
4080
|
+
* <note>
|
|
3983
4081
|
* <p>A great-circle arc is the shortest path on a sphere, in this case the Earth. This
|
|
3984
4082
|
* returns the shortest distance between two locations.</p>
|
|
3985
|
-
*
|
|
4083
|
+
* </note>
|
|
3986
4084
|
*/
|
|
3987
4085
|
Distance?: number;
|
|
3988
4086
|
/**
|
|
3989
4087
|
* <p>The relative confidence in the match for a result among the results returned. For
|
|
3990
4088
|
* example, if more fields for an address match (including house number, street, city,
|
|
3991
4089
|
* country/region, and postal code), the relevance score is closer to 1.</p>
|
|
3992
|
-
*
|
|
4090
|
+
* <p>Returned only when the partner selected is Esri or Grab.</p>
|
|
3993
4091
|
*/
|
|
3994
4092
|
Relevance?: number;
|
|
3995
4093
|
/**
|
|
3996
4094
|
* <p>The unique identifier of the place. You can use this with the <code>GetPlace</code>
|
|
3997
4095
|
* operation to find the place again later.</p>
|
|
3998
|
-
*
|
|
4096
|
+
* <note>
|
|
3999
4097
|
* <p>For <code>SearchPlaceIndexForText</code> operations, the <code>PlaceId</code> is
|
|
4000
|
-
* returned only by place indexes that use HERE as a data provider.</p>
|
|
4001
|
-
*
|
|
4098
|
+
* returned only by place indexes that use HERE or Grab as a data provider.</p>
|
|
4099
|
+
* </note>
|
|
4002
4100
|
*/
|
|
4003
4101
|
PlaceId?: string;
|
|
4004
4102
|
}
|
|
@@ -4013,10 +4111,10 @@ export interface SearchPlaceIndexForTextSummary {
|
|
|
4013
4111
|
/**
|
|
4014
4112
|
* <p>Contains the coordinates for the optional bias position specified in the
|
|
4015
4113
|
* request.</p>
|
|
4016
|
-
*
|
|
4114
|
+
* <p>This parameter contains a pair of numbers. The first number represents the X
|
|
4017
4115
|
* coordinate, or longitude; the second number represents the Y coordinate, or
|
|
4018
4116
|
* latitude.</p>
|
|
4019
|
-
*
|
|
4117
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude
|
|
4020
4118
|
* <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
|
|
4021
4119
|
*/
|
|
4022
4120
|
BiasPosition?: number[];
|
|
@@ -4035,24 +4133,27 @@ export interface SearchPlaceIndexForTextSummary {
|
|
|
4035
4133
|
MaxResults?: number;
|
|
4036
4134
|
/**
|
|
4037
4135
|
* <p>The bounding box that fully contains all search results.</p>
|
|
4038
|
-
*
|
|
4136
|
+
* <note>
|
|
4039
4137
|
* <p>If you specified the optional <code>FilterBBox</code> parameter in the request,
|
|
4040
4138
|
* <code>ResultBBox</code> is contained within <code>FilterBBox</code>.</p>
|
|
4041
|
-
*
|
|
4139
|
+
* </note>
|
|
4042
4140
|
*/
|
|
4043
4141
|
ResultBBox?: number[];
|
|
4044
4142
|
/**
|
|
4045
4143
|
* <p>The geospatial data provider attached to the place index resource specified in the
|
|
4046
4144
|
* request. Values can be one of the following:</p>
|
|
4047
|
-
*
|
|
4145
|
+
* <ul>
|
|
4146
|
+
* <li>
|
|
4147
|
+
* <p>Esri</p>
|
|
4148
|
+
* </li>
|
|
4048
4149
|
* <li>
|
|
4049
|
-
*
|
|
4150
|
+
* <p>Grab</p>
|
|
4050
4151
|
* </li>
|
|
4051
4152
|
* <li>
|
|
4052
|
-
*
|
|
4153
|
+
* <p>Here</p>
|
|
4053
4154
|
* </li>
|
|
4054
4155
|
* </ul>
|
|
4055
|
-
*
|
|
4156
|
+
* <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
|
|
4056
4157
|
*/
|
|
4057
4158
|
DataSource: string | undefined;
|
|
4058
4159
|
/**
|
|
@@ -4074,7 +4175,7 @@ export interface SearchPlaceIndexForTextResponse {
|
|
|
4074
4175
|
/**
|
|
4075
4176
|
* <p>A list of Places matching the input text. Each result contains additional information
|
|
4076
4177
|
* about the specific point of interest. </p>
|
|
4077
|
-
*
|
|
4178
|
+
* <p>Not all response properties are included with all responses. Some properties may only
|
|
4078
4179
|
* be returned by specific data partners.</p>
|
|
4079
4180
|
*/
|
|
4080
4181
|
Results: SearchForTextResult[] | undefined;
|
|
@@ -4108,9 +4209,9 @@ export interface UpdatePlaceIndexResponse {
|
|
|
4108
4209
|
/**
|
|
4109
4210
|
* <p>The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a
|
|
4110
4211
|
* resource across AWS.</p>
|
|
4111
|
-
*
|
|
4212
|
+
* <ul>
|
|
4112
4213
|
* <li>
|
|
4113
|
-
*
|
|
4214
|
+
* <p>Format example: <code>arn:aws:geo:region:account-id:place-
|
|
4114
4215
|
* index/ExamplePlaceIndex</code>
|
|
4115
4216
|
* </p>
|
|
4116
4217
|
* </li>
|
|
@@ -4148,9 +4249,9 @@ export interface UpdateRouteCalculatorResponse {
|
|
|
4148
4249
|
/**
|
|
4149
4250
|
* <p>The Amazon Resource Name (ARN) of the updated route calculator resource. Used to
|
|
4150
4251
|
* specify a resource across AWS.</p>
|
|
4151
|
-
*
|
|
4252
|
+
* <ul>
|
|
4152
4253
|
* <li>
|
|
4153
|
-
*
|
|
4254
|
+
* <p>Format example: <code>arn:aws:geo:region:account-id:route-
|
|
4154
4255
|
* calculator/ExampleCalculator</code>
|
|
4155
4256
|
* </p>
|
|
4156
4257
|
* </li>
|
|
@@ -4187,26 +4288,26 @@ export interface UpdateTrackerRequest {
|
|
|
4187
4288
|
Description?: string;
|
|
4188
4289
|
/**
|
|
4189
4290
|
* <p>Updates the position filtering for the tracker resource.</p>
|
|
4190
|
-
*
|
|
4191
|
-
*
|
|
4291
|
+
* <p>Valid values:</p>
|
|
4292
|
+
* <ul>
|
|
4192
4293
|
* <li>
|
|
4193
|
-
*
|
|
4194
|
-
*
|
|
4294
|
+
* <p>
|
|
4295
|
+
* <code>TimeBased</code> - Location updates are evaluated against linked geofence collections,
|
|
4195
4296
|
* but not every location update is stored. If your update frequency is more often than 30 seconds,
|
|
4196
4297
|
* only one update per 30 seconds is stored for each unique device ID.
|
|
4197
4298
|
* </p>
|
|
4198
4299
|
* </li>
|
|
4199
4300
|
* <li>
|
|
4200
|
-
*
|
|
4201
|
-
*
|
|
4301
|
+
* <p>
|
|
4302
|
+
* <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are
|
|
4202
4303
|
* ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored.
|
|
4203
4304
|
* This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through.
|
|
4204
4305
|
* Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
|
|
4205
4306
|
* </p>
|
|
4206
4307
|
* </li>
|
|
4207
4308
|
* <li>
|
|
4208
|
-
*
|
|
4209
|
-
*
|
|
4309
|
+
* <p>
|
|
4310
|
+
* <code>AccuracyBased</code> - If the device has moved less than the measured accuracy,
|
|
4210
4311
|
* location updates are ignored. For example, if two consecutive updates from a device
|
|
4211
4312
|
* have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device
|
|
4212
4313
|
* has moved less than 15 m. Ignored location updates are neither evaluated against
|
|
@@ -4227,7 +4328,7 @@ export interface UpdateTrackerResponse {
|
|
|
4227
4328
|
/**
|
|
4228
4329
|
* <p>The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across
|
|
4229
4330
|
* AWS.</p>
|
|
4230
|
-
*
|
|
4331
|
+
* <ul>
|
|
4231
4332
|
* <li>
|
|
4232
4333
|
* <p>Format example: <code>arn:aws:geo:region:account-id:tracker/ExampleTracker</code>
|
|
4233
4334
|
* </p>
|