import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeSourceRegionsMessage } from "../models/models_0"; import type { SourceRegionMessage } from "../models/models_1"; import type { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeSourceRegionsCommand}. */ export interface DescribeSourceRegionsCommandInput extends DescribeSourceRegionsMessage { } /** * @public * * The output of {@link DescribeSourceRegionsCommand}. */ export interface DescribeSourceRegionsCommandOutput extends SourceRegionMessage, __MetadataBearer { } declare const DescribeSourceRegionsCommand_base: { new (input: DescribeSourceRegionsCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeSourceRegionsCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.

Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.

To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions. For more information, see DescribeRegions in the Amazon EC2 API Reference.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { RDSClient, DescribeSourceRegionsCommand } from "@aws-sdk/client-rds"; // ES Modules import * // const { RDSClient, DescribeSourceRegionsCommand } = require("@aws-sdk/client-rds"); // CommonJS import * // import type { RDSClientConfig } from "@aws-sdk/client-rds"; * const config = {}; // type is RDSClientConfig * const client = new RDSClient(config); * const input = { // DescribeSourceRegionsMessage * RegionName: "STRING_VALUE", * MaxRecords: Number("int"), * Marker: "STRING_VALUE", * Filters: [ // FilterList * { // Filter * Name: "STRING_VALUE", // required * Values: [ // FilterValueList // required * "STRING_VALUE", * ], * }, * ], * }; * const command = new DescribeSourceRegionsCommand(input); * const response = await client.send(command); * // { // SourceRegionMessage * // Marker: "STRING_VALUE", * // SourceRegions: [ // SourceRegionList * // { // SourceRegion * // RegionName: "STRING_VALUE", * // Endpoint: "STRING_VALUE", * // Status: "STRING_VALUE", * // SupportsDBInstanceAutomatedBackupsReplication: true || false, * // }, * // ], * // }; * * ``` * * @param DescribeSourceRegionsCommandInput - {@link DescribeSourceRegionsCommandInput} * @returns {@link DescribeSourceRegionsCommandOutput} * @see {@link DescribeSourceRegionsCommandInput} for command's `input` shape. * @see {@link DescribeSourceRegionsCommandOutput} for command's `response` shape. * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape. * * @throws {@link RDSServiceException} *

Base exception class for all service exceptions from RDS service.

* * * @example To describe source Regions * ```javascript * // The following example retrieves details about all source AWS Regions where the current AWS Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. It also shows that automated backups can be replicated only from US West (Oregon) to the destination AWS Region, US East (N. Virginia). * const input = { * RegionName: "us-east-1" * }; * const command = new DescribeSourceRegionsCommand(input); * const response = await client.send(command); * /* response is * { * SourceRegions: [ * { * Endpoint: "https://rds.af-south-1.amazonaws.com", * RegionName: "af-south-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: false * }, * { * Endpoint: "https://rds.ap-east-1.amazonaws.com", * RegionName: "ap-east-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: false * }, * { * Endpoint: "https://rds.ap-northeast-1.amazonaws.com", * RegionName: "ap-northeast-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.ap-northeast-2.amazonaws.com", * RegionName: "ap-northeast-2", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.ap-northeast-3.amazonaws.com", * RegionName: "ap-northeast-3", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: false * }, * { * Endpoint: "https://rds.ap-south-1.amazonaws.com", * RegionName: "ap-south-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.ap-southeast-1.amazonaws.com", * RegionName: "ap-southeast-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.ap-southeast-2.amazonaws.com", * RegionName: "ap-southeast-2", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.ap-southeast-3.amazonaws.com", * RegionName: "ap-southeast-3", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: false * }, * { * Endpoint: "https://rds.ca-central-1.amazonaws.com", * RegionName: "ca-central-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.eu-north-1.amazonaws.com", * RegionName: "eu-north-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.eu-south-1.amazonaws.com", * RegionName: "eu-south-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: false * }, * { * Endpoint: "https://rds.eu-west-1.amazonaws.com", * RegionName: "eu-west-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.eu-west-2.amazonaws.com", * RegionName: "eu-west-2", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.eu-west-3.amazonaws.com", * RegionName: "eu-west-3", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.me-central-1.amazonaws.com", * RegionName: "me-central-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: false * }, * { * Endpoint: "https://rds.me-south-1.amazonaws.com", * RegionName: "me-south-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: false * }, * { * Endpoint: "https://rds.sa-east-1.amazonaws.com", * RegionName: "sa-east-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.us-east-2.amazonaws.com", * RegionName: "us-east-2", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.us-west-1.amazonaws.com", * RegionName: "us-west-1", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * }, * { * Endpoint: "https://rds.us-west-2.amazonaws.com", * RegionName: "us-west-2", * Status: "available", * SupportsDBInstanceAutomatedBackupsReplication: true * } * ] * } * *\/ * ``` * * @public */ export declare class DescribeSourceRegionsCommand extends DescribeSourceRegionsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeSourceRegionsMessage; output: SourceRegionMessage; }; sdk: { input: DescribeSourceRegionsCommandInput; output: DescribeSourceRegionsCommandOutput; }; }; }