DescribeRecommendations
Returns a paginated list of target engine recommendations for your source databases.
Request Syntax
{
"Filters": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"MaxRecords": number,
"NextToken": "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.
- Filters
-
Filters applied to the target engine recommendations described in the form of key-value pairs.
Type: Array of Filter objects
Required: No
- MaxRecords
-
The maximum number of records to include in the response. If more records exist than the specified
MaxRecordsvalue, Fleet Advisor includes a pagination token in the response so that you can retrieve the remaining results.Type: Integer
Required: No
- NextToken
-
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.If
NextTokenis returned by a previous response, there are more results available. The value ofNextTokenis a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.Type: String
Required: No
Response Syntax
{
"NextToken": "string",
"Recommendations": [
{
"CreatedDate": "string",
"Data": {
"RdsEngine": {
"RequirementsToTarget": {
"DeploymentOption": "string",
"EngineEdition": "string",
"EngineVersion": "string",
"InstanceMemory": number,
"InstanceVcpu": number,
"StorageIops": number,
"StorageSize": number
},
"TargetConfiguration": {
"DeploymentOption": "string",
"EngineEdition": "string",
"EngineVersion": "string",
"InstanceMemory": number,
"InstanceType": "string",
"InstanceVcpu": number,
"StorageIops": number,
"StorageSize": number,
"StorageType": "string"
}
}
},
"DatabaseId": "string",
"EngineName": "string",
"Preferred": boolean,
"Settings": {
"InstanceSizingType": "string",
"WorkloadType": "string"
},
"Status": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
The unique pagination token returned for you to pass to a subsequent request. Fleet Advisor returns this token when the number of records in the response is greater than the
MaxRecordsvalue. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.Type: String
- Recommendations
-
The list of recommendations of target engines that Fleet Advisor created for the source database.
Type: Array of Recommendation objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedFault
-
AWS DMS was denied access to the endpoint. Check that the role is correctly configured.
HTTP Status Code: 400
- InvalidResourceStateFault
-
The resource is in a state that prevents it from being used for database migration.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
