@aws-sdk/client-geo-places 3.1081.0 → 3.1083.0

package/dist-types/commands/SuggestCommand.d.ts

@@ -55,11 +55,12 @@ declare const SuggestCommand_base: {
  *     ],
  *   },
  *   AdditionalFeatures: [ // SuggestAdditionalFeatureList
- *     "STRING_VALUE",
+ *     "Core" || "TimeZone" || "Phonemes" || "Access" || "CrossReferences",
  *   ],
  *   Language: "STRING_VALUE",
  *   PoliticalView: "STRING_VALUE",
- *   IntendedUse: "STRING_VALUE",
+ *   IntendedUse: "SingleUse",
+ *   TravelMode: "Car" || "Scooter" || "Truck",
  *   Key: "STRING_VALUE",
  * };
  * const command = new SuggestCommand(input);
@@ -69,10 +70,10 @@ declare const SuggestCommand_base: {
  * //   ResultItems: [ // SuggestResultItemList
  * //     { // SuggestResultItem
  * //       Title: "STRING_VALUE", // required
- * //       SuggestResultItemType: "STRING_VALUE", // required
+ * //       SuggestResultItemType: "Place" || "Query", // required
  * //       Place: { // SuggestPlaceResult
  * //         PlaceId: "STRING_VALUE",
- * //         PlaceType: "STRING_VALUE",
+ * //         PlaceType: "Country" || "Region" || "SubRegion" || "Locality" || "District" || "SubDistrict" || "PostalCode" || "Block" || "SubBlock" || "Intersection" || "Street" || "PointOfInterest" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "InferredSecondaryAddress",
  * //         Address: { // Address
  * //           Label: "STRING_VALUE",
  * //           Country: { // Country
@@ -102,7 +103,7 @@ declare const SuggestCommand_base: {
  * //             { // StreetComponents
  * //               BaseName: "STRING_VALUE",
  * //               Type: "STRING_VALUE",
- * //               TypePlacement: "STRING_VALUE",
+ * //               TypePlacement: "BeforeBaseName" || "AfterBaseName",
  * //               TypeSeparator: "STRING_VALUE",
  * //               Prefix: "STRING_VALUE",
  * //               Suffix: "STRING_VALUE",
@@ -152,6 +153,9 @@ declare const SuggestCommand_base: {
  * //             Position: [
  * //               Number("double"),
  * //             ],
+ * //             Type: "Delivery" || "Emergency" || "Entrance" || "Loading" || "Other" || "Parking" || "Taxi",
+ * //             Primary: true || false,
+ * //             Label: "STRING_VALUE",
  * //           },
  * //         ],
  * //         AccessRestrictions: [ // AccessRestrictionList
@@ -217,10 +221,27 @@ declare const SuggestCommand_base: {
  * //             Street: "<PhonemeTranscriptionList>",
  * //           },
  * //         },
+ * //         PlaceAttributes: [ // PlaceAttributeList
+ * //           "DriveThrough",
+ * //         ],
+ * //         CrossReferences: [ // CrossReferenceList
+ * //           { // CrossReference
+ * //             Source: "STRING_VALUE", // required
+ * //             SourcePlaceId: "STRING_VALUE", // required
+ * //             SourceCategories: [
+ * //               {
+ * //                 Id: "STRING_VALUE", // required
+ * //                 Name: "STRING_VALUE", // required
+ * //                 LocalizedName: "STRING_VALUE",
+ * //                 Primary: true || false,
+ * //               },
+ * //             ],
+ * //           },
+ * //         ],
  * //       },
  * //       Query: { // SuggestQueryResult
  * //         QueryId: "STRING_VALUE",
- * //         QueryType: "STRING_VALUE",
+ * //         QueryType: "Category" || "BusinessChain",
  * //       },
  * //       Highlights: { // SuggestHighlights
  * //         Title: [ // HighlightList

package/dist-types/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * <p> The Places API enables powerful location search and geocoding capabilities for your applications, offering global coverage with rich, detailed information. Key features include: </p> <ul> <li> <p>Forward and reverse geocoding for addresses and coordinates</p> </li> <li> <p>Comprehensive place searches with detailed information, including:</p> <ul> <li> <p>Business names and addresses</p> </li> <li> <p>Contact information</p> </li> <li> <p>Hours of operation</p> </li> <li> <p>POI (Points of Interest) categories</p> </li> <li> <p>Food types for restaurants</p> </li> <li> <p>Chain affiliation for relevant businesses</p> </li> </ul> </li> <li> <p>Global data coverage with a wide range of POI categories</p> </li> <li> <p>Regular data updates to ensure accuracy and relevance</p> </li> </ul>
+ * <p> The Places API enables powerful location search and geocoding capabilities for your applications, offering global coverage with rich, detailed information. Key features include: </p> <ul> <li> <p>Forward and reverse geocoding for addresses and coordinates. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_Geocode.html">Geocode</a> and <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_ReverseGeocode.html">ReverseGeocode</a>.</p> </li> <li> <p>Comprehensive place searches with detailed information. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_SearchText.html">SearchText</a>, <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_SearchNearby.html">SearchNearby</a>, and <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_GetPlace.html">GetPlace</a>. Place information you can find include:</p> <ul> <li> <p>Business names and addresses</p> </li> <li> <p>Contact information</p> </li> <li> <p>Hours of operation</p> </li> <li> <p>Points of Interest (POI) categories</p> </li> <li> <p>Food types for restaurants</p> </li> <li> <p>Chain affiliation for relevant businesses</p> </li> </ul> </li> <li> <p>Address and place completion as users type, enhancing input efficiency by completing partial queries with valid addresses. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_Autocomplete.html">Autocomplete</a>.</p> </li> <li> <p>Intelligent place and query recommendation based on user's input or context, returning relevant places, points of interest, query terms, or search categories. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_Suggest.html">Suggest</a>.</p> </li> <li> <p>Global data coverage with a wide range of POI categories.</p> </li> <li> <p>Regular data updates to ensure accuracy and relevance.</p> </li> <li> <p>Bulk address validation for verifying and standardizing large volumes of addresses in a single operation using <a href="https://docs.aws.amazon.com/location/latest/APIReference/Welcome.html#Welcome_Amazon_Location_Service_Jobs">Amazon Location Service Jobs</a>.</p> </li> </ul>
  *
  * @packageDocumentation
  */

package/dist-types/models/enums.d.ts

@@ -1,3 +1,20 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const AccessPointType: {
+    readonly DELIVERY: "Delivery";
+    readonly EMERGENCY: "Emergency";
+    readonly ENTRANCE: "Entrance";
+    readonly LOADING: "Loading";
+    readonly OTHER: "Other";
+    readonly PARKING: "Parking";
+    readonly TAXI: "Taxi";
+};
+/**
+ * @public
+ */
+export type AccessPointType = (typeof AccessPointType)[keyof typeof AccessPointType];
 /**
  * @public
  * @enum
@@ -10,6 +27,48 @@ export declare const TypePlacement: {
  * @public
  */
 export type TypePlacement = (typeof TypePlacement)[keyof typeof TypePlacement];
+/**
+ * @public
+ * @enum
+ */
+export declare const AddressTranslationComponent: {
+    readonly DISTRICT: "District";
+    readonly LOCALITY: "Locality";
+    readonly REGION: "Region";
+    readonly SUB_REGION: "SubRegion";
+};
+/**
+ * @public
+ */
+export type AddressTranslationComponent = (typeof AddressTranslationComponent)[keyof typeof AddressTranslationComponent];
+/**
+ * @public
+ * @enum
+ */
+export declare const TranslationNameType: {
+    readonly ABBREVIATION: "Abbreviation";
+    readonly AREA_CODE: "AreaCode";
+    readonly BASE_NAME: "BaseName";
+    readonly EXONYM: "Exonym";
+    readonly SHORTENED: "Shortened";
+    readonly SYNONYM: "Synonym";
+};
+/**
+ * @public
+ */
+export type TranslationNameType = (typeof TranslationNameType)[keyof typeof TranslationNameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const AdminNamesPreference: {
+    readonly ALTERNATIVE: "Alternative";
+    readonly PRIMARY: "Primary";
+};
+/**
+ * @public
+ */
+export type AdminNamesPreference = (typeof AdminNamesPreference)[keyof typeof AdminNamesPreference];
 /**
  * @public
  * @enum
@@ -26,8 +85,14 @@ export type AutocompleteAdditionalFeature = (typeof AutocompleteAdditionalFeatur
  * @enum
  */
 export declare const AutocompleteFilterPlaceType: {
+    readonly COUNTRY: "Country";
+    readonly INTERPOLATED_ADDRESS: "InterpolatedAddress";
+    readonly INTERSECTION: "Intersection";
     readonly LOCALITY: "Locality";
+    readonly POINT_ADDRESS: "PointAddress";
     readonly POSTAL_CODE: "PostalCode";
+    readonly REGION: "Region";
+    readonly STREET: "Street";
 };
 /**
  * @public
@@ -52,6 +117,7 @@ export type AutocompleteIntendedUse = (typeof AutocompleteIntendedUse)[keyof typ
  * @enum
  */
 export declare const PostalCodeMode: {
+    readonly ENUMERATE_SPANNED_DISTRICTS: "EnumerateSpannedDistricts";
     readonly ENUMERATE_SPANNED_LOCALITIES: "EnumerateSpannedLocalities";
     readonly MERGE_ALL_SPANNED_LOCALITIES: "MergeAllSpannedLocalities";
 };
@@ -90,17 +156,7 @@ export type PlaceType = (typeof PlaceType)[keyof typeof PlaceType];
  * @enum
  */
 export declare const ValidationExceptionReason: {
-    /**
-     *     The input cannot be parsed. For example a required JSON document, ARN identifier,
-     *     date value, or numeric field cannot be parsed.
-     *
-     */
     readonly CANNOT_PARSE: "CannotParse";
-    /**
-     *     The input is present and parsable, but it is otherwise invalid. For example, a
-     *     required numeric argument is outside the allowed range.
-     *
-     */
     readonly FIELD_VALIDATION_FAILED: "FieldValidationFailed";
     /**
      * The required input is missing.
@@ -137,16 +193,32 @@ export declare const GeocodeAdditionalFeature: {
  * @public
  */
 export type GeocodeAdditionalFeature = (typeof GeocodeAdditionalFeature)[keyof typeof GeocodeAdditionalFeature];
+/**
+ * @public
+ * @enum
+ */
+export declare const GeocodeAddressNamesMode: {
+    readonly ADMINISTRATIVE: "Administrative";
+    readonly MATCHED: "Matched";
+};
+/**
+ * @public
+ */
+export type GeocodeAddressNamesMode = (typeof GeocodeAddressNamesMode)[keyof typeof GeocodeAddressNamesMode];
 /**
  * @public
  * @enum
  */
 export declare const GeocodeFilterPlaceType: {
+    readonly COUNTRY: "Country";
     readonly INTERPOLATED_ADDRESS: "InterpolatedAddress";
     readonly INTERSECTION: "Intersection";
     readonly LOCALITY: "Locality";
     readonly POINT_ADDRESS: "PointAddress";
+    readonly POINT_OF_INTEREST: "PointOfInterest";
     readonly POSTAL_CODE: "PostalCode";
+    readonly REGION: "Region";
+    readonly SECONDARY_ADDRESS: "SecondaryAddress";
     readonly STREET: "Street";
 };
 /**
@@ -230,6 +302,7 @@ export type RecordTypeCode = (typeof RecordTypeCode)[keyof typeof RecordTypeCode
 export declare const GetPlaceAdditionalFeature: {
     readonly ACCESS: "Access";
     readonly CONTACT: "Contact";
+    readonly CROSS_REFERENCES: "CrossReferences";
     readonly PHONEMES: "Phonemes";
     readonly SECONDARY_ADDRESSES: "SecondaryAddresses";
     readonly TIME_ZONE: "TimeZone";
@@ -238,6 +311,17 @@ export declare const GetPlaceAdditionalFeature: {
  * @public
  */
 export type GetPlaceAdditionalFeature = (typeof GetPlaceAdditionalFeature)[keyof typeof GetPlaceAdditionalFeature];
+/**
+ * @public
+ * @enum
+ */
+export declare const GetPlaceAddressNamesMode: {
+    readonly ADMINISTRATIVE: "Administrative";
+};
+/**
+ * @public
+ */
+export type GetPlaceAddressNamesMode = (typeof GetPlaceAddressNamesMode)[keyof typeof GetPlaceAddressNamesMode];
 /**
  * @public
  * @enum
@@ -256,6 +340,17 @@ export declare const GetPlaceIntendedUse: {
  * @public
  */
 export type GetPlaceIntendedUse = (typeof GetPlaceIntendedUse)[keyof typeof GetPlaceIntendedUse];
+/**
+ * @public
+ * @enum
+ */
+export declare const PlaceAttribute: {
+    readonly DRIVE_THROUGH: "DriveThrough";
+};
+/**
+ * @public
+ */
+export type PlaceAttribute = (typeof PlaceAttribute)[keyof typeof PlaceAttribute];
 /**
  * @public
  * @enum
@@ -269,6 +364,17 @@ export declare const ReverseGeocodeAdditionalFeature: {
  * @public
  */
 export type ReverseGeocodeAdditionalFeature = (typeof ReverseGeocodeAdditionalFeature)[keyof typeof ReverseGeocodeAdditionalFeature];
+/**
+ * @public
+ * @enum
+ */
+export declare const ReverseGeocodeAddressNamesMode: {
+    readonly ADMINISTRATIVE: "Administrative";
+};
+/**
+ * @public
+ */
+export type ReverseGeocodeAddressNamesMode = (typeof ReverseGeocodeAddressNamesMode)[keyof typeof ReverseGeocodeAddressNamesMode];
 /**
  * @public
  * @enum
@@ -278,6 +384,8 @@ export declare const ReverseGeocodeFilterPlaceType: {
     readonly INTERSECTION: "Intersection";
     readonly LOCALITY: "Locality";
     readonly POINT_ADDRESS: "PointAddress";
+    readonly POINT_OF_INTEREST: "PointOfInterest";
+    readonly SECONDARY_ADDRESS: "SecondaryAddress";
     readonly STREET: "Street";
 };
 /**
@@ -309,6 +417,7 @@ export type ReverseGeocodeIntendedUse = (typeof ReverseGeocodeIntendedUse)[keyof
 export declare const SearchNearbyAdditionalFeature: {
     readonly ACCESS: "Access";
     readonly CONTACT: "Contact";
+    readonly CROSS_REFERENCES: "CrossReferences";
     readonly PHONEMES: "Phonemes";
     readonly TIME_ZONE: "TimeZone";
 };
@@ -341,6 +450,7 @@ export type SearchNearbyIntendedUse = (typeof SearchNearbyIntendedUse)[keyof typ
 export declare const SearchTextAdditionalFeature: {
     readonly ACCESS: "Access";
     readonly CONTACT: "Contact";
+    readonly CROSS_REFERENCES: "CrossReferences";
     readonly PHONEMES: "Phonemes";
     readonly TIME_ZONE: "TimeZone";
 };
@@ -366,6 +476,19 @@ export declare const SearchTextIntendedUse: {
  * @public
  */
 export type SearchTextIntendedUse = (typeof SearchTextIntendedUse)[keyof typeof SearchTextIntendedUse];
+/**
+ * @public
+ * @enum
+ */
+export declare const SearchTextTravelMode: {
+    readonly CAR: "Car";
+    readonly SCOOTER: "Scooter";
+    readonly TRUCK: "Truck";
+};
+/**
+ * @public
+ */
+export type SearchTextTravelMode = (typeof SearchTextTravelMode)[keyof typeof SearchTextTravelMode];
 /**
  * @public
  * @enum
@@ -373,6 +496,7 @@ export type SearchTextIntendedUse = (typeof SearchTextIntendedUse)[keyof typeof
 export declare const SuggestAdditionalFeature: {
     readonly ACCESS: "Access";
     readonly CORE: "Core";
+    readonly CROSS_REFERENCES: "CrossReferences";
     readonly PHONEMES: "Phonemes";
     readonly TIME_ZONE: "TimeZone";
 };
@@ -394,6 +518,19 @@ export declare const SuggestIntendedUse: {
  * @public
  */
 export type SuggestIntendedUse = (typeof SuggestIntendedUse)[keyof typeof SuggestIntendedUse];
+/**
+ * @public
+ * @enum
+ */
+export declare const SuggestTravelMode: {
+    readonly CAR: "Car";
+    readonly SCOOTER: "Scooter";
+    readonly TRUCK: "Truck";
+};
+/**
+ * @public
+ */
+export type SuggestTravelMode = (typeof SuggestTravelMode)[keyof typeof SuggestTravelMode];
 /**
  * @public
  * @enum