import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DatabaseMigrationServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DatabaseMigrationServiceClient"; import type { TestConnectionMessage, TestConnectionResponse } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link TestConnectionCommand}. */ export interface TestConnectionCommandInput extends TestConnectionMessage { } /** * @public * * The output of {@link TestConnectionCommand}. */ export interface TestConnectionCommandOutput extends TestConnectionResponse, __MetadataBearer { } declare const TestConnectionCommand_base: { new (input: TestConnectionCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: TestConnectionCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Tests the connection between the replication instance and the endpoint.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DatabaseMigrationServiceClient, TestConnectionCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import * // const { DatabaseMigrationServiceClient, TestConnectionCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import * // import type { DatabaseMigrationServiceClientConfig } from "@aws-sdk/client-database-migration-service"; * const config = {}; // type is DatabaseMigrationServiceClientConfig * const client = new DatabaseMigrationServiceClient(config); * const input = { // TestConnectionMessage * ReplicationInstanceArn: "STRING_VALUE", // required * EndpointArn: "STRING_VALUE", // required * }; * const command = new TestConnectionCommand(input); * const response = await client.send(command); * // { // TestConnectionResponse * // Connection: { // Connection * // ReplicationInstanceArn: "STRING_VALUE", * // EndpointArn: "STRING_VALUE", * // Status: "STRING_VALUE", * // LastFailureMessage: "STRING_VALUE", * // EndpointIdentifier: "STRING_VALUE", * // ReplicationInstanceIdentifier: "STRING_VALUE", * // }, * // }; * * ``` * * @param TestConnectionCommandInput - {@link TestConnectionCommandInput} * @returns {@link TestConnectionCommandOutput} * @see {@link TestConnectionCommandInput} for command's `input` shape. * @see {@link TestConnectionCommandOutput} for command's `response` shape. * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape. * * @throws {@link AccessDeniedFault} (client fault) *

DMS was denied access to the endpoint. Check that the * role is correctly configured.

* * @throws {@link InvalidResourceStateFault} (client fault) *

The resource is in a state that prevents it from being used for database migration.

* * @throws {@link KMSKeyNotAccessibleFault} (client fault) *

DMS cannot access the KMS key.

* * @throws {@link ResourceNotFoundFault} (client fault) *

The resource could not be found.

* * @throws {@link ResourceQuotaExceededFault} (client fault) *

The quota for this resource quota has been exceeded.

* * @throws {@link DatabaseMigrationServiceServiceException} *

Base exception class for all service exceptions from DatabaseMigrationService service.

* * * @example Test conection * ```javascript * // Tests the connection between the replication instance and the endpoint. * const input = { * EndpointArn: "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", * ReplicationInstanceArn: "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" * }; * const command = new TestConnectionCommand(input); * const response = await client.send(command); * /* response is * { * Connection: { /* empty *\/ } * } * *\/ * ``` * * @public */ export declare class TestConnectionCommand extends TestConnectionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: TestConnectionMessage; output: TestConnectionResponse; }; sdk: { input: TestConnectionCommandInput; output: TestConnectionCommandOutput; }; }; }