@aws-sdk/client-geo-places 3.683.0

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

@@ -0,0 +1,312 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GeoPlacesClient";
+import { GetPlaceRequest, GetPlaceResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetPlaceCommand}.
+ */
+export interface GetPlaceCommandInput extends GetPlaceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetPlaceCommand}.
+ */
+export interface GetPlaceCommandOutput extends GetPlaceResponse, __MetadataBearer {
+}
+declare const GetPlaceCommand_base: {
+    new (input: GetPlaceCommandInput): import("@smithy/smithy-client").CommandImpl<GetPlaceCommandInput, GetPlaceCommandOutput, GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetPlaceCommandInput): import("@smithy/smithy-client").CommandImpl<GetPlaceCommandInput, GetPlaceCommandOutput, GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Finds a place by its unique ID. A <code>PlaceId</code> is returned by other place
+ *          operations.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GeoPlacesClient, GetPlaceCommand } from "@aws-sdk/client-geo-places"; // ES Modules import
+ * // const { GeoPlacesClient, GetPlaceCommand } = require("@aws-sdk/client-geo-places"); // CommonJS import
+ * const client = new GeoPlacesClient(config);
+ * const input = { // GetPlaceRequest
+ *   PlaceId: "STRING_VALUE", // required
+ *   AdditionalFeatures: [ // GetPlaceAdditionalFeatureList
+ *     "STRING_VALUE",
+ *   ],
+ *   Language: "STRING_VALUE",
+ *   PoliticalView: "STRING_VALUE",
+ *   IntendedUse: "STRING_VALUE",
+ *   Key: "STRING_VALUE",
+ * };
+ * const command = new GetPlaceCommand(input);
+ * const response = await client.send(command);
+ * // { // GetPlaceResponse
+ * //   PlaceId: "STRING_VALUE", // required
+ * //   PlaceType: "STRING_VALUE", // required
+ * //   Title: "STRING_VALUE", // required
+ * //   PricingBucket: "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"),
+ * //   ],
+ * //   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,
+ * //     },
+ * //   ],
+ * //   BusinessChains: [ // BusinessChainList
+ * //     { // BusinessChain
+ * //       Name: "STRING_VALUE",
+ * //       Id: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   Contacts: { // Contacts
+ * //     Phones: [ // ContactDetailsList
+ * //       { // ContactDetails
+ * //         Label: "STRING_VALUE",
+ * //         Value: "STRING_VALUE",
+ * //         Categories: [
+ * //           {
+ * //             Id: "STRING_VALUE", // required
+ * //             Name: "STRING_VALUE", // required
+ * //             LocalizedName: "STRING_VALUE",
+ * //             Primary: true || false,
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //     Faxes: [
+ * //       {
+ * //         Label: "STRING_VALUE",
+ * //         Value: "STRING_VALUE",
+ * //         Categories: [
+ * //           {
+ * //             Id: "STRING_VALUE", // required
+ * //             Name: "STRING_VALUE", // required
+ * //             LocalizedName: "STRING_VALUE",
+ * //             Primary: true || false,
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //     Websites: [
+ * //       {
+ * //         Label: "STRING_VALUE",
+ * //         Value: "STRING_VALUE",
+ * //         Categories: [
+ * //           {
+ * //             Id: "STRING_VALUE", // required
+ * //             Name: "STRING_VALUE", // required
+ * //             LocalizedName: "STRING_VALUE",
+ * //             Primary: true || false,
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //     Emails: [
+ * //       {
+ * //         Label: "STRING_VALUE",
+ * //         Value: "STRING_VALUE",
+ * //         Categories: [
+ * //           {
+ * //             Id: "STRING_VALUE", // required
+ * //             Name: "STRING_VALUE", // required
+ * //             LocalizedName: "STRING_VALUE",
+ * //             Primary: true || false,
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //   },
+ * //   OpeningHours: [ // OpeningHoursList
+ * //     { // OpeningHours
+ * //       Display: [ // OpeningHoursDisplayList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       OpenNow: true || false,
+ * //       Components: [ // OpeningHoursComponentsList
+ * //         { // OpeningHoursComponents
+ * //           OpenTime: "STRING_VALUE",
+ * //           OpenDuration: "STRING_VALUE",
+ * //           Recurrence: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       Categories: "<CategoryList>",
+ * //     },
+ * //   ],
+ * //   AccessPoints: [ // AccessPointList
+ * //     { // AccessPoint
+ * //       Position: [
+ * //         Number("double"),
+ * //       ],
+ * //     },
+ * //   ],
+ * //   AccessRestrictions: [ // AccessRestrictionList
+ * //     { // AccessRestriction
+ * //       Restricted: true || false,
+ * //       Categories: "<CategoryList>",
+ * //     },
+ * //   ],
+ * //   TimeZone: { // TimeZone
+ * //     Name: "STRING_VALUE", // required
+ * //     Offset: "STRING_VALUE",
+ * //     OffsetSeconds: Number("long"),
+ * //   },
+ * //   PoliticalView: "STRING_VALUE",
+ * //   Phonemes: { // PhonemeDetails
+ * //     Title: [ // PhonemeTranscriptionList
+ * //       { // PhonemeTranscription
+ * //         Value: "STRING_VALUE",
+ * //         Language: "STRING_VALUE",
+ * //         Preferred: true || false,
+ * //       },
+ * //     ],
+ * //     Address: { // AddressComponentPhonemes
+ * //       Country: [
+ * //         {
+ * //           Value: "STRING_VALUE",
+ * //           Language: "STRING_VALUE",
+ * //           Preferred: true || false,
+ * //         },
+ * //       ],
+ * //       Region: [
+ * //         {
+ * //           Value: "STRING_VALUE",
+ * //           Language: "STRING_VALUE",
+ * //           Preferred: true || false,
+ * //         },
+ * //       ],
+ * //       SubRegion: [
+ * //         {
+ * //           Value: "STRING_VALUE",
+ * //           Language: "STRING_VALUE",
+ * //           Preferred: true || false,
+ * //         },
+ * //       ],
+ * //       Locality: [
+ * //         {
+ * //           Value: "STRING_VALUE",
+ * //           Language: "STRING_VALUE",
+ * //           Preferred: true || false,
+ * //         },
+ * //       ],
+ * //       District: "<PhonemeTranscriptionList>",
+ * //       SubDistrict: "<PhonemeTranscriptionList>",
+ * //       Block: "<PhonemeTranscriptionList>",
+ * //       SubBlock: "<PhonemeTranscriptionList>",
+ * //       Street: "<PhonemeTranscriptionList>",
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetPlaceCommandInput - {@link GetPlaceCommandInput}
+ * @returns {@link GetPlaceCommandOutput}
+ * @see {@link GetPlaceCommandInput} for command's `input` shape.
+ * @see {@link GetPlaceCommandOutput} 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 GetPlaceCommand extends GetPlaceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetPlaceRequest;
+            output: GetPlaceResponse;
+        };
+        sdk: {
+            input: GetPlaceCommandInput;
+            output: GetPlaceCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,196 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GeoPlacesClient";
+import { ReverseGeocodeRequest, ReverseGeocodeResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ReverseGeocodeCommand}.
+ */
+export interface ReverseGeocodeCommandInput extends ReverseGeocodeRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ReverseGeocodeCommand}.
+ */
+export interface ReverseGeocodeCommandOutput extends ReverseGeocodeResponse, __MetadataBearer {
+}
+declare const ReverseGeocodeCommand_base: {
+    new (input: ReverseGeocodeCommandInput): import("@smithy/smithy-client").CommandImpl<ReverseGeocodeCommandInput, ReverseGeocodeCommandOutput, GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ReverseGeocodeCommandInput): import("@smithy/smithy-client").CommandImpl<ReverseGeocodeCommandInput, ReverseGeocodeCommandOutput, GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p> The <code>ReverseGeocode</code> operation allows you to retrieve addresses and place
+ *          information from coordinates.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GeoPlacesClient, ReverseGeocodeCommand } from "@aws-sdk/client-geo-places"; // ES Modules import
+ * // const { GeoPlacesClient, ReverseGeocodeCommand } = require("@aws-sdk/client-geo-places"); // CommonJS import
+ * const client = new GeoPlacesClient(config);
+ * const input = { // ReverseGeocodeRequest
+ *   QueryPosition: [ // Position // required
+ *     Number("double"),
+ *   ],
+ *   QueryRadius: Number("long"),
+ *   MaxResults: Number("int"),
+ *   Filter: { // ReverseGeocodeFilter
+ *     IncludePlaceTypes: [ // ReverseGeocodeFilterPlaceTypeList
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   AdditionalFeatures: [ // ReverseGeocodeAdditionalFeatureList
+ *     "STRING_VALUE",
+ *   ],
+ *   Language: "STRING_VALUE",
+ *   PoliticalView: "STRING_VALUE",
+ *   IntendedUse: "STRING_VALUE",
+ *   Key: "STRING_VALUE",
+ * };
+ * const command = new ReverseGeocodeCommand(input);
+ * const response = await client.send(command);
+ * // { // ReverseGeocodeResponse
+ * //   PricingBucket: "STRING_VALUE", // required
+ * //   ResultItems: [ // ReverseGeocodeResultItemList
+ * //     { // ReverseGeocodeResultItem
+ * //       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",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ReverseGeocodeCommandInput - {@link ReverseGeocodeCommandInput}
+ * @returns {@link ReverseGeocodeCommandOutput}
+ * @see {@link ReverseGeocodeCommandInput} for command's `input` shape.
+ * @see {@link ReverseGeocodeCommandOutput} 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 ReverseGeocodeCommand extends ReverseGeocodeCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ReverseGeocodeRequest;
+            output: ReverseGeocodeResponse;
+        };
+        sdk: {
+            input: ReverseGeocodeCommandInput;
+            output: ReverseGeocodeCommandOutput;
+        };
+    };
+}