UNPKG

@aws-sdk/client-route-53

Version:

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

96 lines (95 loc) 4.38 kB
import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ListTrafficPoliciesRequest, ListTrafficPoliciesResponse } from "../models/models_0"; import type { Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Route53Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ListTrafficPoliciesCommand}. */ export interface ListTrafficPoliciesCommandInput extends ListTrafficPoliciesRequest { } /** * @public * * The output of {@link ListTrafficPoliciesCommand}. */ export interface ListTrafficPoliciesCommandOutput extends ListTrafficPoliciesResponse, __MetadataBearer { } declare const ListTrafficPoliciesCommand_base: { new (input: ListTrafficPoliciesCommandInput): import("@smithy/core/client").CommandImpl<ListTrafficPoliciesCommandInput, ListTrafficPoliciesCommandOutput, Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (...[input]: [] | [ListTrafficPoliciesCommandInput]): import("@smithy/core/client").CommandImpl<ListTrafficPoliciesCommandInput, ListTrafficPoliciesCommandOutput, Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** * <p>Gets information about the latest version for every traffic policy that is associated * with the current Amazon Web Services account. Policies are listed in the order that they * were created in. </p> * <p>For information about how of deleting a traffic policy affects the response from * <code>ListTrafficPolicies</code>, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicy.html">DeleteTrafficPolicy</a>. </p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { Route53Client, ListTrafficPoliciesCommand } from "@aws-sdk/client-route-53"; // ES Modules import * // const { Route53Client, ListTrafficPoliciesCommand } = require("@aws-sdk/client-route-53"); // CommonJS import * // import type { Route53ClientConfig } from "@aws-sdk/client-route-53"; * const config = {}; // type is Route53ClientConfig * const client = new Route53Client(config); * const input = { // ListTrafficPoliciesRequest * TrafficPolicyIdMarker: "STRING_VALUE", * MaxItems: Number("int"), * }; * const command = new ListTrafficPoliciesCommand(input); * const response = await client.send(command); * // { // ListTrafficPoliciesResponse * // TrafficPolicySummaries: [ // TrafficPolicySummaries // required * // { // TrafficPolicySummary * // Id: "STRING_VALUE", // required * // Name: "STRING_VALUE", // required * // Type: "SOA" || "A" || "TXT" || "NS" || "CNAME" || "MX" || "NAPTR" || "PTR" || "SRV" || "SPF" || "AAAA" || "CAA" || "DS" || "TLSA" || "SSHFP" || "SVCB" || "HTTPS", // required * // LatestVersion: Number("int"), // required * // TrafficPolicyCount: Number("int"), // required * // }, * // ], * // IsTruncated: true || false, // required * // TrafficPolicyIdMarker: "STRING_VALUE", // required * // MaxItems: Number("int"), // required * // }; * * ``` * * @param ListTrafficPoliciesCommandInput - {@link ListTrafficPoliciesCommandInput} * @returns {@link ListTrafficPoliciesCommandOutput} * @see {@link ListTrafficPoliciesCommandInput} for command's `input` shape. * @see {@link ListTrafficPoliciesCommandOutput} 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 Route53ServiceException} * <p>Base exception class for all service exceptions from Route53 service.</p> * * * @public */ export declare class ListTrafficPoliciesCommand extends ListTrafficPoliciesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListTrafficPoliciesRequest; output: ListTrafficPoliciesResponse; }; sdk: { input: ListTrafficPoliciesCommandInput; output: ListTrafficPoliciesCommandOutput; }; }; }