Request Syntax Request Parameters Response Elements Errors Examples See Also

GenerateRecommendations

Creates recommendations about where to migrate your data to in AWS. 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.

Request Syntax


{
   "DiscoveryJobArn": "string",
   "ResourceIds": [ "string" ],
   "ResourceType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DiscoveryJobArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

ResourceIds

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

ResourceType

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

Type: String

Valid Values: SVM | VOLUME | CLUSTER

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

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

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

Examples

Sample Request

The following example generates AWS storage recommendations for a volume in an on-premises storage system.


{
    "DiscoveryJobArn": "arn:aws:datasync:us-east-1:123456789012:system/storage-system-abcdef01234567890/job/discovery-job-12345678-90ab-cdef-0abc-021345abcdef6",
    "ResourceIds": [
        "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
    ],
    "ResourceType": "VOLUME"
}