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

Returns a paginated list of migration projects 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, DescribeMigrationProjectsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import * // const { DatabaseMigrationServiceClient, DescribeMigrationProjectsCommand } = 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 = { // DescribeMigrationProjectsMessage * Filters: [ // FilterList * { // Filter * Name: "STRING_VALUE", // required * Values: [ // FilterValueList // required * "STRING_VALUE", * ], * }, * ], * MaxRecords: Number("int"), * Marker: "STRING_VALUE", * }; * const command = new DescribeMigrationProjectsCommand(input); * const response = await client.send(command); * // { // DescribeMigrationProjectsResponse * // Marker: "STRING_VALUE", * // MigrationProjects: [ // MigrationProjectList * // { // MigrationProject * // MigrationProjectName: "STRING_VALUE", * // MigrationProjectArn: "STRING_VALUE", * // MigrationProjectCreationTime: new Date("TIMESTAMP"), * // SourceDataProviderDescriptors: [ // DataProviderDescriptorList * // { // DataProviderDescriptor * // SecretsManagerSecretId: "STRING_VALUE", * // SecretsManagerAccessRoleArn: "STRING_VALUE", * // DataProviderName: "STRING_VALUE", * // DataProviderArn: "STRING_VALUE", * // }, * // ], * // TargetDataProviderDescriptors: [ * // { * // SecretsManagerSecretId: "STRING_VALUE", * // SecretsManagerAccessRoleArn: "STRING_VALUE", * // DataProviderName: "STRING_VALUE", * // DataProviderArn: "STRING_VALUE", * // }, * // ], * // InstanceProfileArn: "STRING_VALUE", * // InstanceProfileName: "STRING_VALUE", * // TransformationRules: "STRING_VALUE", * // Description: "STRING_VALUE", * // SchemaConversionApplicationAttributes: { // SCApplicationAttributes * // S3BucketPath: "STRING_VALUE", * // S3BucketRoleArn: "STRING_VALUE", * // }, * // }, * // ], * // }; * * ``` * * @param DescribeMigrationProjectsCommandInput - {@link DescribeMigrationProjectsCommandInput} * @returns {@link DescribeMigrationProjectsCommandOutput} * @see {@link DescribeMigrationProjectsCommandInput} for command's `input` shape. * @see {@link DescribeMigrationProjectsCommandOutput} 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 Migration Projects * ```javascript * // Returns a paginated list of migration projects for your account in the current region. * const input = { * Filters: [ * { * Name: "migration-project-identifier", * Values: [ * "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ12345678901" * ] * } * ], * Marker: "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ123456", * MaxRecords: 20 * }; * const command = new DescribeMigrationProjectsCommand(input); * const response = await client.send(command); * /* response is * { * Marker: "0123456789abcdefghijklmnopqrs", * MigrationProjects: [ * { * InstanceProfileArn: "arn:aws:dms:us-east-1:012345678901:instance-profile:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", * InstanceProfileName: "my-instance-profile", * MigrationProjectArn: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", * MigrationProjectCreationTime: "2023-04-19T11:45:15.805253Z", * MigrationProjectName: "my-migration-project", * SchemaConversionApplicationAttributes: { * S3BucketPath: "my-s3-bucket/my_folder", * S3BucketRoleArn: "arn:aws:iam::012345678901:role/my-s3role" * }, * SourceDataProviderDescriptors: [ * { * DataProviderArn: "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", * DataProviderName: "all-source-oracle-12", * SecretsManagerAccessRoleArn: "arn:aws:iam::012345678901:role/my-access-role", * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:012345678901:secret:mygroup/myalias/ALL.SOURCE.ORACLE_12-012345" * } * ], * TargetDataProviderDescriptors: [ * { * DataProviderArn: "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", * DataProviderName: "my-data-provider", * SecretsManagerAccessRoleArn: "arn:aws:iam::012345678901:role/dmytbon-admin-access", * SecretsManagerSecretId: "arn:aws:secretsmanager:us-east-1:012345678901:secret:mygroup/myalias/TARGET.postgresql-012345" * } * ] * } * ] * } * *\/ * ``` * * @public */ export declare class DescribeMigrationProjectsCommand extends DescribeMigrationProjectsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeMigrationProjectsMessage; output: DescribeMigrationProjectsResponse; }; sdk: { input: DescribeMigrationProjectsCommandInput; output: DescribeMigrationProjectsCommandOutput; }; }; }