@aws-sdk/client-route-53
Version:
AWS SDK for JavaScript Route 53 Client for Node.js, Browser and React Native
102 lines (101 loc) • 3.88 kB
TypeScript
import { Command as $Command } from "@smithy/core/client";
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { GetChangeRequest, GetChangeResponse } from "../models/models_0";
import type { Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Route53Client";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link GetChangeCommand}.
*/
export interface GetChangeCommandInput extends GetChangeRequest {
}
/**
* @public
*
* The output of {@link GetChangeCommand}.
*/
export interface GetChangeCommandOutput extends GetChangeResponse, __MetadataBearer {
}
declare const GetChangeCommand_base: {
new (input: GetChangeCommandInput): import("@smithy/core/client").CommandImpl<GetChangeCommandInput, GetChangeCommandOutput, Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (input: GetChangeCommandInput): import("@smithy/core/client").CommandImpl<GetChangeCommandInput, GetChangeCommandOutput, Route53ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): {
[x: string]: unknown;
};
};
/**
* <p>Returns the current status of a change batch request. The status is one of the
* following values:</p>
* <ul>
* <li>
* <p>
* <code>PENDING</code> indicates that the changes in this request have not
* propagated to all Amazon Route 53 DNS servers managing the hosted zone. This is the initial status of all
* change batch requests.</p>
* </li>
* <li>
* <p>
* <code>INSYNC</code> indicates that the changes have propagated to all Route 53
* DNS servers managing the hosted zone. </p>
* </li>
* </ul>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { Route53Client, GetChangeCommand } from "@aws-sdk/client-route-53"; // ES Modules import
* // const { Route53Client, GetChangeCommand } = 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 = { // GetChangeRequest
* Id: "STRING_VALUE", // required
* };
* const command = new GetChangeCommand(input);
* const response = await client.send(command);
* // { // GetChangeResponse
* // ChangeInfo: { // ChangeInfo
* // Id: "STRING_VALUE", // required
* // Status: "PENDING" || "INSYNC", // required
* // SubmittedAt: new Date("TIMESTAMP"), // required
* // Comment: "STRING_VALUE",
* // },
* // };
*
* ```
*
* @param GetChangeCommandInput - {@link GetChangeCommandInput}
* @returns {@link GetChangeCommandOutput}
* @see {@link GetChangeCommandInput} for command's `input` shape.
* @see {@link GetChangeCommandOutput} 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 NoSuchChange} (client fault)
* <p>A change with the specified change ID does not exist.</p>
*
* @throws {@link Route53ServiceException}
* <p>Base exception class for all service exceptions from Route53 service.</p>
*
*
* @public
*/
export declare class GetChangeCommand extends GetChangeCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: GetChangeRequest;
output: GetChangeResponse;
};
sdk: {
input: GetChangeCommandInput;
output: GetChangeCommandOutput;
};
};
}