GenerateRecommendationsCommand

Suggest an Edit

Creates recommendations about where to migrate your data to in Amazon Web Services. Recommendations are generated based on information that DataSync Discovery collects about your on-premises storage system's resources. For more information, see Recommendations provided by DataSync Discovery .

Once generated, you can view your recommendations by using the DescribeStorageSystemResources  operation.

Example Syntax

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

import { DataSyncClient, GenerateRecommendationsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, GenerateRecommendationsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // GenerateRecommendationsRequest
  DiscoveryJobArn: "STRING_VALUE", // required
  ResourceIds: [ // ResourceIds // required
    "STRING_VALUE",
  ],
  ResourceType: "SVM" || "VOLUME" || "CLUSTER", // required
};
const command = new GenerateRecommendationsCommand(input);
const response = await client.send(command);
// {};

GenerateRecommendationsCommand Input

See GenerateRecommendationsCommandInput for more details

Parameter
Type
Description
DiscoveryJobArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.

ResourceIds
Required
string[] | undefined

Specifies the universally unique identifiers (UUIDs) of the resources in your storage system that you want recommendations on.

ResourceType
Required
DiscoveryResourceType | undefined

Specifies the type of resource in your storage system that you want recommendations on.

GenerateRecommendationsCommand Output

See GenerateRecommendationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InternalException
server

This exception is thrown when an error occurs in the DataSync service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

DataSyncServiceException
Base exception class for all service exceptions from DataSync service.