@aws-sdk/client-geo-places 3.683.0

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

@@ -0,0 +1,204 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GeoPlacesClient";
+import { AutocompleteRequest, AutocompleteResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link AutocompleteCommand}.
+ */
+export interface AutocompleteCommandInput extends AutocompleteRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link AutocompleteCommand}.
+ */
+export interface AutocompleteCommandOutput extends AutocompleteResponse, __MetadataBearer {
+}
+declare const AutocompleteCommand_base: {
+    new (input: AutocompleteCommandInput): import("@smithy/smithy-client").CommandImpl<AutocompleteCommandInput, AutocompleteCommandOutput, GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: AutocompleteCommandInput): import("@smithy/smithy-client").CommandImpl<AutocompleteCommandInput, AutocompleteCommandOutput, GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>The autocomplete operation speeds up and increases the accuracy of entering addresses by providing a list of address candidates matching a partially entered address. Results are sorted from most to least matching. Filtering and biasing can be used to increase the relevance of the results if additional search context is known</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GeoPlacesClient, AutocompleteCommand } from "@aws-sdk/client-geo-places"; // ES Modules import
+ * // const { GeoPlacesClient, AutocompleteCommand } = require("@aws-sdk/client-geo-places"); // CommonJS import
+ * const client = new GeoPlacesClient(config);
+ * const input = { // AutocompleteRequest
+ *   QueryText: "STRING_VALUE", // required
+ *   MaxResults: Number("int"),
+ *   BiasPosition: [ // Position
+ *     Number("double"),
+ *   ],
+ *   Filter: { // AutocompleteFilter
+ *     BoundingBox: [ // BoundingBox
+ *       Number("double"),
+ *     ],
+ *     Circle: { // FilterCircle
+ *       Center: [ // required
+ *         Number("double"),
+ *       ],
+ *       Radius: Number("long"), // required
+ *     },
+ *     IncludeCountries: [ // CountryCodeList
+ *       "STRING_VALUE",
+ *     ],
+ *     IncludePlaceTypes: [ // AutocompleteFilterPlaceTypeList
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   PostalCodeMode: "STRING_VALUE",
+ *   AdditionalFeatures: [ // AutocompleteAdditionalFeatureList
+ *     "STRING_VALUE",
+ *   ],
+ *   Language: "STRING_VALUE",
+ *   PoliticalView: "STRING_VALUE",
+ *   IntendedUse: "STRING_VALUE",
+ *   Key: "STRING_VALUE",
+ * };
+ * const command = new AutocompleteCommand(input);
+ * const response = await client.send(command);
+ * // { // AutocompleteResponse
+ * //   PricingBucket: "STRING_VALUE", // required
+ * //   ResultItems: [ // AutocompleteResultItemList
+ * //     { // AutocompleteResultItem
+ * //       PlaceId: "STRING_VALUE", // required
+ * //       PlaceType: "STRING_VALUE", // required
+ * //       Title: "STRING_VALUE", // required
+ * //       Address: { // Address
+ * //         Label: "STRING_VALUE",
+ * //         Country: { // Country
+ * //           Code2: "STRING_VALUE",
+ * //           Code3: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //         },
+ * //         Region: { // Region
+ * //           Code: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //         },
+ * //         SubRegion: { // SubRegion
+ * //           Code: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //         },
+ * //         Locality: "STRING_VALUE",
+ * //         District: "STRING_VALUE",
+ * //         SubDistrict: "STRING_VALUE",
+ * //         PostalCode: "STRING_VALUE",
+ * //         Block: "STRING_VALUE",
+ * //         SubBlock: "STRING_VALUE",
+ * //         Intersection: [ // IntersectionList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Street: "STRING_VALUE",
+ * //         StreetComponents: [ // StreetComponentsList
+ * //           { // StreetComponents
+ * //             BaseName: "STRING_VALUE",
+ * //             Type: "STRING_VALUE",
+ * //             TypePlacement: "STRING_VALUE",
+ * //             TypeSeparator: "STRING_VALUE",
+ * //             Prefix: "STRING_VALUE",
+ * //             Suffix: "STRING_VALUE",
+ * //             Direction: "STRING_VALUE",
+ * //             Language: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //         AddressNumber: "STRING_VALUE",
+ * //         Building: "STRING_VALUE",
+ * //       },
+ * //       Distance: Number("long"),
+ * //       Language: "STRING_VALUE",
+ * //       PoliticalView: "STRING_VALUE",
+ * //       Highlights: { // AutocompleteHighlights
+ * //         Title: [ // HighlightList
+ * //           { // Highlight
+ * //             StartIndex: Number("int"),
+ * //             EndIndex: Number("int"),
+ * //             Value: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //         Address: { // AutocompleteAddressHighlights
+ * //           Label: [
+ * //             {
+ * //               StartIndex: Number("int"),
+ * //               EndIndex: Number("int"),
+ * //               Value: "STRING_VALUE",
+ * //             },
+ * //           ],
+ * //           Country: { // CountryHighlights
+ * //             Code: "<HighlightList>",
+ * //             Name: "<HighlightList>",
+ * //           },
+ * //           Region: { // RegionHighlights
+ * //             Code: "<HighlightList>",
+ * //             Name: "<HighlightList>",
+ * //           },
+ * //           SubRegion: { // SubRegionHighlights
+ * //             Code: "<HighlightList>",
+ * //             Name: "<HighlightList>",
+ * //           },
+ * //           Locality: "<HighlightList>",
+ * //           District: "<HighlightList>",
+ * //           SubDistrict: "<HighlightList>",
+ * //           Street: "<HighlightList>",
+ * //           Block: "<HighlightList>",
+ * //           SubBlock: "<HighlightList>",
+ * //           Intersection: [ // IntersectionHighlightsList
+ * //             "<HighlightList>",
+ * //           ],
+ * //           PostalCode: "<HighlightList>",
+ * //           AddressNumber: "<HighlightList>",
+ * //           Building: "<HighlightList>",
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param AutocompleteCommandInput - {@link AutocompleteCommandInput}
+ * @returns {@link AutocompleteCommandOutput}
+ * @see {@link AutocompleteCommandInput} for command's `input` shape.
+ * @see {@link AutocompleteCommandOutput} for command's `response` shape.
+ * @see {@link GeoPlacesClientResolvedConfig | config} for GeoPlacesClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or failure.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an AWS service.</p>
+ *
+ * @throws {@link GeoPlacesServiceException}
+ * <p>Base exception class for all service exceptions from GeoPlaces service.</p>
+ *
+ * @public
+ */
+export declare class AutocompleteCommand extends AutocompleteCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: AutocompleteRequest;
+            output: AutocompleteResponse;
+        };
+        sdk: {
+            input: AutocompleteCommandInput;
+            output: AutocompleteCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,231 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GeoPlacesClient";
+import { GeocodeRequest, GeocodeResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GeocodeCommand}.
+ */
+export interface GeocodeCommandInput extends GeocodeRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GeocodeCommand}.
+ */
+export interface GeocodeCommandOutput extends GeocodeResponse, __MetadataBearer {
+}
+declare const GeocodeCommand_base: {
+    new (input: GeocodeCommandInput): import("@smithy/smithy-client").CommandImpl<GeocodeCommandInput, GeocodeCommandOutput, GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [GeocodeCommandInput]): import("@smithy/smithy-client").CommandImpl<GeocodeCommandInput, GeocodeCommandOutput, GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>The <code>Geocode</code> action allows you to obtain coordinates, addresses, and other
+ *          information about places.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GeoPlacesClient, GeocodeCommand } from "@aws-sdk/client-geo-places"; // ES Modules import
+ * // const { GeoPlacesClient, GeocodeCommand } = require("@aws-sdk/client-geo-places"); // CommonJS import
+ * const client = new GeoPlacesClient(config);
+ * const input = { // GeocodeRequest
+ *   QueryText: "STRING_VALUE",
+ *   QueryComponents: { // GeocodeQueryComponents
+ *     Country: "STRING_VALUE",
+ *     Region: "STRING_VALUE",
+ *     SubRegion: "STRING_VALUE",
+ *     Locality: "STRING_VALUE",
+ *     District: "STRING_VALUE",
+ *     Street: "STRING_VALUE",
+ *     AddressNumber: "STRING_VALUE",
+ *     PostalCode: "STRING_VALUE",
+ *   },
+ *   MaxResults: Number("int"),
+ *   BiasPosition: [ // Position
+ *     Number("double"),
+ *   ],
+ *   Filter: { // GeocodeFilter
+ *     IncludeCountries: [ // CountryCodeList
+ *       "STRING_VALUE",
+ *     ],
+ *     IncludePlaceTypes: [ // GeocodeFilterPlaceTypeList
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   AdditionalFeatures: [ // GeocodeAdditionalFeatureList
+ *     "STRING_VALUE",
+ *   ],
+ *   Language: "STRING_VALUE",
+ *   PoliticalView: "STRING_VALUE",
+ *   IntendedUse: "STRING_VALUE",
+ *   Key: "STRING_VALUE",
+ * };
+ * const command = new GeocodeCommand(input);
+ * const response = await client.send(command);
+ * // { // GeocodeResponse
+ * //   PricingBucket: "STRING_VALUE", // required
+ * //   ResultItems: [ // GeocodeResultItemList
+ * //     { // GeocodeResultItem
+ * //       PlaceId: "STRING_VALUE", // required
+ * //       PlaceType: "STRING_VALUE", // required
+ * //       Title: "STRING_VALUE", // required
+ * //       Address: { // Address
+ * //         Label: "STRING_VALUE",
+ * //         Country: { // Country
+ * //           Code2: "STRING_VALUE",
+ * //           Code3: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //         },
+ * //         Region: { // Region
+ * //           Code: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //         },
+ * //         SubRegion: { // SubRegion
+ * //           Code: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //         },
+ * //         Locality: "STRING_VALUE",
+ * //         District: "STRING_VALUE",
+ * //         SubDistrict: "STRING_VALUE",
+ * //         PostalCode: "STRING_VALUE",
+ * //         Block: "STRING_VALUE",
+ * //         SubBlock: "STRING_VALUE",
+ * //         Intersection: [ // IntersectionList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Street: "STRING_VALUE",
+ * //         StreetComponents: [ // StreetComponentsList
+ * //           { // StreetComponents
+ * //             BaseName: "STRING_VALUE",
+ * //             Type: "STRING_VALUE",
+ * //             TypePlacement: "STRING_VALUE",
+ * //             TypeSeparator: "STRING_VALUE",
+ * //             Prefix: "STRING_VALUE",
+ * //             Suffix: "STRING_VALUE",
+ * //             Direction: "STRING_VALUE",
+ * //             Language: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //         AddressNumber: "STRING_VALUE",
+ * //         Building: "STRING_VALUE",
+ * //       },
+ * //       AddressNumberCorrected: true || false,
+ * //       PostalCodeDetails: [ // PostalCodeDetailsList
+ * //         { // PostalCodeDetails
+ * //           PostalCode: "STRING_VALUE",
+ * //           PostalAuthority: "STRING_VALUE",
+ * //           PostalCodeType: "STRING_VALUE",
+ * //           UspsZip: { // UspsZip
+ * //             ZipClassificationCode: "STRING_VALUE",
+ * //           },
+ * //           UspsZipPlus4: { // UspsZipPlus4
+ * //             RecordTypeCode: "STRING_VALUE",
+ * //           },
+ * //         },
+ * //       ],
+ * //       Position: [ // Position
+ * //         Number("double"),
+ * //       ],
+ * //       Distance: Number("long"),
+ * //       MapView: [ // BoundingBox
+ * //         Number("double"),
+ * //       ],
+ * //       Categories: [ // CategoryList
+ * //         { // Category
+ * //           Id: "STRING_VALUE", // required
+ * //           Name: "STRING_VALUE", // required
+ * //           LocalizedName: "STRING_VALUE",
+ * //           Primary: true || false,
+ * //         },
+ * //       ],
+ * //       FoodTypes: [ // FoodTypeList
+ * //         { // FoodType
+ * //           LocalizedName: "STRING_VALUE", // required
+ * //           Id: "STRING_VALUE",
+ * //           Primary: true || false,
+ * //         },
+ * //       ],
+ * //       AccessPoints: [ // AccessPointList
+ * //         { // AccessPoint
+ * //           Position: [
+ * //             Number("double"),
+ * //           ],
+ * //         },
+ * //       ],
+ * //       TimeZone: { // TimeZone
+ * //         Name: "STRING_VALUE", // required
+ * //         Offset: "STRING_VALUE",
+ * //         OffsetSeconds: Number("long"),
+ * //       },
+ * //       PoliticalView: "STRING_VALUE",
+ * //       MatchScores: { // MatchScoreDetails
+ * //         Overall: Number("double"),
+ * //         Components: { // ComponentMatchScores
+ * //           Title: Number("double"),
+ * //           Address: { // AddressComponentMatchScores
+ * //             Country: Number("double"),
+ * //             Region: Number("double"),
+ * //             SubRegion: Number("double"),
+ * //             Locality: Number("double"),
+ * //             District: Number("double"),
+ * //             SubDistrict: Number("double"),
+ * //             PostalCode: Number("double"),
+ * //             Block: Number("double"),
+ * //             SubBlock: Number("double"),
+ * //             Intersection: [ // MatchScoreList
+ * //               Number("double"),
+ * //             ],
+ * //             AddressNumber: Number("double"),
+ * //             Building: Number("double"),
+ * //           },
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param GeocodeCommandInput - {@link GeocodeCommandInput}
+ * @returns {@link GeocodeCommandOutput}
+ * @see {@link GeocodeCommandInput} for command's `input` shape.
+ * @see {@link GeocodeCommandOutput} for command's `response` shape.
+ * @see {@link GeoPlacesClientResolvedConfig | config} for GeoPlacesClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or failure.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an AWS service.</p>
+ *
+ * @throws {@link GeoPlacesServiceException}
+ * <p>Base exception class for all service exceptions from GeoPlaces service.</p>
+ *
+ * @public
+ */
+export declare class GeocodeCommand extends GeocodeCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GeocodeRequest;
+            output: GeocodeResponse;
+        };
+        sdk: {
+            input: GeocodeCommandInput;
+            output: GeocodeCommandOutput;
+        };
+    };
+}