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 { DescribeDataProvidersMessage, DescribeDataProvidersResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeDataProvidersCommand}. */ export interface DescribeDataProvidersCommandInput extends DescribeDataProvidersMessage { } /** * @public * * The output of {@link DescribeDataProvidersCommand}. */ export interface DescribeDataProvidersCommandOutput extends DescribeDataProvidersResponse, __MetadataBearer { } declare const DescribeDataProvidersCommand_base: { new (input: DescribeDataProvidersCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [DescribeDataProvidersCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Returns a paginated list of data providers for your account in the current * region.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DatabaseMigrationServiceClient, DescribeDataProvidersCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import * // const { DatabaseMigrationServiceClient, DescribeDataProvidersCommand } = 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 = { // DescribeDataProvidersMessage * Filters: [ // FilterList * { // Filter * Name: "STRING_VALUE", // required * Values: [ // FilterValueList // required * "STRING_VALUE", * ], * }, * ], * MaxRecords: Number("int"), * Marker: "STRING_VALUE", * }; * const command = new DescribeDataProvidersCommand(input); * const response = await client.send(command); * // { // DescribeDataProvidersResponse * // Marker: "STRING_VALUE", * // DataProviders: [ // DataProviderList * // { // DataProvider * // DataProviderName: "STRING_VALUE", * // DataProviderArn: "STRING_VALUE", * // DataProviderCreationTime: new Date("TIMESTAMP"), * // Description: "STRING_VALUE", * // Engine: "STRING_VALUE", * // Virtual: true || false, * // Settings: { // DataProviderSettings Union: only one key present * // RedshiftSettings: { // RedshiftDataProviderSettings * // ServerName: "STRING_VALUE", * // Port: Number("int"), * // DatabaseName: "STRING_VALUE", * // S3Path: "STRING_VALUE", * // S3AccessRoleArn: "STRING_VALUE", * // }, * // PostgreSqlSettings: { // PostgreSqlDataProviderSettings * // ServerName: "STRING_VALUE", * // Port: Number("int"), * // DatabaseName: "STRING_VALUE", * // SslMode: "none" || "require" || "verify-ca" || "verify-full", * // CertificateArn: "STRING_VALUE", * // S3Path: "STRING_VALUE", * // S3AccessRoleArn: "STRING_VALUE", * // }, * // MySqlSettings: { // MySqlDataProviderSettings * // ServerName: "STRING_VALUE", * // Port: Number("int"), * // SslMode: "none" || "require" || "verify-ca" || "verify-full", * // CertificateArn: "STRING_VALUE", * // S3Path: "STRING_VALUE", * // S3AccessRoleArn: "STRING_VALUE", * // }, * // OracleSettings: { // OracleDataProviderSettings * // ServerName: "STRING_VALUE", * // Port: Number("int"), * // DatabaseName: "STRING_VALUE", * // SslMode: "none" || "require" || "verify-ca" || "verify-full", * // CertificateArn: "STRING_VALUE", * // AsmServer: "STRING_VALUE", * // SecretsManagerOracleAsmSecretId: "STRING_VALUE", * // SecretsManagerOracleAsmAccessRoleArn: "STRING_VALUE", * // SecretsManagerSecurityDbEncryptionSecretId: "STRING_VALUE", * // SecretsManagerSecurityDbEncryptionAccessRoleArn: "STRING_VALUE", * // S3Path: "STRING_VALUE", * // S3AccessRoleArn: "STRING_VALUE", * // }, * // SybaseAseSettings: { // SybaseAseDataProviderSettings * // ServerName: "STRING_VALUE", * // Port: Number("int"), * // DatabaseName: "STRING_VALUE", * // SslMode: "none" || "require" || "verify-ca" || "verify-full", * // EncryptPassword: true || false, * // CertificateArn: "STRING_VALUE", * // }, * // MicrosoftSqlServerSettings: { // MicrosoftSqlServerDataProviderSettings * // ServerName: "STRING_VALUE", * // Port: Number("int"), * // DatabaseName: "STRING_VALUE", * // SslMode: "none" || "require" || "verify-ca" || "verify-full", * // CertificateArn: "STRING_VALUE", * // S3Path: "STRING_VALUE", * // S3AccessRoleArn: "STRING_VALUE", * // }, * // DocDbSettings: { // DocDbDataProviderSettings * // ServerName: "STRING_VALUE", * // Port: Number("int"), * // DatabaseName: "STRING_VALUE", * // SslMode: "none" || "require" || "verify-ca" || "verify-full", * // CertificateArn: "STRING_VALUE", * // }, * // MariaDbSettings: { // MariaDbDataProviderSettings * // ServerName: "STRING_VALUE", * // Port: Number("int"), * // SslMode: "none" || "require" || "verify-ca" || "verify-full", * // CertificateArn: "STRING_VALUE", * // S3Path: "STRING_VALUE", * // S3AccessRoleArn: "STRING_VALUE", * // }, * // IbmDb2LuwSettings: { // IbmDb2LuwDataProviderSettings * // ServerName: "STRING_VALUE", * // Port: Number("int"), * // DatabaseName: "STRING_VALUE", * // SslMode: "none" || "require" || "verify-ca" || "verify-full", * // CertificateArn: "STRING_VALUE", * // EncryptionAlgorithm: Number("int"), * // SecurityMechanism: Number("int"), * // S3Path: "STRING_VALUE", * // S3AccessRoleArn: "STRING_VALUE", * // }, * // IbmDb2zOsSettings: { // IbmDb2zOsDataProviderSettings * // ServerName: "STRING_VALUE", * // Port: Number("int"), * // DatabaseName: "STRING_VALUE", * // SslMode: "none" || "require" || "verify-ca" || "verify-full", * // CertificateArn: "STRING_VALUE", * // S3Path: "STRING_VALUE", * // S3AccessRoleArn: "STRING_VALUE", * // }, * // MongoDbSettings: { // MongoDbDataProviderSettings * // ServerName: "STRING_VALUE", * // Port: Number("int"), * // DatabaseName: "STRING_VALUE", * // SslMode: "none" || "require" || "verify-ca" || "verify-full", * // CertificateArn: "STRING_VALUE", * // AuthType: "no" || "password", * // AuthSource: "STRING_VALUE", * // AuthMechanism: "default" || "mongodb_cr" || "scram_sha_1", * // }, * // }, * // }, * // ], * // }; * * ``` * * @param DescribeDataProvidersCommandInput - {@link DescribeDataProvidersCommandInput} * @returns {@link DescribeDataProvidersCommandOutput} * @see {@link DescribeDataProvidersCommandInput} for command's `input` shape. * @see {@link DescribeDataProvidersCommandOutput} 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 FailedDependencyFault} (client fault) *

A dependency threw an exception.

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

The resource could not be found.

* * @throws {@link DatabaseMigrationServiceServiceException} *

Base exception class for all service exceptions from DatabaseMigrationService service.

* * * @example Describe Data Providers * ```javascript * // * const input = { * Filters: [ * { * Name: "data-provider-identifier", * Values: [ * "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345" * ] * } * ], * Marker: "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345", * MaxRecords: 20 * }; * const command = new DescribeDataProvidersCommand(input); * const response = await client.send(command); * /* response is * { * DataProviders: [ * { * DataProviderArn: "arn:aws:dms:us-east-1:012345678901:data-provider:my-target-data-provider", * DataProviderCreationTime: "2023-05-12T10:50:41.988561Z", * DataProviderName: "my-target-data-provider", * Engine: "postgres", * Settings: { * PostgreSqlSettings: { * DatabaseName: "target", * Port: 5432, * ServerName: "postrgesql.0a1b2c3d4e5f.us-east-1.rds.amazonaws.com", * SslMode: "none" * } * } * } * ], * Marker: "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345" * } * *\/ * ``` * * @public */ export declare class DescribeDataProvidersCommand extends DescribeDataProvidersCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeDataProvidersMessage; output: DescribeDataProvidersResponse; }; sdk: { input: DescribeDataProvidersCommandInput; output: DescribeDataProvidersCommandOutput; }; }; }