BatchStartRecommendationsCommand

Suggest an Edit

Starts the analysis of up to 20 source databases to recommend target engines for each source database. This is a batch version of StartRecommendations .

The result of analysis of each source database is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DatabaseMigrationServiceClient, BatchStartRecommendationsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import
// const { DatabaseMigrationServiceClient, BatchStartRecommendationsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import
const client = new DatabaseMigrationServiceClient(config);
const input = { // BatchStartRecommendationsRequest
  Data: [ // StartRecommendationsRequestEntryList
    { // StartRecommendationsRequestEntry
      DatabaseId: "STRING_VALUE", // required
      Settings: { // RecommendationSettings
        InstanceSizingType: "STRING_VALUE", // required
        WorkloadType: "STRING_VALUE", // required
      },
    },
  ],
};
const command = new BatchStartRecommendationsCommand(input);
const response = await client.send(command);
// { // BatchStartRecommendationsResponse
//   ErrorEntries: [ // BatchStartRecommendationsErrorEntryList
//     { // BatchStartRecommendationsErrorEntry
//       DatabaseId: "STRING_VALUE",
//       Message: "STRING_VALUE",
//       Code: "STRING_VALUE",
//     },
//   ],
// };

BatchStartRecommendationsCommand Input

See BatchStartRecommendationsCommandInput for more details

Parameter
Type
Description
Data
StartRecommendationsRequestEntry[] | undefined

Provides information about source databases to analyze. After this analysis, Fleet Advisor recommends target engines for each source database.

BatchStartRecommendationsCommand Output

See BatchStartRecommendationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ErrorEntries
BatchStartRecommendationsErrorEntry[] | undefined

A list with error details about the analysis of each source database.

Throws

Name
Fault
Details
AccessDeniedFault
client

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

InvalidResourceStateFault
client

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

ResourceNotFoundFault
client

The resource could not be found.

DatabaseMigrationServiceServiceException
Base exception class for all service exceptions from DatabaseMigrationService service.