JSPM

@aws-sdk/client-database-migration-service

3.887.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 135179
  • Score
    100M100P100Q188013F
  • License Apache-2.0

AWS SDK for JavaScript Database Migration Service Client for Node.js, Browser and React Native

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aws-sdk/client-database-migration-service) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    @aws-sdk/client-database-migration-service

    Description

    AWS SDK for JavaScript DatabaseMigrationService Client for Node.js, Browser and React Native.

    Database Migration Service

    Database Migration Service (DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.

    For more information about DMS, see What Is Database Migration Service? in the Database Migration Service User Guide.

    Installing

    To install this package, simply type add or install @aws-sdk/client-database-migration-service using your favorite package manager:

    • npm install @aws-sdk/client-database-migration-service
    • yarn add @aws-sdk/client-database-migration-service
    • pnpm add @aws-sdk/client-database-migration-service

    Getting Started

    Import

    The AWS SDK is modulized by clients and commands. To send a request, you only need to import the DatabaseMigrationServiceClient and the commands you need, for example ListTagsForResourceCommand:

    // ES5 example
    const {
      DatabaseMigrationServiceClient,
      ListTagsForResourceCommand,
    } = require("@aws-sdk/client-database-migration-service");
    // ES6+ example
    import { DatabaseMigrationServiceClient, ListTagsForResourceCommand } from "@aws-sdk/client-database-migration-service";

    Usage

    To send a request, you:

    • Initiate client with configuration (e.g. credentials, region).
    • Initiate command with input parameters.
    • Call send operation on client with command object as input.
    • If you are using a custom http handler, you may call destroy() to close open connections.
    // a client can be shared by different commands.
    const client = new DatabaseMigrationServiceClient({ region: "REGION" });
    
    const params = {
      /** input parameters */
    };
    const command = new ListTagsForResourceCommand(params);

    Async/await

    We recommend using await operator to wait for the promise returned by send operation as follows:

    // async/await.
    try {
      const data = await client.send(command);
      // process data.
    } catch (error) {
      // error handling.
    } finally {
      // finally.
    }

    Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

    Promises

    You can also use Promise chaining to execute send operation.

    client.send(command).then(
      (data) => {
        // process data.
      },
      (error) => {
        // error handling.
      }
    );

    Promises can also be called using .catch() and .finally() as follows:

    client
      .send(command)
      .then((data) => {
        // process data.
      })
      .catch((error) => {
        // error handling.
      })
      .finally(() => {
        // finally.
      });

    Callbacks

    We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

    // callbacks.
    client.send(command, (err, data) => {
      // process err and data.
    });

    v2 compatible style

    The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

    import * as AWS from "@aws-sdk/client-database-migration-service";
    const client = new AWS.DatabaseMigrationService({ region: "REGION" });
    
    // async/await.
    try {
      const data = await client.listTagsForResource(params);
      // process data.
    } catch (error) {
      // error handling.
    }
    
    // Promises.
    client
      .listTagsForResource(params)
      .then((data) => {
        // process data.
      })
      .catch((error) => {
        // error handling.
      });
    
    // callbacks.
    client.listTagsForResource(params, (err, data) => {
      // process err and data.
    });

    Troubleshooting

    When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

    try {
      const data = await client.send(command);
      // process data.
    } catch (error) {
      const { requestId, cfId, extendedRequestId } = error.$metadata;
      console.log({ requestId, cfId, extendedRequestId });
      /**
       * The keys within exceptions are also parsed.
       * You can access them by specifying exception names:
       * if (error.name === 'SomeServiceException') {
       *     const value = error.specialKeyInException;
       * }
       */
    }

    Getting Help

    Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

    To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

    Contributing

    This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-database-migration-service package is updated. To contribute to client you can check our generate clients scripts.

    License

    This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

    Client Commands (Operations List)

    AddTagsToResource

    Command API Reference / Input / Output

    ApplyPendingMaintenanceAction

    Command API Reference / Input / Output

    BatchStartRecommendations

    Command API Reference / Input / Output

    CancelReplicationTaskAssessmentRun

    Command API Reference / Input / Output

    CreateDataMigration

    Command API Reference / Input / Output

    CreateDataProvider

    Command API Reference / Input / Output

    CreateEndpoint

    Command API Reference / Input / Output

    CreateEventSubscription

    Command API Reference / Input / Output

    CreateFleetAdvisorCollector

    Command API Reference / Input / Output

    CreateInstanceProfile

    Command API Reference / Input / Output

    CreateMigrationProject

    Command API Reference / Input / Output

    CreateReplicationConfig

    Command API Reference / Input / Output

    CreateReplicationInstance

    Command API Reference / Input / Output

    CreateReplicationSubnetGroup

    Command API Reference / Input / Output

    CreateReplicationTask

    Command API Reference / Input / Output

    DeleteCertificate

    Command API Reference / Input / Output

    DeleteConnection

    Command API Reference / Input / Output

    DeleteDataMigration

    Command API Reference / Input / Output

    DeleteDataProvider

    Command API Reference / Input / Output

    DeleteEndpoint

    Command API Reference / Input / Output

    DeleteEventSubscription

    Command API Reference / Input / Output

    DeleteFleetAdvisorCollector

    Command API Reference / Input / Output

    DeleteFleetAdvisorDatabases

    Command API Reference / Input / Output

    DeleteInstanceProfile

    Command API Reference / Input / Output

    DeleteMigrationProject

    Command API Reference / Input / Output

    DeleteReplicationConfig

    Command API Reference / Input / Output

    DeleteReplicationInstance

    Command API Reference / Input / Output

    DeleteReplicationSubnetGroup

    Command API Reference / Input / Output

    DeleteReplicationTask

    Command API Reference / Input / Output

    DeleteReplicationTaskAssessmentRun

    Command API Reference / Input / Output

    DescribeAccountAttributes

    Command API Reference / Input / Output

    DescribeApplicableIndividualAssessments

    Command API Reference / Input / Output

    DescribeCertificates

    Command API Reference / Input / Output

    DescribeConnections

    Command API Reference / Input / Output

    DescribeConversionConfiguration

    Command API Reference / Input / Output

    DescribeDataMigrations

    Command API Reference / Input / Output

    DescribeDataProviders

    Command API Reference / Input / Output

    DescribeEndpoints

    Command API Reference / Input / Output

    DescribeEndpointSettings

    Command API Reference / Input / Output

    DescribeEndpointTypes

    Command API Reference / Input / Output

    DescribeEngineVersions

    Command API Reference / Input / Output

    DescribeEventCategories

    Command API Reference / Input / Output

    DescribeEvents

    Command API Reference / Input / Output

    DescribeEventSubscriptions

    Command API Reference / Input / Output

    DescribeExtensionPackAssociations

    Command API Reference / Input / Output

    DescribeFleetAdvisorCollectors

    Command API Reference / Input / Output

    DescribeFleetAdvisorDatabases

    Command API Reference / Input / Output

    DescribeFleetAdvisorLsaAnalysis

    Command API Reference / Input / Output

    DescribeFleetAdvisorSchemaObjectSummary

    Command API Reference / Input / Output

    DescribeFleetAdvisorSchemas

    Command API Reference / Input / Output

    DescribeInstanceProfiles

    Command API Reference / Input / Output

    DescribeMetadataModelAssessments

    Command API Reference / Input / Output

    DescribeMetadataModelConversions

    Command API Reference / Input / Output

    DescribeMetadataModelExportsAsScript

    Command API Reference / Input / Output

    DescribeMetadataModelExportsToTarget

    Command API Reference / Input / Output

    DescribeMetadataModelImports

    Command API Reference / Input / Output

    DescribeMigrationProjects

    Command API Reference / Input / Output

    DescribeOrderableReplicationInstances

    Command API Reference / Input / Output

    DescribePendingMaintenanceActions

    Command API Reference / Input / Output

    DescribeRecommendationLimitations

    Command API Reference / Input / Output

    DescribeRecommendations

    Command API Reference / Input / Output

    DescribeRefreshSchemasStatus

    Command API Reference / Input / Output

    DescribeReplicationConfigs

    Command API Reference / Input / Output

    DescribeReplicationInstances

    Command API Reference / Input / Output

    DescribeReplicationInstanceTaskLogs

    Command API Reference / Input / Output

    DescribeReplications

    Command API Reference / Input / Output

    DescribeReplicationSubnetGroups

    Command API Reference / Input / Output

    DescribeReplicationTableStatistics

    Command API Reference / Input / Output

    DescribeReplicationTaskAssessmentResults

    Command API Reference / Input / Output

    DescribeReplicationTaskAssessmentRuns

    Command API Reference / Input / Output

    DescribeReplicationTaskIndividualAssessments

    Command API Reference / Input / Output

    DescribeReplicationTasks

    Command API Reference / Input / Output

    DescribeSchemas

    Command API Reference / Input / Output

    DescribeTableStatistics

    Command API Reference / Input / Output

    ExportMetadataModelAssessment

    Command API Reference / Input / Output

    ImportCertificate

    Command API Reference / Input / Output

    ListTagsForResource

    Command API Reference / Input / Output

    ModifyConversionConfiguration

    Command API Reference / Input / Output

    ModifyDataMigration

    Command API Reference / Input / Output

    ModifyDataProvider

    Command API Reference / Input / Output

    ModifyEndpoint

    Command API Reference / Input / Output

    ModifyEventSubscription

    Command API Reference / Input / Output

    ModifyInstanceProfile

    Command API Reference / Input / Output

    ModifyMigrationProject

    Command API Reference / Input / Output

    ModifyReplicationConfig

    Command API Reference / Input / Output

    ModifyReplicationInstance

    Command API Reference / Input / Output

    ModifyReplicationSubnetGroup

    Command API Reference / Input / Output

    ModifyReplicationTask

    Command API Reference / Input / Output

    MoveReplicationTask

    Command API Reference / Input / Output

    RebootReplicationInstance

    Command API Reference / Input / Output

    RefreshSchemas

    Command API Reference / Input / Output

    ReloadReplicationTables

    Command API Reference / Input / Output

    ReloadTables

    Command API Reference / Input / Output

    RemoveTagsFromResource

    Command API Reference / Input / Output

    RunFleetAdvisorLsaAnalysis

    Command API Reference / Input / Output

    StartDataMigration

    Command API Reference / Input / Output

    StartExtensionPackAssociation

    Command API Reference / Input / Output

    StartMetadataModelAssessment

    Command API Reference / Input / Output

    StartMetadataModelConversion

    Command API Reference / Input / Output

    StartMetadataModelExportAsScript

    Command API Reference / Input / Output

    StartMetadataModelExportToTarget

    Command API Reference / Input / Output

    StartMetadataModelImport

    Command API Reference / Input / Output

    StartRecommendations

    Command API Reference / Input / Output

    StartReplication

    Command API Reference / Input / Output

    StartReplicationTask

    Command API Reference / Input / Output

    StartReplicationTaskAssessment

    Command API Reference / Input / Output

    StartReplicationTaskAssessmentRun

    Command API Reference / Input / Output

    StopDataMigration

    Command API Reference / Input / Output

    StopReplication

    Command API Reference / Input / Output

    StopReplicationTask

    Command API Reference / Input / Output

    TestConnection

    Command API Reference / Input / Output

    UpdateSubscriptionsToEventBridge

    Command API Reference / Input / Output