Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartRecommendationReportGeneration

Note

AWS Migration Hub will no longer be open to new customers starting November 7, 2025. To continue using the service, sign up prior to November 7, 2025. For capabilities similar to AWS Migration Hub, explore AWS Migration Hub.

Starts generating a recommendation report.

Request Syntax


POST /start-recommendation-report-generation HTTP/1.1
Content-type: application/json

{
   "groupIdFilter": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ],
   "outputFormat": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

groupIdFilter

Groups the resources in the recommendation report with a unique name.

Type: Array of Group objects

Required: No

outputFormat

The output format for the recommendation report file. The default format is Microsoft Excel.

Type: String

Valid Values: Excel | Json

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "id": "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.

id

The ID of the recommendation report generation task.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 52.

Pattern: .*[0-9a-z-:]+.*

Errors

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

AccessDeniedException

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

HTTP Status Code: 403

ConflictException

Exception to indicate that there is an ongoing task when a new task is created. Return when once the existing tasks are complete.

HTTP Status Code: 409

InternalServerException

The server experienced an internal error. Try again.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request body isn't valid.

HTTP Status Code: 400