MigrationHubStrategyRecommendations / Client / start_recommendation_report_generation

start_recommendation_report_generation#

MigrationHubStrategyRecommendations.Client.start_recommendation_report_generation(**kwargs)#

Starts generating a recommendation report.

See also: AWS API Documentation

Request Syntax

response = client.start_recommendation_report_generation(
    groupIdFilter=[
        {
            'name': 'ExternalId'|'ExternalSourceType',
            'value': 'string'
        },
    ],
    outputFormat='Excel'|'Json'
)
Parameters:

  • groupIdFilter (list) –

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

    • (dict) –

      The object containing information about distinct imports or groups for Strategy Recommendations.

      • name (string) –

        The key of the specific import group.

      • value (string) –

        The value of the specific import group.

  • outputFormat (string) – The output format for the recommendation report file. The default format is Microsoft Excel.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string'
}

Response Structure

  • (dict) –

    • id (string) –

      The ID of the recommendation report generation task.

Exceptions