@aws-sdk/client-route-53/dist-types/commands/GetGeoLocationCommand.d.ts

AWS SDK for JavaScript Route 53 Client for Node.js, Browser and React Native

import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { GetGeoLocationRequest, GetGeoLocationResponse } from "../models/models_0";
import { Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Route53Client";
/**
 * @public
 */
export type { __MetadataBearer };
export { $Command };
/**
 * @public
 *
 * The input for {@link GetGeoLocationCommand}.
 */
export interface GetGeoLocationCommandInput extends GetGeoLocationRequest {
}
/**
 * @public
 *
 * The output of {@link GetGeoLocationCommand}.
 */
export interface GetGeoLocationCommandOutput extends GetGeoLocationResponse, __MetadataBearer {
}
declare const GetGeoLocationCommand_base: {
    new (input: GetGeoLocationCommandInput): import("@smithy/smithy-client").CommandImpl<GetGeoLocationCommandInput, GetGeoLocationCommandOutput, Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    new (...[input]: [] | [GetGeoLocationCommandInput]): import("@smithy/smithy-client").CommandImpl<GetGeoLocationCommandInput, GetGeoLocationCommandOutput, Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
 * <p>Gets information about whether a specified geographic location is supported for Amazon
 * 			Route 53 geolocation resource record sets.</p>
 *          <p>Route 53 does not perform authorization for this API because it retrieves information
 * 			that is already available to the public.</p>
 *          <p>Use the following syntax to determine whether a continent is supported for
 * 			geolocation:</p>
 *          <p>
 *             <code>GET /2013-04-01/geolocation?continentcode=<i>two-letter abbreviation for
 * 					a continent</i>
 *             </code>
 *          </p>
 *          <p>Use the following syntax to determine whether a country is supported for
 * 			geolocation:</p>
 *          <p>
 *             <code>GET /2013-04-01/geolocation?countrycode=<i>two-character country
 * 					code</i>
 *             </code>
 *          </p>
 *          <p>Use the following syntax to determine whether a subdivision of a country is supported
 * 			for geolocation:</p>
 *          <p>
 *             <code>GET /2013-04-01/geolocation?countrycode=<i>two-character country
 * 					code</i>&subdivisioncode=<i>subdivision
 * 			code</i>
 *             </code>
 *          </p>
 * @example
 * Use a bare-bones client and the command you need to make an API call.
 * ```javascript
 * import { Route53Client, GetGeoLocationCommand } from "@aws-sdk/client-route-53"; // ES Modules import
 * // const { Route53Client, GetGeoLocationCommand } = require("@aws-sdk/client-route-53"); // CommonJS import
 * const client = new Route53Client(config);
 * const input = { // GetGeoLocationRequest
 *   ContinentCode: "STRING_VALUE",
 *   CountryCode: "STRING_VALUE",
 *   SubdivisionCode: "STRING_VALUE",
 * };
 * const command = new GetGeoLocationCommand(input);
 * const response = await client.send(command);
 * // { // GetGeoLocationResponse
 * //   GeoLocationDetails: { // GeoLocationDetails
 * //     ContinentCode: "STRING_VALUE",
 * //     ContinentName: "STRING_VALUE",
 * //     CountryCode: "STRING_VALUE",
 * //     CountryName: "STRING_VALUE",
 * //     SubdivisionCode: "STRING_VALUE",
 * //     SubdivisionName: "STRING_VALUE",
 * //   },
 * // };
 *
 * ```
 *
 * @param GetGeoLocationCommandInput - {@link GetGeoLocationCommandInput}
 * @returns {@link GetGeoLocationCommandOutput}
 * @see {@link GetGeoLocationCommandInput} for command's `input` shape.
 * @see {@link GetGeoLocationCommandOutput} for command's `response` shape.
 * @see {@link Route53ClientResolvedConfig | config} for Route53Client's `config` shape.
 *
 * @throws {@link InvalidInput} (client fault)
 *  <p>The input is not valid.</p>
 *
 * @throws {@link NoSuchGeoLocation} (client fault)
 *  <p>Amazon Route 53 doesn't support the specified geographic location. For a list of
 * 			supported geolocation codes, see the <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_GeoLocation.html">GeoLocation</a> data
 * 			type.</p>
 *
 * @throws {@link Route53ServiceException}
 * <p>Base exception class for all service exceptions from Route53 service.</p>
 *
 * @public
 */
export declare class GetGeoLocationCommand extends GetGeoLocationCommand_base {
    /** @internal type navigation helper, not in runtime. */
    protected static __types: {
        api: {
            input: GetGeoLocationRequest;
            output: GetGeoLocationResponse;
        };
        sdk: {
            input: GetGeoLocationCommandInput;
            output: GetGeoLocationCommandOutput;
        };
    };
}