@aws-sdk/client-route-53
Version:
AWS SDK for JavaScript Route 53 Client for Node.js, Browser and React Native
88 lines (87 loc) • 3.91 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { GetTrafficPolicyRequest, GetTrafficPolicyResponse } from "../models/models_0";
import { Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Route53Client";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link GetTrafficPolicyCommand}.
*/
export interface GetTrafficPolicyCommandInput extends GetTrafficPolicyRequest {
}
/**
* @public
*
* The output of {@link GetTrafficPolicyCommand}.
*/
export interface GetTrafficPolicyCommandOutput extends GetTrafficPolicyResponse, __MetadataBearer {
}
declare const GetTrafficPolicyCommand_base: {
new (input: GetTrafficPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetTrafficPolicyCommandInput, GetTrafficPolicyCommandOutput, Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (__0_0: GetTrafficPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetTrafficPolicyCommandInput, GetTrafficPolicyCommandOutput, Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Gets information about a specific traffic policy version.</p>
* <p>For information about how of deleting a traffic policy affects the response from
* <code>GetTrafficPolicy</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, GetTrafficPolicyCommand } from "@aws-sdk/client-route-53"; // ES Modules import
* // const { Route53Client, GetTrafficPolicyCommand } = require("@aws-sdk/client-route-53"); // CommonJS import
* const client = new Route53Client(config);
* const input = { // GetTrafficPolicyRequest
* Id: "STRING_VALUE", // required
* Version: Number("int"), // required
* };
* const command = new GetTrafficPolicyCommand(input);
* const response = await client.send(command);
* // { // GetTrafficPolicyResponse
* // TrafficPolicy: { // TrafficPolicy
* // Id: "STRING_VALUE", // required
* // Version: Number("int"), // required
* // Name: "STRING_VALUE", // required
* // Type: "SOA" || "A" || "TXT" || "NS" || "CNAME" || "MX" || "NAPTR" || "PTR" || "SRV" || "SPF" || "AAAA" || "CAA" || "DS" || "TLSA" || "SSHFP" || "SVCB" || "HTTPS", // required
* // Document: "STRING_VALUE", // required
* // Comment: "STRING_VALUE",
* // },
* // };
*
* ```
*
* @param GetTrafficPolicyCommandInput - {@link GetTrafficPolicyCommandInput}
* @returns {@link GetTrafficPolicyCommandOutput}
* @see {@link GetTrafficPolicyCommandInput} for command's `input` shape.
* @see {@link GetTrafficPolicyCommandOutput} 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 NoSuchTrafficPolicy} (client fault)
* <p>No traffic policy exists with the specified ID.</p>
*
* @throws {@link Route53ServiceException}
* <p>Base exception class for all service exceptions from Route53 service.</p>
*
* @public
*/
export declare class GetTrafficPolicyCommand extends GetTrafficPolicyCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: GetTrafficPolicyRequest;
output: GetTrafficPolicyResponse;
};
sdk: {
input: GetTrafficPolicyCommandInput;
output: GetTrafficPolicyCommandOutput;
};
};
}