@aws-sdk/client-location 3.179.0 → 3.181.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.
@@ -38,6 +38,7 @@ import { GetMapGlyphsCommandInput, GetMapGlyphsCommandOutput } from "./commands/
38
38
  import { GetMapSpritesCommandInput, GetMapSpritesCommandOutput } from "./commands/GetMapSpritesCommand";
39
39
  import { GetMapStyleDescriptorCommandInput, GetMapStyleDescriptorCommandOutput } from "./commands/GetMapStyleDescriptorCommand";
40
40
  import { GetMapTileCommandInput, GetMapTileCommandOutput } from "./commands/GetMapTileCommand";
41
+ import { GetPlaceCommandInput, GetPlaceCommandOutput } from "./commands/GetPlaceCommand";
41
42
  import { ListDevicePositionsCommandInput, ListDevicePositionsCommandOutput } from "./commands/ListDevicePositionsCommand";
42
43
  import { ListGeofenceCollectionsCommandInput, ListGeofenceCollectionsCommandOutput } from "./commands/ListGeofenceCollectionsCommand";
43
44
  import { ListGeofencesCommandInput, ListGeofencesCommandOutput } from "./commands/ListGeofencesCommand";
@@ -58,8 +59,8 @@ import { UpdateMapCommandInput, UpdateMapCommandOutput } from "./commands/Update
58
59
  import { UpdatePlaceIndexCommandInput, UpdatePlaceIndexCommandOutput } from "./commands/UpdatePlaceIndexCommand";
59
60
  import { UpdateRouteCalculatorCommandInput, UpdateRouteCalculatorCommandOutput } from "./commands/UpdateRouteCalculatorCommand";
60
61
  import { UpdateTrackerCommandInput, UpdateTrackerCommandOutput } from "./commands/UpdateTrackerCommand";
61
- export declare type ServiceInputTypes = AssociateTrackerConsumerCommandInput | BatchDeleteDevicePositionHistoryCommandInput | BatchDeleteGeofenceCommandInput | BatchEvaluateGeofencesCommandInput | BatchGetDevicePositionCommandInput | BatchPutGeofenceCommandInput | BatchUpdateDevicePositionCommandInput | CalculateRouteCommandInput | CalculateRouteMatrixCommandInput | CreateGeofenceCollectionCommandInput | CreateMapCommandInput | CreatePlaceIndexCommandInput | CreateRouteCalculatorCommandInput | CreateTrackerCommandInput | DeleteGeofenceCollectionCommandInput | DeleteMapCommandInput | DeletePlaceIndexCommandInput | DeleteRouteCalculatorCommandInput | DeleteTrackerCommandInput | DescribeGeofenceCollectionCommandInput | DescribeMapCommandInput | DescribePlaceIndexCommandInput | DescribeRouteCalculatorCommandInput | DescribeTrackerCommandInput | DisassociateTrackerConsumerCommandInput | GetDevicePositionCommandInput | GetDevicePositionHistoryCommandInput | GetGeofenceCommandInput | GetMapGlyphsCommandInput | GetMapSpritesCommandInput | GetMapStyleDescriptorCommandInput | GetMapTileCommandInput | ListDevicePositionsCommandInput | ListGeofenceCollectionsCommandInput | ListGeofencesCommandInput | ListMapsCommandInput | ListPlaceIndexesCommandInput | ListRouteCalculatorsCommandInput | ListTagsForResourceCommandInput | ListTrackerConsumersCommandInput | ListTrackersCommandInput | PutGeofenceCommandInput | SearchPlaceIndexForPositionCommandInput | SearchPlaceIndexForSuggestionsCommandInput | SearchPlaceIndexForTextCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGeofenceCollectionCommandInput | UpdateMapCommandInput | UpdatePlaceIndexCommandInput | UpdateRouteCalculatorCommandInput | UpdateTrackerCommandInput;
62
- export declare type ServiceOutputTypes = AssociateTrackerConsumerCommandOutput | BatchDeleteDevicePositionHistoryCommandOutput | BatchDeleteGeofenceCommandOutput | BatchEvaluateGeofencesCommandOutput | BatchGetDevicePositionCommandOutput | BatchPutGeofenceCommandOutput | BatchUpdateDevicePositionCommandOutput | CalculateRouteCommandOutput | CalculateRouteMatrixCommandOutput | CreateGeofenceCollectionCommandOutput | CreateMapCommandOutput | CreatePlaceIndexCommandOutput | CreateRouteCalculatorCommandOutput | CreateTrackerCommandOutput | DeleteGeofenceCollectionCommandOutput | DeleteMapCommandOutput | DeletePlaceIndexCommandOutput | DeleteRouteCalculatorCommandOutput | DeleteTrackerCommandOutput | DescribeGeofenceCollectionCommandOutput | DescribeMapCommandOutput | DescribePlaceIndexCommandOutput | DescribeRouteCalculatorCommandOutput | DescribeTrackerCommandOutput | DisassociateTrackerConsumerCommandOutput | GetDevicePositionCommandOutput | GetDevicePositionHistoryCommandOutput | GetGeofenceCommandOutput | GetMapGlyphsCommandOutput | GetMapSpritesCommandOutput | GetMapStyleDescriptorCommandOutput | GetMapTileCommandOutput | ListDevicePositionsCommandOutput | ListGeofenceCollectionsCommandOutput | ListGeofencesCommandOutput | ListMapsCommandOutput | ListPlaceIndexesCommandOutput | ListRouteCalculatorsCommandOutput | ListTagsForResourceCommandOutput | ListTrackerConsumersCommandOutput | ListTrackersCommandOutput | PutGeofenceCommandOutput | SearchPlaceIndexForPositionCommandOutput | SearchPlaceIndexForSuggestionsCommandOutput | SearchPlaceIndexForTextCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGeofenceCollectionCommandOutput | UpdateMapCommandOutput | UpdatePlaceIndexCommandOutput | UpdateRouteCalculatorCommandOutput | UpdateTrackerCommandOutput;
62
+ export declare type ServiceInputTypes = AssociateTrackerConsumerCommandInput | BatchDeleteDevicePositionHistoryCommandInput | BatchDeleteGeofenceCommandInput | BatchEvaluateGeofencesCommandInput | BatchGetDevicePositionCommandInput | BatchPutGeofenceCommandInput | BatchUpdateDevicePositionCommandInput | CalculateRouteCommandInput | CalculateRouteMatrixCommandInput | CreateGeofenceCollectionCommandInput | CreateMapCommandInput | CreatePlaceIndexCommandInput | CreateRouteCalculatorCommandInput | CreateTrackerCommandInput | DeleteGeofenceCollectionCommandInput | DeleteMapCommandInput | DeletePlaceIndexCommandInput | DeleteRouteCalculatorCommandInput | DeleteTrackerCommandInput | DescribeGeofenceCollectionCommandInput | DescribeMapCommandInput | DescribePlaceIndexCommandInput | DescribeRouteCalculatorCommandInput | DescribeTrackerCommandInput | DisassociateTrackerConsumerCommandInput | GetDevicePositionCommandInput | GetDevicePositionHistoryCommandInput | GetGeofenceCommandInput | GetMapGlyphsCommandInput | GetMapSpritesCommandInput | GetMapStyleDescriptorCommandInput | GetMapTileCommandInput | GetPlaceCommandInput | ListDevicePositionsCommandInput | ListGeofenceCollectionsCommandInput | ListGeofencesCommandInput | ListMapsCommandInput | ListPlaceIndexesCommandInput | ListRouteCalculatorsCommandInput | ListTagsForResourceCommandInput | ListTrackerConsumersCommandInput | ListTrackersCommandInput | PutGeofenceCommandInput | SearchPlaceIndexForPositionCommandInput | SearchPlaceIndexForSuggestionsCommandInput | SearchPlaceIndexForTextCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGeofenceCollectionCommandInput | UpdateMapCommandInput | UpdatePlaceIndexCommandInput | UpdateRouteCalculatorCommandInput | UpdateTrackerCommandInput;
63
+ export declare type ServiceOutputTypes = AssociateTrackerConsumerCommandOutput | BatchDeleteDevicePositionHistoryCommandOutput | BatchDeleteGeofenceCommandOutput | BatchEvaluateGeofencesCommandOutput | BatchGetDevicePositionCommandOutput | BatchPutGeofenceCommandOutput | BatchUpdateDevicePositionCommandOutput | CalculateRouteCommandOutput | CalculateRouteMatrixCommandOutput | CreateGeofenceCollectionCommandOutput | CreateMapCommandOutput | CreatePlaceIndexCommandOutput | CreateRouteCalculatorCommandOutput | CreateTrackerCommandOutput | DeleteGeofenceCollectionCommandOutput | DeleteMapCommandOutput | DeletePlaceIndexCommandOutput | DeleteRouteCalculatorCommandOutput | DeleteTrackerCommandOutput | DescribeGeofenceCollectionCommandOutput | DescribeMapCommandOutput | DescribePlaceIndexCommandOutput | DescribeRouteCalculatorCommandOutput | DescribeTrackerCommandOutput | DisassociateTrackerConsumerCommandOutput | GetDevicePositionCommandOutput | GetDevicePositionHistoryCommandOutput | GetGeofenceCommandOutput | GetMapGlyphsCommandOutput | GetMapSpritesCommandOutput | GetMapStyleDescriptorCommandOutput | GetMapTileCommandOutput | GetPlaceCommandOutput | ListDevicePositionsCommandOutput | ListGeofenceCollectionsCommandOutput | ListGeofencesCommandOutput | ListMapsCommandOutput | ListPlaceIndexesCommandOutput | ListRouteCalculatorsCommandOutput | ListTagsForResourceCommandOutput | ListTrackerConsumersCommandOutput | ListTrackersCommandOutput | PutGeofenceCommandOutput | SearchPlaceIndexForPositionCommandOutput | SearchPlaceIndexForSuggestionsCommandOutput | SearchPlaceIndexForTextCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGeofenceCollectionCommandOutput | UpdateMapCommandOutput | UpdatePlaceIndexCommandOutput | UpdateRouteCalculatorCommandOutput | UpdateTrackerCommandOutput;
63
64
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
64
65
  /**
65
66
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
@@ -0,0 +1,51 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
4
+ import { GetPlaceRequest, GetPlaceResponse } from "../models/models_0";
5
+ export interface GetPlaceCommandInput extends GetPlaceRequest {
6
+ }
7
+ export interface GetPlaceCommandOutput extends GetPlaceResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Finds a place by its unique ID. A <code>PlaceId</code> is returned by other search
11
+ * operations.</p>
12
+ * <note>
13
+ * <p>A PlaceId is valid only if all of the following are the same in the original
14
+ * search request and the call to <code>GetPlace</code>.</p>
15
+ * <ul>
16
+ * <li>
17
+ * <p>Customer AWS account</p>
18
+ * </li>
19
+ * <li>
20
+ * <p>AWS Region</p>
21
+ * </li>
22
+ * <li>
23
+ * <p>Data provider specified in the place index resource</p>
24
+ * </li>
25
+ * </ul>
26
+ * </note>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { LocationClient, GetPlaceCommand } from "@aws-sdk/client-location"; // ES Modules import
31
+ * // const { LocationClient, GetPlaceCommand } = require("@aws-sdk/client-location"); // CommonJS import
32
+ * const client = new LocationClient(config);
33
+ * const command = new GetPlaceCommand(input);
34
+ * const response = await client.send(command);
35
+ * ```
36
+ *
37
+ * @see {@link GetPlaceCommandInput} for command's `input` shape.
38
+ * @see {@link GetPlaceCommandOutput} for command's `response` shape.
39
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
40
+ *
41
+ */
42
+ export declare class GetPlaceCommand extends $Command<GetPlaceCommandInput, GetPlaceCommandOutput, LocationClientResolvedConfig> {
43
+ readonly input: GetPlaceCommandInput;
44
+ constructor(input: GetPlaceCommandInput);
45
+ /**
46
+ * @internal
47
+ */
48
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPlaceCommandInput, GetPlaceCommandOutput>;
49
+ private serialize;
50
+ private deserialize;
51
+ }
@@ -30,6 +30,7 @@ export * from "./GetMapGlyphsCommand";
30
30
  export * from "./GetMapSpritesCommand";
31
31
  export * from "./GetMapStyleDescriptorCommand";
32
32
  export * from "./GetMapTileCommand";
33
+ export * from "./GetPlaceCommand";
33
34
  export * from "./ListDevicePositionsCommand";
34
35
  export * from "./ListGeofenceCollectionsCommand";
35
36
  export * from "./ListGeofencesCommand";
@@ -2917,7 +2917,7 @@ export interface GetMapSpritesRequest {
2917
2917
  * <code>sprites@2x.png</code> for high pixel density displays</p>
2918
2918
  * </li>
2919
2919
  * </ul>
2920
- * <p>For the JSON document contain image offsets. Use the following file names:</p>
2920
+ * <p>For the JSON document containing image offsets. Use the following file names:</p>
2921
2921
  * <ul>
2922
2922
  * <li>
2923
2923
  * <p>
@@ -2990,6 +2990,161 @@ export interface GetMapTileResponse {
2990
2990
  */
2991
2991
  ContentType?: string;
2992
2992
  }
2993
+ export interface GetPlaceRequest {
2994
+ /**
2995
+ * <p>The name of the place index resource that you want to use for the search.</p>
2996
+ */
2997
+ IndexName: string | undefined;
2998
+ /**
2999
+ * <p>The identifier of the place to find.</p>
3000
+ */
3001
+ PlaceId: string | undefined;
3002
+ /**
3003
+ * <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,
3004
+ * <code>en</code> for English.</p>
3005
+ * <p>This setting affects the languages used in the results, but not the results
3006
+ * themselves. If no language is specified, or not supported for a particular result, the
3007
+ * partner automatically chooses a language for the result.</p>
3008
+ * <p>For an example, we'll use the Greek language. You search for a location around Athens,
3009
+ * Greece, with the <code>language</code> parameter set to <code>en</code>. The
3010
+ * <code>city</code> in the results will most likely be returned as
3011
+ * <code>Athens</code>.</p>
3012
+ * <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the
3013
+ * <code>city</code> in the results will more likely be returned as
3014
+ * <code>Αθήνα</code>.</p>
3015
+ * <p>If the data provider does not have a value for Greek, the result will be in a language
3016
+ * that the provider does support.</p>
3017
+ */
3018
+ Language?: string;
3019
+ }
3020
+ /**
3021
+ * <p>Places uses a point geometry to specify a location or a Place.</p>
3022
+ */
3023
+ export interface PlaceGeometry {
3024
+ /**
3025
+ * <p>A single point geometry specifies a location for a Place using <a href="https://gisgeography.com/wgs84-world-geodetic-system/">WGS 84</a>
3026
+ * coordinates:</p>
3027
+ * <ul>
3028
+ * <li>
3029
+ * <p>
3030
+ * <i>x</i> — Specifies the x coordinate or longitude. </p>
3031
+ * </li>
3032
+ * <li>
3033
+ * <p>
3034
+ * <i>y</i> — Specifies the y coordinate or latitude. </p>
3035
+ * </li>
3036
+ * </ul>
3037
+ */
3038
+ Point?: number[];
3039
+ }
3040
+ /**
3041
+ * <p>Information about a time zone. Includes the name of the time zone and the offset from
3042
+ * UTC in seconds.</p>
3043
+ */
3044
+ export interface TimeZone {
3045
+ /**
3046
+ * <p>The name of the time zone, following the <a href="https://www.iana.org/time-zones">
3047
+ * IANA time zone standard</a>. For example,
3048
+ * <code>America/Los_Angeles</code>.</p>
3049
+ */
3050
+ Name: string | undefined;
3051
+ /**
3052
+ * <p>The time zone's offset, in seconds, from UTC.</p>
3053
+ */
3054
+ Offset?: number;
3055
+ }
3056
+ /**
3057
+ * <p>Contains details about addresses or points of interest that match the search
3058
+ * criteria.</p>
3059
+ * <p>Not all details are included with all responses. Some details may only be returned by
3060
+ * specific data partners.</p>
3061
+ */
3062
+ export interface Place {
3063
+ /**
3064
+ * <p>The full name and address of the point of interest such as a city, region, or country.
3065
+ * For example, <code>123 Any Street, Any Town, USA</code>.</p>
3066
+ */
3067
+ Label?: string;
3068
+ /**
3069
+ * <p>Places uses a point geometry to specify a location or a Place.</p>
3070
+ */
3071
+ Geometry: PlaceGeometry | undefined;
3072
+ /**
3073
+ * <p>The numerical portion of an address, such as a building number. </p>
3074
+ */
3075
+ AddressNumber?: string;
3076
+ /**
3077
+ * <p>The name for a street or a road to identify a location. For example, <code>Main
3078
+ * Street</code>.</p>
3079
+ */
3080
+ Street?: string;
3081
+ /**
3082
+ * <p>The name of a community district. For example, <code>Downtown</code>.</p>
3083
+ */
3084
+ Neighborhood?: string;
3085
+ /**
3086
+ * <p>A name for a local area, such as a city or town name. For example,
3087
+ * <code>Toronto</code>.</p>
3088
+ */
3089
+ Municipality?: string;
3090
+ /**
3091
+ * <p>A country, or an area that's part of a larger region. For example, <code>Metro
3092
+ * Vancouver</code>.</p>
3093
+ */
3094
+ SubRegion?: string;
3095
+ /**
3096
+ * <p>A name for an area or geographical division, such as a province or state name. For
3097
+ * example, <code>British Columbia</code>.</p>
3098
+ */
3099
+ Region?: string;
3100
+ /**
3101
+ * <p>A country/region specified using <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
3102
+ * country/region code. For example, <code>CAN</code>.</p>
3103
+ */
3104
+ Country?: string;
3105
+ /**
3106
+ * <p>A group of numbers and letters in a country-specific format, which accompanies the
3107
+ * address for the purpose of identifying a location. </p>
3108
+ */
3109
+ PostalCode?: string;
3110
+ /**
3111
+ * <p>
3112
+ * <code>True</code> if the result is interpolated from other known places.</p>
3113
+ * <p>
3114
+ * <code>False</code> if the Place is a known place.</p>
3115
+ * <p>Not returned when the partner does not provide the information.</p>
3116
+ * <p>For example, returns <code>False</code> for an address location that is found in the
3117
+ * partner data, but returns <code>True</code> if an address does not exist in the partner
3118
+ * data and its location is calculated by interpolating between other known addresses.
3119
+ * </p>
3120
+ */
3121
+ Interpolated?: boolean;
3122
+ /**
3123
+ * <p>The time zone in which the <code>Place</code> is located. Returned only when using
3124
+ * Here as the selected partner.</p>
3125
+ */
3126
+ TimeZone?: TimeZone;
3127
+ /**
3128
+ * <p>For addresses with a <code>UnitNumber</code>, the type of unit. For example,
3129
+ * <code>Apartment</code>.</p>
3130
+ */
3131
+ UnitType?: string;
3132
+ /**
3133
+ * <p>For addresses with multiple units, the unit identifier. Can include numbers and
3134
+ * letters, for example <code>3B</code> or <code>Unit 123</code>.</p>
3135
+ * <note>
3136
+ * <p>Returned only for a place index that uses Esri as a data provider. Is not returned
3137
+ * for <code>SearchPlaceIndexForPosition</code>.</p>
3138
+ * </note>
3139
+ */
3140
+ UnitNumber?: string;
3141
+ }
3142
+ export interface GetPlaceResponse {
3143
+ /**
3144
+ * <p>Details about the result, such as its address and position.</p>
3145
+ */
3146
+ Place: Place | undefined;
3147
+ }
2993
3148
  export interface ListDevicePositionsRequest {
2994
3149
  /**
2995
3150
  * <p>The tracker resource containing the requested devices.</p>
@@ -3431,114 +3586,6 @@ export interface SearchPlaceIndexForPositionRequest {
3431
3586
  */
3432
3587
  Language?: string;
3433
3588
  }
3434
- /**
3435
- * <p>Places uses a point geometry to specify a location or a Place.</p>
3436
- */
3437
- export interface PlaceGeometry {
3438
- /**
3439
- * <p>A single point geometry specifies a location for a Place using <a href="https://gisgeography.com/wgs84-world-geodetic-system/">WGS 84</a>
3440
- * coordinates:</p>
3441
- * <ul>
3442
- * <li>
3443
- * <p>
3444
- * <i>x</i> — Specifies the x coordinate or longitude. </p>
3445
- * </li>
3446
- * <li>
3447
- * <p>
3448
- * <i>y</i> — Specifies the y coordinate or latitude. </p>
3449
- * </li>
3450
- * </ul>
3451
- */
3452
- Point?: number[];
3453
- }
3454
- /**
3455
- * <p>Information about a time zone. Includes the name of the time zone and the offset from
3456
- * UTC in seconds.</p>
3457
- */
3458
- export interface TimeZone {
3459
- /**
3460
- * <p>The name of the time zone, following the <a href="https://www.iana.org/time-zones">
3461
- * IANA time zone standard</a>. For example,
3462
- * <code>America/Los_Angeles</code>.</p>
3463
- */
3464
- Name: string | undefined;
3465
- /**
3466
- * <p>The time zone's offset, in seconds, from UTC.</p>
3467
- */
3468
- Offset?: number;
3469
- }
3470
- /**
3471
- * <p>Contains details about addresses or points of interest that match the search
3472
- * criteria.</p>
3473
- * <p>Not all details are included with all responses. Some details may only be returned
3474
- * by specific data partners.</p>
3475
- */
3476
- export interface Place {
3477
- /**
3478
- * <p>The full name and address of the point of interest such as a city, region, or country.
3479
- * For example, <code>123 Any Street, Any Town, USA</code>.</p>
3480
- */
3481
- Label?: string;
3482
- /**
3483
- * <p>Places uses a point geometry to specify a location or a Place.</p>
3484
- */
3485
- Geometry: PlaceGeometry | undefined;
3486
- /**
3487
- * <p>The numerical portion of an address, such as a building number. </p>
3488
- */
3489
- AddressNumber?: string;
3490
- /**
3491
- * <p>The name for a street or a road to identify a location. For example, <code>Main
3492
- * Street</code>.</p>
3493
- */
3494
- Street?: string;
3495
- /**
3496
- * <p>The name of a community district. For example, <code>Downtown</code>.</p>
3497
- */
3498
- Neighborhood?: string;
3499
- /**
3500
- * <p>A name for a local area, such as a city or town name. For example,
3501
- * <code>Toronto</code>.</p>
3502
- */
3503
- Municipality?: string;
3504
- /**
3505
- * <p>A country, or an area that's part of a larger region. For example, <code>Metro
3506
- * Vancouver</code>.</p>
3507
- */
3508
- SubRegion?: string;
3509
- /**
3510
- * <p>A name for an area or geographical division, such as a province or state name. For
3511
- * example, <code>British Columbia</code>.</p>
3512
- */
3513
- Region?: string;
3514
- /**
3515
- * <p>A country/region specified using <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
3516
- * country/region code. For example, <code>CAN</code>.</p>
3517
- */
3518
- Country?: string;
3519
- /**
3520
- * <p>A group of numbers and letters in a country-specific format, which accompanies the
3521
- * address for the purpose of identifying a location. </p>
3522
- */
3523
- PostalCode?: string;
3524
- /**
3525
- * <p>
3526
- * <code>True</code> if the result is interpolated from other known places.</p>
3527
- * <p>
3528
- * <code>False</code> if the Place is a known place.</p>
3529
- * <p>Not returned when the partner does not provide the information.</p>
3530
- * <p>For example, returns <code>False</code> for an address location that is found in the
3531
- * partner data, but returns <code>True</code> if an address does not exist in the partner
3532
- * data and its location is calculated by interpolating between other known addresses.
3533
- * </p>
3534
- */
3535
- Interpolated?: boolean;
3536
- /**
3537
- * <p>The time zone in which the <code>Place</code> is located. Returned only when using
3538
- * Here as the selected partner.</p>
3539
- */
3540
- TimeZone?: TimeZone;
3541
- }
3542
3589
  /**
3543
3590
  * <p>Contains a search result from a position search query that is run on a place index
3544
3591
  * resource.</p>
@@ -3557,6 +3604,15 @@ export interface SearchForPositionResult {
3557
3604
  * </note>
3558
3605
  */
3559
3606
  Distance: number | undefined;
3607
+ /**
3608
+ * <p>The unique identifier of the place. You can use this with the <code>GetPlace</code>
3609
+ * operation to find the place again later.</p>
3610
+ * <note>
3611
+ * <p>For <code>SearchPlaceIndexForPosition</code> operations, the <code>PlaceId</code>
3612
+ * is returned only by place indexes that use HERE as a data provider.</p>
3613
+ * </note>
3614
+ */
3615
+ PlaceId?: string;
3560
3616
  }
3561
3617
  /**
3562
3618
  * <p>A summary of the request sent by using
@@ -3694,6 +3750,17 @@ export interface SearchForSuggestionsResult {
3694
3750
  * <p>The text of the place suggestion, typically formatted as an address string.</p>
3695
3751
  */
3696
3752
  Text: string | undefined;
3753
+ /**
3754
+ * <p>The unique identifier of the place. You can use this with the <code>GetPlace</code>
3755
+ * operation to find the place again later.</p>
3756
+ * <note>
3757
+ * <p>For <code>SearchPlaceIndexForSuggestions</code> operations, the
3758
+ * <code>PlaceId</code> is
3759
+ * returned
3760
+ * by place indexes that use HERE or Esri as data providers.</p>
3761
+ * </note>
3762
+ */
3763
+ PlaceId?: string;
3697
3764
  }
3698
3765
  /**
3699
3766
  * <p>A summary of the request sent by using
@@ -3865,6 +3932,15 @@ export interface SearchForTextResult {
3865
3932
  * <p>Returned only when the partner selected is Esri.</p>
3866
3933
  */
3867
3934
  Relevance?: number;
3935
+ /**
3936
+ * <p>The unique identifier of the place. You can use this with the <code>GetPlace</code>
3937
+ * operation to find the place again later.</p>
3938
+ * <note>
3939
+ * <p>For <code>SearchPlaceIndexForText</code> operations, the <code>PlaceId</code> is
3940
+ * returned only by place indexes that use HERE as a data provider.</p>
3941
+ * </note>
3942
+ */
3943
+ PlaceId?: string;
3868
3944
  }
3869
3945
  /**
3870
3946
  * <p>A summary of the request sent by using <code>SearchPlaceIndexForText</code>.</p>
@@ -3938,8 +4014,8 @@ export interface SearchPlaceIndexForTextResponse {
3938
4014
  /**
3939
4015
  * <p>A list of Places matching the input text. Each result contains additional information
3940
4016
  * about the specific point of interest. </p>
3941
- * <p>Not all response properties are included with all responses. Some properties may
3942
- * only be returned by specific data partners.</p>
4017
+ * <p>Not all response properties are included with all responses. Some properties may only
4018
+ * be returned by specific data partners.</p>
3943
4019
  */
3944
4020
  Results: SearchForTextResult[] | undefined;
3945
4021
  }
@@ -4537,6 +4613,26 @@ export declare const GetMapTileRequestFilterSensitiveLog: (obj: GetMapTileReques
4537
4613
  * @internal
4538
4614
  */
4539
4615
  export declare const GetMapTileResponseFilterSensitiveLog: (obj: GetMapTileResponse) => any;
4616
+ /**
4617
+ * @internal
4618
+ */
4619
+ export declare const GetPlaceRequestFilterSensitiveLog: (obj: GetPlaceRequest) => any;
4620
+ /**
4621
+ * @internal
4622
+ */
4623
+ export declare const PlaceGeometryFilterSensitiveLog: (obj: PlaceGeometry) => any;
4624
+ /**
4625
+ * @internal
4626
+ */
4627
+ export declare const TimeZoneFilterSensitiveLog: (obj: TimeZone) => any;
4628
+ /**
4629
+ * @internal
4630
+ */
4631
+ export declare const PlaceFilterSensitiveLog: (obj: Place) => any;
4632
+ /**
4633
+ * @internal
4634
+ */
4635
+ export declare const GetPlaceResponseFilterSensitiveLog: (obj: GetPlaceResponse) => any;
4540
4636
  /**
4541
4637
  * @internal
4542
4638
  */
@@ -4617,18 +4713,6 @@ export declare const UpdateMapResponseFilterSensitiveLog: (obj: UpdateMapRespons
4617
4713
  * @internal
4618
4714
  */
4619
4715
  export declare const SearchPlaceIndexForPositionRequestFilterSensitiveLog: (obj: SearchPlaceIndexForPositionRequest) => any;
4620
- /**
4621
- * @internal
4622
- */
4623
- export declare const PlaceGeometryFilterSensitiveLog: (obj: PlaceGeometry) => any;
4624
- /**
4625
- * @internal
4626
- */
4627
- export declare const TimeZoneFilterSensitiveLog: (obj: TimeZone) => any;
4628
- /**
4629
- * @internal
4630
- */
4631
- export declare const PlaceFilterSensitiveLog: (obj: Place) => any;
4632
4716
  /**
4633
4717
  * @internal
4634
4718
  */
@@ -32,6 +32,7 @@ import { GetMapGlyphsCommandInput, GetMapGlyphsCommandOutput } from "../commands
32
32
  import { GetMapSpritesCommandInput, GetMapSpritesCommandOutput } from "../commands/GetMapSpritesCommand";
33
33
  import { GetMapStyleDescriptorCommandInput, GetMapStyleDescriptorCommandOutput } from "../commands/GetMapStyleDescriptorCommand";
34
34
  import { GetMapTileCommandInput, GetMapTileCommandOutput } from "../commands/GetMapTileCommand";
35
+ import { GetPlaceCommandInput, GetPlaceCommandOutput } from "../commands/GetPlaceCommand";
35
36
  import { ListDevicePositionsCommandInput, ListDevicePositionsCommandOutput } from "../commands/ListDevicePositionsCommand";
36
37
  import { ListGeofenceCollectionsCommandInput, ListGeofenceCollectionsCommandOutput } from "../commands/ListGeofenceCollectionsCommand";
37
38
  import { ListGeofencesCommandInput, ListGeofencesCommandOutput } from "../commands/ListGeofencesCommand";
@@ -84,6 +85,7 @@ export declare const serializeAws_restJson1GetMapGlyphsCommand: (input: GetMapGl
84
85
  export declare const serializeAws_restJson1GetMapSpritesCommand: (input: GetMapSpritesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
85
86
  export declare const serializeAws_restJson1GetMapStyleDescriptorCommand: (input: GetMapStyleDescriptorCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
86
87
  export declare const serializeAws_restJson1GetMapTileCommand: (input: GetMapTileCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
88
+ export declare const serializeAws_restJson1GetPlaceCommand: (input: GetPlaceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
87
89
  export declare const serializeAws_restJson1ListDevicePositionsCommand: (input: ListDevicePositionsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
88
90
  export declare const serializeAws_restJson1ListGeofenceCollectionsCommand: (input: ListGeofenceCollectionsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
89
91
  export declare const serializeAws_restJson1ListGeofencesCommand: (input: ListGeofencesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
@@ -136,6 +138,7 @@ export declare const deserializeAws_restJson1GetMapGlyphsCommand: (output: __Htt
136
138
  export declare const deserializeAws_restJson1GetMapSpritesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetMapSpritesCommandOutput>;
137
139
  export declare const deserializeAws_restJson1GetMapStyleDescriptorCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetMapStyleDescriptorCommandOutput>;
138
140
  export declare const deserializeAws_restJson1GetMapTileCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetMapTileCommandOutput>;
141
+ export declare const deserializeAws_restJson1GetPlaceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetPlaceCommandOutput>;
139
142
  export declare const deserializeAws_restJson1ListDevicePositionsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListDevicePositionsCommandOutput>;
140
143
  export declare const deserializeAws_restJson1ListGeofenceCollectionsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListGeofenceCollectionsCommandOutput>;
141
144
  export declare const deserializeAws_restJson1ListGeofencesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListGeofencesCommandOutput>;
@@ -127,6 +127,10 @@ import {
127
127
  GetMapTileCommandInput,
128
128
  GetMapTileCommandOutput,
129
129
  } from "./commands/GetMapTileCommand";
130
+ import {
131
+ GetPlaceCommandInput,
132
+ GetPlaceCommandOutput,
133
+ } from "./commands/GetPlaceCommand";
130
134
  import {
131
135
  ListDevicePositionsCommandInput,
132
136
  ListDevicePositionsCommandOutput,
@@ -625,6 +629,19 @@ export declare class Location extends LocationClient {
625
629
  options: __HttpHandlerOptions,
626
630
  cb: (err: any, data?: GetMapTileCommandOutput) => void
627
631
  ): void;
632
+ getPlace(
633
+ args: GetPlaceCommandInput,
634
+ options?: __HttpHandlerOptions
635
+ ): Promise<GetPlaceCommandOutput>;
636
+ getPlace(
637
+ args: GetPlaceCommandInput,
638
+ cb: (err: any, data?: GetPlaceCommandOutput) => void
639
+ ): void;
640
+ getPlace(
641
+ args: GetPlaceCommandInput,
642
+ options: __HttpHandlerOptions,
643
+ cb: (err: any, data?: GetPlaceCommandOutput) => void
644
+ ): void;
628
645
  listDevicePositions(
629
646
  args: ListDevicePositionsCommandInput,
630
647
  options?: __HttpHandlerOptions
@@ -170,6 +170,10 @@ import {
170
170
  GetMapTileCommandInput,
171
171
  GetMapTileCommandOutput,
172
172
  } from "./commands/GetMapTileCommand";
173
+ import {
174
+ GetPlaceCommandInput,
175
+ GetPlaceCommandOutput,
176
+ } from "./commands/GetPlaceCommand";
173
177
  import {
174
178
  ListDevicePositionsCommandInput,
175
179
  ListDevicePositionsCommandOutput,
@@ -283,6 +287,7 @@ export declare type ServiceInputTypes =
283
287
  | GetMapSpritesCommandInput
284
288
  | GetMapStyleDescriptorCommandInput
285
289
  | GetMapTileCommandInput
290
+ | GetPlaceCommandInput
286
291
  | ListDevicePositionsCommandInput
287
292
  | ListGeofenceCollectionsCommandInput
288
293
  | ListGeofencesCommandInput
@@ -336,6 +341,7 @@ export declare type ServiceOutputTypes =
336
341
  | GetMapSpritesCommandOutput
337
342
  | GetMapStyleDescriptorCommandOutput
338
343
  | GetMapTileCommandOutput
344
+ | GetPlaceCommandOutput
339
345
  | ListDevicePositionsCommandOutput
340
346
  | ListGeofenceCollectionsCommandOutput
341
347
  | ListGeofencesCommandOutput
@@ -0,0 +1,32 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import {
3
+ Handler,
4
+ HttpHandlerOptions as __HttpHandlerOptions,
5
+ MetadataBearer as __MetadataBearer,
6
+ MiddlewareStack,
7
+ } from "@aws-sdk/types";
8
+ import {
9
+ LocationClientResolvedConfig,
10
+ ServiceInputTypes,
11
+ ServiceOutputTypes,
12
+ } from "../LocationClient";
13
+ import { GetPlaceRequest, GetPlaceResponse } from "../models/models_0";
14
+ export interface GetPlaceCommandInput extends GetPlaceRequest {}
15
+ export interface GetPlaceCommandOutput
16
+ extends GetPlaceResponse,
17
+ __MetadataBearer {}
18
+ export declare class GetPlaceCommand extends $Command<
19
+ GetPlaceCommandInput,
20
+ GetPlaceCommandOutput,
21
+ LocationClientResolvedConfig
22
+ > {
23
+ readonly input: GetPlaceCommandInput;
24
+ constructor(input: GetPlaceCommandInput);
25
+ resolveMiddleware(
26
+ clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
27
+ configuration: LocationClientResolvedConfig,
28
+ options?: __HttpHandlerOptions
29
+ ): Handler<GetPlaceCommandInput, GetPlaceCommandOutput>;
30
+ private serialize;
31
+ private deserialize;
32
+ }
@@ -30,6 +30,7 @@ export * from "./GetMapGlyphsCommand";
30
30
  export * from "./GetMapSpritesCommand";
31
31
  export * from "./GetMapStyleDescriptorCommand";
32
32
  export * from "./GetMapTileCommand";
33
+ export * from "./GetPlaceCommand";
33
34
  export * from "./ListDevicePositionsCommand";
34
35
  export * from "./ListGeofenceCollectionsCommand";
35
36
  export * from "./ListGeofencesCommand";